2022-06-16
▼ ▲ networkservices.projects.locations.meshes.create
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1/{+parent}/meshes
Parameter Order: parent
Description: Creates a new Mesh in a given project and location.
HTTP Method: POST
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/meshes
Parameters:
parent
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+$
Description: Required. The parent resource of the Mesh. Must be in the format `projects/*/locations/global`.
Type: string
Location: path
meshId
Description: Required. Short name of the Mesh resource to be created.
Location: query
Type: string
▼ ▲ networkservices.projects.locations.meshes.patch
Description: Updates the parameters of a single Mesh.
Parameters:
updateMask
Type: string
Format: google-fieldmask
Location: query
Description: Optional. Field mask is used to specify the fields to be overwritten in the Mesh resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.
name
Description: Required. Name of the Mesh resource. It matches pattern `projects/*/locations/global/meshes/`.
Required: Yes
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/meshes/[^/]+$
Type: string
Parameter Order: name
Path: v1/{+name}
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/meshes/{meshesId}
HTTP Method: PATCH
▼ ▲ networkservices.projects.locations.meshes.delete
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+/meshes/[^/]+$
Description: Required. A name of the Mesh to delete. Must be in the format `projects/*/locations/global/meshes/*`.
Type: string
Location: path
Required: Yes
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/meshes/{meshesId}
HTTP Method: DELETE
Path: v1/{+name}
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
Description: Deletes a single Mesh.
▼ ▲ networkservices.projects.locations.meshes.getIamPolicy
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/meshes/{meshesId}:getIamPolicy
Description: Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Parameters:
resource
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/meshes/[^/]+$
Required: Yes
Type: string
Description: REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
options.requestedPolicyVersion
Format: int32
Description: Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
Type: integer
Location: query
Path: v1/{+resource}:getIamPolicy
Parameter Order: resource
HTTP Method: GET
▼ ▲ networkservices.projects.locations.meshes.setIamPolicy
Parameters:
resource
Pattern: ^projects/[^/]+/locations/[^/]+/meshes/[^/]+$
Required: Yes
Description: REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Type: string
Location: path
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/meshes/{meshesId}:setIamPolicy
Path: v1/{+resource}:setIamPolicy
Description: Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
Parameter Order: resource
HTTP Method: POST
▼ ▲ networkservices.projects.locations.meshes.list
Parameters:
pageToken
Location: query
Type: string
Description: The value returned by the last `ListMeshesResponse` Indicates that this is a continuation of a prior `ListMeshes` call, and that the system should return the next page of data.
pageSize
Description: Maximum number of Meshes to return per call.
Format: int32
Type: integer
Location: query
parent
Required: Yes
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+$
Type: string
Description: Required. The project and location from which the Meshes should be listed, specified in the format `projects/*/locations/global`.
Path: v1/{+parent}/meshes
Parameter Order: parent
HTTP Method: GET
Description: Lists Meshes in a given project and location.
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/meshes
▼ ▲ networkservices.projects.locations.meshes.get
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Gets details of a single Mesh.
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+/meshes/[^/]+$
Description: Required. A name of the Mesh to get. Must be in the format `projects/*/locations/global/meshes/*`.
Location: path
Required: Yes
Type: string
Parameter Order: name
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/meshes/{meshesId}
Path: v1/{+name}
HTTP Method: GET
▼ ▲ networkservices.projects.locations.meshes.testIamPermissions
Path: v1/{+resource}:testIamPermissions
Parameter Order: resource
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/meshes/{meshesId}:testIamPermissions
Parameters:
resource
Pattern: ^projects/[^/]+/locations/[^/]+/meshes/[^/]+$
Description: REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Type: string
Required: Yes
Location: path
HTTP Method: POST
Description: Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
▼ ▲ networkservices.projects.locations.tlsRoutes.patch
Path: v1/{+name}
Parameters:
updateMask
Type: string
Format: google-fieldmask
Description: Optional. Field mask is used to specify the fields to be overwritten in the TlsRoute resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.
Location: query
name
Description: Required. Name of the TlsRoute resource. It matches pattern `projects/*/locations/global/tlsRoutes/tls_route_name>`.
Location: path
Required: Yes
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/tlsRoutes/[^/]+$
Parameter Order: name
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/tlsRoutes/{tlsRoutesId}
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: PATCH
Description: Updates the parameters of a single TlsRoute.
▼ ▲ networkservices.projects.locations.tlsRoutes.create
HTTP Method: POST
Path: v1/{+parent}/tlsRoutes
Description: Creates a new TlsRoute in a given project and location.
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/tlsRoutes
Parameters:
tlsRouteId
Location: query
Type: string
Description: Required. Short name of the TlsRoute resource to be created. E.g. TODO(Add an example).
parent
Pattern: ^projects/[^/]+/locations/[^/]+$
Type: string
Description: Required. The parent resource of the TlsRoute. Must be in the format `projects/*/locations/global`.
Required: Yes
Location: path
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: parent
▼ ▲ networkservices.projects.locations.tlsRoutes.delete
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
name
Required: Yes
Location: path
Description: Required. A name of the TlsRoute to delete. Must be in the format `projects/*/locations/global/tlsRoutes/*`.
Pattern: ^projects/[^/]+/locations/[^/]+/tlsRoutes/[^/]+$
Type: string
Path: v1/{+name}
Description: Deletes a single TlsRoute.
Parameter Order: name
HTTP Method: DELETE
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/tlsRoutes/{tlsRoutesId}
▼ ▲ networkservices.projects.locations.tlsRoutes.get
Parameter Order: name
HTTP Method: GET
Description: Gets details of a single TlsRoute.
Path: v1/{+name}
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
name
Description: Required. A name of the TlsRoute to get. Must be in the format `projects/*/locations/global/tlsRoutes/*`.
Location: path
Required: Yes
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/tlsRoutes/[^/]+$
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/tlsRoutes/{tlsRoutesId}
▼ ▲ networkservices.projects.locations.tlsRoutes.list
Path: v1/{+parent}/tlsRoutes
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: parent
Description: Lists TlsRoute in a given project and location.
Parameters:
pageToken
Location: query
Description: The value returned by the last `ListTlsRoutesResponse` Indicates that this is a continuation of a prior `ListRouters` call, and that the system should return the next page of data.
Type: string
parent
Pattern: ^projects/[^/]+/locations/[^/]+$
Location: path
Type: string
Required: Yes
Description: Required. The project and location from which the TlsRoutes should be listed, specified in the format `projects/*/locations/global`.
pageSize
Format: int32
Type: integer
Location: query
Description: Maximum number of TlsRoutes to return per call.
HTTP Method: GET
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/tlsRoutes
▼ ▲ networkservices.projects.locations.httpRoutes.get
HTTP Method: GET
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/httpRoutes/{httpRoutesId}
Path: v1/{+name}
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
name
Description: Required. A name of the HttpRoute to get. Must be in the format `projects/*/locations/global/httpRoutes/*`.
Required: Yes
Location: path
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/httpRoutes/[^/]+$
Description: Gets details of a single HttpRoute.
▼ ▲ networkservices.projects.locations.httpRoutes.patch
Description: Updates the parameters of a single HttpRoute.
HTTP Method: PATCH
Path: v1/{+name}
Parameters:
name
Type: string
Required: Yes
Description: Required. Name of the HttpRoute resource. It matches pattern `projects/*/locations/global/httpRoutes/http_route_name>`.
Pattern: ^projects/[^/]+/locations/[^/]+/httpRoutes/[^/]+$
Location: path
updateMask
Type: string
Location: query
Description: Optional. Field mask is used to specify the fields to be overwritten in the HttpRoute resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.
Format: google-fieldmask
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/httpRoutes/{httpRoutesId}
Parameter Order: name
▼ ▲ networkservices.projects.locations.httpRoutes.delete
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
Parameters:
name
Description: Required. A name of the HttpRoute to delete. Must be in the format `projects/*/locations/global/httpRoutes/*`.
Location: path
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/httpRoutes/[^/]+$
Type: string
Path: v1/{+name}
Description: Deletes a single HttpRoute.
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/httpRoutes/{httpRoutesId}
HTTP Method: DELETE
▼ ▲ networkservices.projects.locations.httpRoutes.create
Path: v1/{+parent}/httpRoutes
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Creates a new HttpRoute in a given project and location.
Parameter Order: parent
HTTP Method: POST
Parameters:
httpRouteId
Location: query
Type: string
Description: Required. Short name of the HttpRoute resource to be created.
parent
Description: Required. The parent resource of the HttpRoute. Must be in the format `projects/*/locations/global`.
Location: path
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+$
Type: string
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/httpRoutes
▼ ▲ networkservices.projects.locations.httpRoutes.list
HTTP Method: GET
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/httpRoutes
Parameter Order: parent
Path: v1/{+parent}/httpRoutes
Parameters:
pageSize
Description: Maximum number of HttpRoutes to return per call.
Location: query
Type: integer
Format: int32
pageToken
Location: query
Description: The value returned by the last `ListHttpRoutesResponse` Indicates that this is a continuation of a prior `ListRouters` call, and that the system should return the next page of data.
Type: string
parent
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+$
Required: Yes
Type: string
Description: Required. The project and location from which the HttpRoutes should be listed, specified in the format `projects/*/locations/global`.
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Lists HttpRoute in a given project and location.
▼ ▲ networkservices.projects.locations.tcpRoutes.patch
Description: Updates the parameters of a single TcpRoute.
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/tcpRoutes/{tcpRoutesId}
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
HTTP Method: PATCH
Parameters:
name
Required: Yes
Location: path
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/tcpRoutes/[^/]+$
Description: Required. Name of the TcpRoute resource. It matches pattern `projects/*/locations/global/tcpRoutes/tcp_route_name>`.
updateMask
Location: query
Format: google-fieldmask
Type: string
Description: Optional. Field mask is used to specify the fields to be overwritten in the TcpRoute resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.
▼ ▲ networkservices.projects.locations.tcpRoutes.list
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/tcpRoutes
Parameter Order: parent
Parameters:
parent
Description: Required. The project and location from which the TcpRoutes should be listed, specified in the format `projects/*/locations/global`.
Location: path
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+$
Required: Yes
pageSize
Location: query
Description: Maximum number of TcpRoutes to return per call.
Type: integer
Format: int32
pageToken
Location: query
Description: The value returned by the last `ListTcpRoutesResponse` Indicates that this is a continuation of a prior `ListRouters` call, and that the system should return the next page of data.
Type: string
Description: Lists TcpRoute in a given project and location.
Path: v1/{+parent}/tcpRoutes
HTTP Method: GET
▼ ▲ networkservices.projects.locations.tcpRoutes.get
HTTP Method: GET
Path: v1/{+name}
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+/tcpRoutes/[^/]+$
Location: path
Description: Required. A name of the TcpRoute to get. Must be in the format `projects/*/locations/global/tcpRoutes/*`.
Required: Yes
Type: string
Parameter Order: name
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/tcpRoutes/{tcpRoutesId}
Description: Gets details of a single TcpRoute.
▼ ▲ networkservices.projects.locations.tcpRoutes.delete
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: DELETE
Description: Deletes a single TcpRoute.
Parameter Order: name
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/tcpRoutes/{tcpRoutesId}
Parameters:
name
Description: Required. A name of the TcpRoute to delete. Must be in the format `projects/*/locations/global/tcpRoutes/*`.
Location: path
Type: string
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/tcpRoutes/[^/]+$
▼ ▲ networkservices.projects.locations.tcpRoutes.create
Description: Creates a new TcpRoute in a given project and location.
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/tcpRoutes
Parameter Order: parent
HTTP Method: POST
Parameters:
parent
Required: Yes
Description: Required. The parent resource of the TcpRoute. Must be in the format `projects/*/locations/global`.
Type: string
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+$
tcpRouteId
Description: Required. Short name of the TcpRoute resource to be created. E.g. TODO(Add an example).
Type: string
Location: query
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1/{+parent}/tcpRoutes
▼ ▲ networkservices.projects.locations.grpcRoutes.list
Parameter Order: parent
Path: v1/{+parent}/grpcRoutes
Parameters:
pageToken
Location: query
Type: string
Description: The value returned by the last `ListGrpcRoutesResponse` Indicates that this is a continuation of a prior `ListGrpcRoutes` call, and that the system should return the next page of data.
pageSize
Type: integer
Location: query
Description: Maximum number of GrpcRoutes to return per call.
Format: int32
parent
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+$
Type: string
Description: Required. The project and location from which the GrpcRoutes should be listed, specified in the format `projects/*/locations/global`.
Location: path
HTTP Method: GET
Description: Lists GrpcRoutes in a given project and location.
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/grpcRoutes
▼ ▲ networkservices.projects.locations.grpcRoutes.get
Path: v1/{+name}
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+/grpcRoutes/[^/]+$
Description: Required. A name of the GrpcRoute to get. Must be in the format `projects/*/locations/global/grpcRoutes/*`.
Location: path
Type: string
Required: Yes
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: GET
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/grpcRoutes/{grpcRoutesId}
Description: Gets details of a single GrpcRoute.
▼ ▲ networkservices.projects.locations.grpcRoutes.delete
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/grpcRoutes/{grpcRoutesId}
HTTP Method: DELETE
Path: v1/{+name}
Parameters:
name
Description: Required. A name of the GrpcRoute to delete. Must be in the format `projects/*/locations/global/grpcRoutes/*`.
Required: Yes
Type: string
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/grpcRoutes/[^/]+$
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Deletes a single GrpcRoute.
▼ ▲ networkservices.projects.locations.grpcRoutes.patch
HTTP Method: PATCH
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/grpcRoutes/{grpcRoutesId}
Parameters:
updateMask
Location: query
Format: google-fieldmask
Type: string
Description: Optional. Field mask is used to specify the fields to be overwritten in the GrpcRoute resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.
name
Description: Required. Name of the GrpcRoute resource. It matches pattern `projects/*/locations/global/grpcRoutes/`
Location: path
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/grpcRoutes/[^/]+$
Type: string
Parameter Order: name
Description: Updates the parameters of a single GrpcRoute.
▼ ▲ networkservices.projects.locations.grpcRoutes.create
Description: Creates a new GrpcRoute in a given project and location.
Path: v1/{+parent}/grpcRoutes
Parameters:
grpcRouteId
Location: query
Type: string
Description: Required. Short name of the GrpcRoute resource to be created.
parent
Pattern: ^projects/[^/]+/locations/[^/]+$
Location: path
Type: string
Required: Yes
Description: Required. The parent resource of the GrpcRoute. Must be in the format `projects/*/locations/global`.
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/grpcRoutes
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: parent
HTTP Method: POST
▼ ▲ networkservices.projects.locations.gateways.get
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/gateways/{gatewaysId}
Parameters:
name
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/gateways/[^/]+$
Location: path
Description: Required. A name of the Gateway to get. Must be in the format `projects/*/locations/*/gateways/*`.
Required: Yes
Description: Gets details of a single Gateway.
Parameter Order: name
HTTP Method: GET
Path: v1/{+name}
▼ ▲ networkservices.projects.locations.gateways.list
Parameters:
pageToken
Type: string
Location: query
Description: The value returned by the last `ListGatewaysResponse` Indicates that this is a continuation of a prior `ListGateways` call, and that the system should return the next page of data.
parent
Required: Yes
Type: string
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+$
Description: Required. The project and location from which the Gateways should be listed, specified in the format `projects/*/locations/*`.
pageSize
Location: query
Type: integer
Format: int32
Description: Maximum number of Gateways to return per call.
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Lists Gateways in a given project and location.
Parameter Order: parent
Path: v1/{+parent}/gateways
HTTP Method: GET
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/gateways
▼ ▲ networkservices.projects.locations.gateways.create
Parameter Order: parent
HTTP Method: POST
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/gateways
Description: Creates a new Gateway in a given project and location.
Parameters:
gatewayId
Description: Required. Short name of the Gateway resource to be created.
Location: query
Type: string
parent
Location: path
Required: Yes
Description: Required. The parent resource of the Gateway. Must be in the format `projects/*/locations/*`.
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+$
Path: v1/{+parent}/gateways
▼ ▲ networkservices.projects.locations.gateways.setIamPolicy
Description: Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/gateways/{gatewaysId}:setIamPolicy
Parameters:
resource
Description: REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Type: string
Required: Yes
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/gateways/[^/]+$
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: resource
Path: v1/{+resource}:setIamPolicy
HTTP Method: POST
▼ ▲ networkservices.projects.locations.gateways.testIamPermissions
Description: Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/gateways/{gatewaysId}:testIamPermissions
Path: v1/{+resource}:testIamPermissions
Parameter Order: resource
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
resource
Pattern: ^projects/[^/]+/locations/[^/]+/gateways/[^/]+$
Description: REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Location: path
Required: Yes
Type: string
HTTP Method: POST
▼ ▲ networkservices.projects.locations.gateways.getIamPolicy
Description: Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Parameters:
resource
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/gateways/[^/]+$
Type: string
Location: path
Description: REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
options.requestedPolicyVersion
Location: query
Format: int32
Description: Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
Type: integer
HTTP Method: GET
Parameter Order: resource
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/gateways/{gatewaysId}:getIamPolicy
Path: v1/{+resource}:getIamPolicy
▼ ▲ networkservices.projects.locations.gateways.delete
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/gateways/{gatewaysId}
HTTP Method: DELETE
Parameter Order: name
Path: v1/{+name}
Description: Deletes a single Gateway.
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
name
Type: string
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/gateways/[^/]+$
Description: Required. A name of the Gateway to delete. Must be in the format `projects/*/locations/*/gateways/*`.
Location: path
▼ ▲ networkservices.projects.locations.gateways.patch
Description: Updates the parameters of a single Gateway.
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
Path: v1/{+name}
Parameters:
name
Description: Required. Name of the Gateway resource. It matches pattern `projects/*/locations/*/gateways/`.
Pattern: ^projects/[^/]+/locations/[^/]+/gateways/[^/]+$
Location: path
Required: Yes
Type: string
updateMask
Location: query
Description: Optional. Field mask is used to specify the fields to be overwritten in the Gateway resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.
Format: google-fieldmask
Type: string
HTTP Method: PATCH
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/gateways/{gatewaysId}
▼ ▲ networkservices.projects.locations.meshes.create
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1/{+parent}/meshes
Parameter Order: parent
Description: Creates a new Mesh in a given project and location.
HTTP Method: POST
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/meshes
Parameters:
parent
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+$
Description: Required. The parent resource of the Mesh. Must be in the format `projects/*/locations/global`.
Type: string
Location: path
meshId
Description: Required. Short name of the Mesh resource to be created.
Location: query
Type: string
▼ ▲ networkservices.projects.locations.meshes.patch
Description: Updates the parameters of a single Mesh.
Parameters:
updateMask
Type: string
Format: google-fieldmask
Location: query
Description: Optional. Field mask is used to specify the fields to be overwritten in the Mesh resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.
name
Description: Required. Name of the Mesh resource. It matches pattern `projects/*/locations/global/meshes/`.
Required: Yes
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/meshes/[^/]+$
Type: string
Parameter Order: name
Path: v1/{+name}
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/meshes/{meshesId}
HTTP Method: PATCH
▼ ▲ networkservices.projects.locations.meshes.delete
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+/meshes/[^/]+$
Description: Required. A name of the Mesh to delete. Must be in the format `projects/*/locations/global/meshes/*`.
Type: string
Location: path
Required: Yes
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/meshes/{meshesId}
HTTP Method: DELETE
Path: v1/{+name}
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
Description: Deletes a single Mesh.
▼ ▲ networkservices.projects.locations.meshes.getIamPolicy
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/meshes/{meshesId}:getIamPolicy
Description: Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Parameters:
resource
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/meshes/[^/]+$
Required: Yes
Type: string
Description: REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
options.requestedPolicyVersion
Format: int32
Description: Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
Type: integer
Location: query
Path: v1/{+resource}:getIamPolicy
Parameter Order: resource
HTTP Method: GET
▼ ▲ networkservices.projects.locations.meshes.setIamPolicy
Parameters:
resource
Pattern: ^projects/[^/]+/locations/[^/]+/meshes/[^/]+$
Required: Yes
Description: REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Type: string
Location: path
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/meshes/{meshesId}:setIamPolicy
Path: v1/{+resource}:setIamPolicy
Description: Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
Parameter Order: resource
HTTP Method: POST
▼ ▲ networkservices.projects.locations.meshes.list
Parameters:
pageToken
Location: query
Type: string
Description: The value returned by the last `ListMeshesResponse` Indicates that this is a continuation of a prior `ListMeshes` call, and that the system should return the next page of data.
pageSize
Description: Maximum number of Meshes to return per call.
Format: int32
Type: integer
Location: query
parent
Required: Yes
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+$
Type: string
Description: Required. The project and location from which the Meshes should be listed, specified in the format `projects/*/locations/global`.
Path: v1/{+parent}/meshes
Parameter Order: parent
HTTP Method: GET
Description: Lists Meshes in a given project and location.
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/meshes
▼ ▲ networkservices.projects.locations.meshes.get
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Gets details of a single Mesh.
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+/meshes/[^/]+$
Description: Required. A name of the Mesh to get. Must be in the format `projects/*/locations/global/meshes/*`.
Location: path
Required: Yes
Type: string
Parameter Order: name
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/meshes/{meshesId}
Path: v1/{+name}
HTTP Method: GET
▼ ▲ networkservices.projects.locations.meshes.testIamPermissions
Path: v1/{+resource}:testIamPermissions
Parameter Order: resource
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/meshes/{meshesId}:testIamPermissions
Parameters:
resource
Pattern: ^projects/[^/]+/locations/[^/]+/meshes/[^/]+$
Description: REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Type: string
Required: Yes
Location: path
HTTP Method: POST
Description: Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
▼ ▲ networkservices.projects.locations.tlsRoutes.patch
Path: v1/{+name}
Parameters:
updateMask
Type: string
Format: google-fieldmask
Description: Optional. Field mask is used to specify the fields to be overwritten in the TlsRoute resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.
Location: query
name
Description: Required. Name of the TlsRoute resource. It matches pattern `projects/*/locations/global/tlsRoutes/tls_route_name>`.
Location: path
Required: Yes
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/tlsRoutes/[^/]+$
Parameter Order: name
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/tlsRoutes/{tlsRoutesId}
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: PATCH
Description: Updates the parameters of a single TlsRoute.
▼ ▲ networkservices.projects.locations.tlsRoutes.create
HTTP Method: POST
Path: v1/{+parent}/tlsRoutes
Description: Creates a new TlsRoute in a given project and location.
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/tlsRoutes
Parameters:
tlsRouteId
Location: query
Type: string
Description: Required. Short name of the TlsRoute resource to be created. E.g. TODO(Add an example).
parent
Pattern: ^projects/[^/]+/locations/[^/]+$
Type: string
Description: Required. The parent resource of the TlsRoute. Must be in the format `projects/*/locations/global`.
Required: Yes
Location: path
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: parent
▼ ▲ networkservices.projects.locations.tlsRoutes.delete
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
name
Required: Yes
Location: path
Description: Required. A name of the TlsRoute to delete. Must be in the format `projects/*/locations/global/tlsRoutes/*`.
Pattern: ^projects/[^/]+/locations/[^/]+/tlsRoutes/[^/]+$
Type: string
Path: v1/{+name}
Description: Deletes a single TlsRoute.
Parameter Order: name
HTTP Method: DELETE
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/tlsRoutes/{tlsRoutesId}
▼ ▲ networkservices.projects.locations.tlsRoutes.get
Parameter Order: name
HTTP Method: GET
Description: Gets details of a single TlsRoute.
Path: v1/{+name}
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
name
Description: Required. A name of the TlsRoute to get. Must be in the format `projects/*/locations/global/tlsRoutes/*`.
Location: path
Required: Yes
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/tlsRoutes/[^/]+$
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/tlsRoutes/{tlsRoutesId}
▼ ▲ networkservices.projects.locations.tlsRoutes.list
Path: v1/{+parent}/tlsRoutes
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: parent
Description: Lists TlsRoute in a given project and location.
Parameters:
pageToken
Location: query
Description: The value returned by the last `ListTlsRoutesResponse` Indicates that this is a continuation of a prior `ListRouters` call, and that the system should return the next page of data.
Type: string
parent
Pattern: ^projects/[^/]+/locations/[^/]+$
Location: path
Type: string
Required: Yes
Description: Required. The project and location from which the TlsRoutes should be listed, specified in the format `projects/*/locations/global`.
pageSize
Format: int32
Type: integer
Location: query
Description: Maximum number of TlsRoutes to return per call.
HTTP Method: GET
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/tlsRoutes
▼ ▲ networkservices.projects.locations.httpRoutes.get
HTTP Method: GET
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/httpRoutes/{httpRoutesId}
Path: v1/{+name}
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
name
Description: Required. A name of the HttpRoute to get. Must be in the format `projects/*/locations/global/httpRoutes/*`.
Required: Yes
Location: path
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/httpRoutes/[^/]+$
Description: Gets details of a single HttpRoute.
▼ ▲ networkservices.projects.locations.httpRoutes.patch
Description: Updates the parameters of a single HttpRoute.
HTTP Method: PATCH
Path: v1/{+name}
Parameters:
name
Type: string
Required: Yes
Description: Required. Name of the HttpRoute resource. It matches pattern `projects/*/locations/global/httpRoutes/http_route_name>`.
Pattern: ^projects/[^/]+/locations/[^/]+/httpRoutes/[^/]+$
Location: path
updateMask
Type: string
Location: query
Description: Optional. Field mask is used to specify the fields to be overwritten in the HttpRoute resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.
Format: google-fieldmask
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/httpRoutes/{httpRoutesId}
Parameter Order: name
▼ ▲ networkservices.projects.locations.httpRoutes.delete
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
Parameters:
name
Description: Required. A name of the HttpRoute to delete. Must be in the format `projects/*/locations/global/httpRoutes/*`.
Location: path
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/httpRoutes/[^/]+$
Type: string
Path: v1/{+name}
Description: Deletes a single HttpRoute.
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/httpRoutes/{httpRoutesId}
HTTP Method: DELETE
▼ ▲ networkservices.projects.locations.httpRoutes.create
Path: v1/{+parent}/httpRoutes
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Creates a new HttpRoute in a given project and location.
Parameter Order: parent
HTTP Method: POST
Parameters:
httpRouteId
Location: query
Type: string
Description: Required. Short name of the HttpRoute resource to be created.
parent
Description: Required. The parent resource of the HttpRoute. Must be in the format `projects/*/locations/global`.
Location: path
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+$
Type: string
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/httpRoutes
▼ ▲ networkservices.projects.locations.httpRoutes.list
HTTP Method: GET
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/httpRoutes
Parameter Order: parent
Path: v1/{+parent}/httpRoutes
Parameters:
pageSize
Description: Maximum number of HttpRoutes to return per call.
Location: query
Type: integer
Format: int32
pageToken
Location: query
Description: The value returned by the last `ListHttpRoutesResponse` Indicates that this is a continuation of a prior `ListRouters` call, and that the system should return the next page of data.
Type: string
parent
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+$
Required: Yes
Type: string
Description: Required. The project and location from which the HttpRoutes should be listed, specified in the format `projects/*/locations/global`.
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Lists HttpRoute in a given project and location.
▼ ▲ networkservices.projects.locations.tcpRoutes.patch
Description: Updates the parameters of a single TcpRoute.
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/tcpRoutes/{tcpRoutesId}
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
HTTP Method: PATCH
Parameters:
name
Required: Yes
Location: path
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/tcpRoutes/[^/]+$
Description: Required. Name of the TcpRoute resource. It matches pattern `projects/*/locations/global/tcpRoutes/tcp_route_name>`.
updateMask
Location: query
Format: google-fieldmask
Type: string
Description: Optional. Field mask is used to specify the fields to be overwritten in the TcpRoute resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.
▼ ▲ networkservices.projects.locations.tcpRoutes.list
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/tcpRoutes
Parameter Order: parent
Parameters:
parent
Description: Required. The project and location from which the TcpRoutes should be listed, specified in the format `projects/*/locations/global`.
Location: path
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+$
Required: Yes
pageSize
Location: query
Description: Maximum number of TcpRoutes to return per call.
Type: integer
Format: int32
pageToken
Location: query
Description: The value returned by the last `ListTcpRoutesResponse` Indicates that this is a continuation of a prior `ListRouters` call, and that the system should return the next page of data.
Type: string
Description: Lists TcpRoute in a given project and location.
Path: v1/{+parent}/tcpRoutes
HTTP Method: GET
▼ ▲ networkservices.projects.locations.tcpRoutes.get
HTTP Method: GET
Path: v1/{+name}
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+/tcpRoutes/[^/]+$
Location: path
Description: Required. A name of the TcpRoute to get. Must be in the format `projects/*/locations/global/tcpRoutes/*`.
Required: Yes
Type: string
Parameter Order: name
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/tcpRoutes/{tcpRoutesId}
Description: Gets details of a single TcpRoute.
▼ ▲ networkservices.projects.locations.tcpRoutes.delete
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: DELETE
Description: Deletes a single TcpRoute.
Parameter Order: name
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/tcpRoutes/{tcpRoutesId}
Parameters:
name
Description: Required. A name of the TcpRoute to delete. Must be in the format `projects/*/locations/global/tcpRoutes/*`.
Location: path
Type: string
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/tcpRoutes/[^/]+$
▼ ▲ networkservices.projects.locations.tcpRoutes.create
Description: Creates a new TcpRoute in a given project and location.
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/tcpRoutes
Parameter Order: parent
HTTP Method: POST
Parameters:
parent
Required: Yes
Description: Required. The parent resource of the TcpRoute. Must be in the format `projects/*/locations/global`.
Type: string
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+$
tcpRouteId
Description: Required. Short name of the TcpRoute resource to be created. E.g. TODO(Add an example).
Type: string
Location: query
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1/{+parent}/tcpRoutes
▼ ▲ networkservices.projects.locations.grpcRoutes.list
Parameter Order: parent
Path: v1/{+parent}/grpcRoutes
Parameters:
pageToken
Location: query
Type: string
Description: The value returned by the last `ListGrpcRoutesResponse` Indicates that this is a continuation of a prior `ListGrpcRoutes` call, and that the system should return the next page of data.
pageSize
Type: integer
Location: query
Description: Maximum number of GrpcRoutes to return per call.
Format: int32
parent
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+$
Type: string
Description: Required. The project and location from which the GrpcRoutes should be listed, specified in the format `projects/*/locations/global`.
Location: path
HTTP Method: GET
Description: Lists GrpcRoutes in a given project and location.
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/grpcRoutes
▼ ▲ networkservices.projects.locations.grpcRoutes.get
Path: v1/{+name}
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+/grpcRoutes/[^/]+$
Description: Required. A name of the GrpcRoute to get. Must be in the format `projects/*/locations/global/grpcRoutes/*`.
Location: path
Type: string
Required: Yes
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: GET
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/grpcRoutes/{grpcRoutesId}
Description: Gets details of a single GrpcRoute.
▼ ▲ networkservices.projects.locations.grpcRoutes.delete
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/grpcRoutes/{grpcRoutesId}
HTTP Method: DELETE
Path: v1/{+name}
Parameters:
name
Description: Required. A name of the GrpcRoute to delete. Must be in the format `projects/*/locations/global/grpcRoutes/*`.
Required: Yes
Type: string
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/grpcRoutes/[^/]+$
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Deletes a single GrpcRoute.
▼ ▲ networkservices.projects.locations.grpcRoutes.patch
HTTP Method: PATCH
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/grpcRoutes/{grpcRoutesId}
Parameters:
updateMask
Location: query
Format: google-fieldmask
Type: string
Description: Optional. Field mask is used to specify the fields to be overwritten in the GrpcRoute resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.
name
Description: Required. Name of the GrpcRoute resource. It matches pattern `projects/*/locations/global/grpcRoutes/`
Location: path
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/grpcRoutes/[^/]+$
Type: string
Parameter Order: name
Description: Updates the parameters of a single GrpcRoute.
▼ ▲ networkservices.projects.locations.grpcRoutes.create
Description: Creates a new GrpcRoute in a given project and location.
Path: v1/{+parent}/grpcRoutes
Parameters:
grpcRouteId
Location: query
Type: string
Description: Required. Short name of the GrpcRoute resource to be created.
parent
Pattern: ^projects/[^/]+/locations/[^/]+$
Location: path
Type: string
Required: Yes
Description: Required. The parent resource of the GrpcRoute. Must be in the format `projects/*/locations/global`.
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/grpcRoutes
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: parent
HTTP Method: POST
▼ ▲ networkservices.projects.locations.gateways.get
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/gateways/{gatewaysId}
Parameters:
name
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/gateways/[^/]+$
Location: path
Description: Required. A name of the Gateway to get. Must be in the format `projects/*/locations/*/gateways/*`.
Required: Yes
Description: Gets details of a single Gateway.
Parameter Order: name
HTTP Method: GET
Path: v1/{+name}
▼ ▲ networkservices.projects.locations.gateways.list
Parameters:
pageToken
Type: string
Location: query
Description: The value returned by the last `ListGatewaysResponse` Indicates that this is a continuation of a prior `ListGateways` call, and that the system should return the next page of data.
parent
Required: Yes
Type: string
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+$
Description: Required. The project and location from which the Gateways should be listed, specified in the format `projects/*/locations/*`.
pageSize
Location: query
Type: integer
Format: int32
Description: Maximum number of Gateways to return per call.
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Lists Gateways in a given project and location.
Parameter Order: parent
Path: v1/{+parent}/gateways
HTTP Method: GET
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/gateways
▼ ▲ networkservices.projects.locations.gateways.create
Parameter Order: parent
HTTP Method: POST
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/gateways
Description: Creates a new Gateway in a given project and location.
Parameters:
gatewayId
Description: Required. Short name of the Gateway resource to be created.
Location: query
Type: string
parent
Location: path
Required: Yes
Description: Required. The parent resource of the Gateway. Must be in the format `projects/*/locations/*`.
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+$
Path: v1/{+parent}/gateways
▼ ▲ networkservices.projects.locations.gateways.setIamPolicy
Description: Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/gateways/{gatewaysId}:setIamPolicy
Parameters:
resource
Description: REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Type: string
Required: Yes
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/gateways/[^/]+$
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: resource
Path: v1/{+resource}:setIamPolicy
HTTP Method: POST
▼ ▲ networkservices.projects.locations.gateways.testIamPermissions
Description: Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/gateways/{gatewaysId}:testIamPermissions
Path: v1/{+resource}:testIamPermissions
Parameter Order: resource
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
resource
Pattern: ^projects/[^/]+/locations/[^/]+/gateways/[^/]+$
Description: REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Location: path
Required: Yes
Type: string
HTTP Method: POST
▼ ▲ networkservices.projects.locations.gateways.getIamPolicy
Description: Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Parameters:
resource
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/gateways/[^/]+$
Type: string
Location: path
Description: REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
options.requestedPolicyVersion
Location: query
Format: int32
Description: Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
Type: integer
HTTP Method: GET
Parameter Order: resource
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/gateways/{gatewaysId}:getIamPolicy
Path: v1/{+resource}:getIamPolicy
▼ ▲ networkservices.projects.locations.gateways.delete
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/gateways/{gatewaysId}
HTTP Method: DELETE
Parameter Order: name
Path: v1/{+name}
Description: Deletes a single Gateway.
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
name
Type: string
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/gateways/[^/]+$
Description: Required. A name of the Gateway to delete. Must be in the format `projects/*/locations/*/gateways/*`.
Location: path
▼ ▲ networkservices.projects.locations.gateways.patch
Description: Updates the parameters of a single Gateway.
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
Path: v1/{+name}
Parameters:
name
Description: Required. Name of the Gateway resource. It matches pattern `projects/*/locations/*/gateways/`.
Pattern: ^projects/[^/]+/locations/[^/]+/gateways/[^/]+$
Location: path
Required: Yes
Type: string
updateMask
Location: query
Description: Optional. Field mask is used to specify the fields to be overwritten in the Gateway resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.
Format: google-fieldmask
Type: string
HTTP Method: PATCH
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/gateways/{gatewaysId}