2022-01-14
▼ ▲ ids.projects.locations.endpoints.setIamPolicy
Parameter Order : resource
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}/endpoints/{endpointsId}:setIamPolicy
Path : v1/{+resource}:setIamPolicy
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
resource
Description : REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.
Pattern : ^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$
Location : path
Type : string
Required : Yes
HTTP Method : POST
▼ ▲ ids.projects.locations.endpoints.getIamPolicy
Path : v1/{+resource}: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.
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:getIamPolicy
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : GET
Parameter Order : resource
Parameters :
options.requestedPolicyVersion
Type : integer
Location : query
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).
Format : int32
resource
Location : path
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$
Type : string
Description : REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.
▼ ▲ ids.projects.locations.endpoints.get
Parameters :
name
Required : Yes
Type : string
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$
Description : Required. The name of the endpoint to retrieve. Format: projects/{project}/locations/{location}/endpoints/{endpoint}
HTTP Method : GET
Parameter Order : name
Description : Gets details of a single Endpoint.
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}
Path : v1/{+name}
▼ ▲ ids.projects.locations.endpoints.create
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/endpoints
Parameter Order : parent
HTTP Method : POST
Parameters :
endpointId
Location : query
Type : string
Description : Required. The endpoint identifier. This will be part of the endpoint's resource name. This value must start with a lowercase letter followed by up to 62 lowercase letters, numbers, or hyphens, and cannot end with a hyphen. Values that do not match this pattern will trigger an INVALID_ARGUMENT error.
parent
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+$
Required : Yes
Location : path
Description : Required. The endpoint's parent.
requestId
Location : query
Description : An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Type : string
Path : v1/{+parent}/endpoints
Description : Creates a new Endpoint in a given project and location.
▼ ▲ ids.projects.locations.endpoints.testIamPermissions
Path : v1/{+resource}: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}/endpoints/{endpointsId}:testIamPermissions
HTTP Method : POST
Parameters :
resource
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$
Location : path
Type : string
Description : REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.
Parameter Order : resource
▼ ▲ ids.projects.locations.endpoints.list
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : parent
Parameters :
parent
Required : Yes
Type : string
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+$
Description : Required. The parent, which owns this collection of endpoints.
pageToken
Location : query
Type : string
Description : Optional. A page token, received from a previous `ListEndpoints` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListEndpoints` must match the call that provided the page token.
orderBy
Location : query
Description : Optional. One or more fields to compare and use to sort the output. See https://google.aip.dev/132#ordering.
Type : string
pageSize
Description : Optional. The maximum number of endpoints to return. The service may return fewer than this value.
Type : integer
Location : query
Format : int32
filter
Type : string
Description : Optional. The filter expression, following the syntax outlined in https://google.aip.dev/160.
Location : query
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/endpoints
Path : v1/{+parent}/endpoints
Description : Lists Endpoints in a given project and location.
HTTP Method : GET
▼ ▲ ids.projects.locations.endpoints.delete
Path : v1/{+name}
Parameters :
requestId
Description : An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Location : query
Type : string
name
Type : string
Description : Required. The name of the endpoint to delete.
Pattern : ^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$
Location : path
Required : Yes
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}
Description : Deletes a single Endpoint.
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : DELETE
Parameter Order : name
▼ ▲ ids.projects.locations.operations.get
Parameters :
name
Description : The name of the operation resource.
Required : Yes
Location : path
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/operations/[^/]+$
HTTP Method : GET
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}
Path : v1/{+name}
Description : Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
▼ ▲ ids.projects.locations.operations.cancel
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel
Path : v1/{+name}:cancel
HTTP Method : POST
Parameter Order : name
Parameters :
name
Location : path
Required : Yes
Description : The name of the operation resource to be cancelled.
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/operations/[^/]+$
Description : Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.
▼ ▲ ids.projects.locations.operations.delete
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}
Parameters :
name
Location : path
Type : string
Required : Yes
Description : The name of the operation resource to be deleted.
Pattern : ^projects/[^/]+/locations/[^/]+/operations/[^/]+$
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1/{+name}
Description : Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
HTTP Method : DELETE
Parameter Order : name
▼ ▲ ids.projects.locations.operations.list
Description : Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/*/operations`. To override the binding, API services can add a binding such as `"/v1/{name=users/*}/operations"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.
Parameters :
filter
Type : string
Location : query
Description : The standard list filter.
pageSize
Description : The standard list page size.
Format : int32
Type : integer
Location : query
name
Pattern : ^projects/[^/]+/locations/[^/]+$
Type : string
Location : path
Required : Yes
Description : The name of the operation's parent resource.
pageToken
Type : string
Location : query
Description : The standard list page token.
Parameter Order : name
Path : v1/{+name}/operations
HTTP Method : GET
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/operations
▼ ▲ ids.projects.locations.get
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets information about a location.
Flat Path : v1/projects/{projectsId}/locations/{locationsId}
Path : v1/{+name}
HTTP Method : GET
Parameter Order : name
Parameters :
name
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+$
Type : string
Description : Resource name for the location.
Location : path
▼ ▲ ids.projects.locations.list
Path : v1/{+name}/locations
HTTP Method : GET
Flat Path : v1/projects/{projectsId}/locations
Parameter Order : name
Description : Lists information about the supported locations for this service.
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
name
Description : The resource that owns the locations collection, if applicable.
Type : string
Pattern : ^projects/[^/]+$
Required : Yes
Location : path
filter
Type : string
Location : query
Description : A filter to narrow down results to a preferred subset. The filtering language accepts strings like "displayName=tokyo", and is documented in more detail in [AIP-160](https://google.aip.dev/160).
pageSize
Type : integer
Description : The maximum number of results to return. If not set, the service selects a default.
Format : int32
Location : query
pageToken
Description : A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.
Type : string
Location : query
▼ ▲ ids.projects.locations.endpoints.setIamPolicy
Parameter Order : resource
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}/endpoints/{endpointsId}:setIamPolicy
Path : v1/{+resource}:setIamPolicy
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
resource
Description : REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.
Pattern : ^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$
Location : path
Type : string
Required : Yes
HTTP Method : POST
▼ ▲ ids.projects.locations.endpoints.getIamPolicy
Path : v1/{+resource}: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.
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:getIamPolicy
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : GET
Parameter Order : resource
Parameters :
options.requestedPolicyVersion
Type : integer
Location : query
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).
Format : int32
resource
Location : path
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$
Type : string
Description : REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.
▼ ▲ ids.projects.locations.endpoints.get
Parameters :
name
Required : Yes
Type : string
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$
Description : Required. The name of the endpoint to retrieve. Format: projects/{project}/locations/{location}/endpoints/{endpoint}
HTTP Method : GET
Parameter Order : name
Description : Gets details of a single Endpoint.
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}
Path : v1/{+name}
▼ ▲ ids.projects.locations.endpoints.create
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/endpoints
Parameter Order : parent
HTTP Method : POST
Parameters :
endpointId
Location : query
Type : string
Description : Required. The endpoint identifier. This will be part of the endpoint's resource name. This value must start with a lowercase letter followed by up to 62 lowercase letters, numbers, or hyphens, and cannot end with a hyphen. Values that do not match this pattern will trigger an INVALID_ARGUMENT error.
parent
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+$
Required : Yes
Location : path
Description : Required. The endpoint's parent.
requestId
Location : query
Description : An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Type : string
Path : v1/{+parent}/endpoints
Description : Creates a new Endpoint in a given project and location.
▼ ▲ ids.projects.locations.endpoints.testIamPermissions
Path : v1/{+resource}: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}/endpoints/{endpointsId}:testIamPermissions
HTTP Method : POST
Parameters :
resource
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$
Location : path
Type : string
Description : REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.
Parameter Order : resource
▼ ▲ ids.projects.locations.endpoints.list
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : parent
Parameters :
parent
Required : Yes
Type : string
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+$
Description : Required. The parent, which owns this collection of endpoints.
pageToken
Location : query
Type : string
Description : Optional. A page token, received from a previous `ListEndpoints` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListEndpoints` must match the call that provided the page token.
orderBy
Location : query
Description : Optional. One or more fields to compare and use to sort the output. See https://google.aip.dev/132#ordering.
Type : string
pageSize
Description : Optional. The maximum number of endpoints to return. The service may return fewer than this value.
Type : integer
Location : query
Format : int32
filter
Type : string
Description : Optional. The filter expression, following the syntax outlined in https://google.aip.dev/160.
Location : query
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/endpoints
Path : v1/{+parent}/endpoints
Description : Lists Endpoints in a given project and location.
HTTP Method : GET
▼ ▲ ids.projects.locations.endpoints.delete
Path : v1/{+name}
Parameters :
requestId
Description : An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Location : query
Type : string
name
Type : string
Description : Required. The name of the endpoint to delete.
Pattern : ^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$
Location : path
Required : Yes
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}
Description : Deletes a single Endpoint.
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : DELETE
Parameter Order : name
▼ ▲ ids.projects.locations.operations.get
Parameters :
name
Description : The name of the operation resource.
Required : Yes
Location : path
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/operations/[^/]+$
HTTP Method : GET
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}
Path : v1/{+name}
Description : Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
▼ ▲ ids.projects.locations.operations.cancel
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel
Path : v1/{+name}:cancel
HTTP Method : POST
Parameter Order : name
Parameters :
name
Location : path
Required : Yes
Description : The name of the operation resource to be cancelled.
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/operations/[^/]+$
Description : Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.
▼ ▲ ids.projects.locations.operations.delete
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}
Parameters :
name
Location : path
Type : string
Required : Yes
Description : The name of the operation resource to be deleted.
Pattern : ^projects/[^/]+/locations/[^/]+/operations/[^/]+$
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1/{+name}
Description : Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
HTTP Method : DELETE
Parameter Order : name
▼ ▲ ids.projects.locations.operations.list
Description : Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/*/operations`. To override the binding, API services can add a binding such as `"/v1/{name=users/*}/operations"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.
Parameters :
filter
Type : string
Location : query
Description : The standard list filter.
pageSize
Description : The standard list page size.
Format : int32
Type : integer
Location : query
name
Pattern : ^projects/[^/]+/locations/[^/]+$
Type : string
Location : path
Required : Yes
Description : The name of the operation's parent resource.
pageToken
Type : string
Location : query
Description : The standard list page token.
Parameter Order : name
Path : v1/{+name}/operations
HTTP Method : GET
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/operations
▼ ▲ ids.projects.locations.get
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets information about a location.
Flat Path : v1/projects/{projectsId}/locations/{locationsId}
Path : v1/{+name}
HTTP Method : GET
Parameter Order : name
Parameters :
name
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+$
Type : string
Description : Resource name for the location.
Location : path
▼ ▲ ids.projects.locations.list
Path : v1/{+name}/locations
HTTP Method : GET
Flat Path : v1/projects/{projectsId}/locations
Parameter Order : name
Description : Lists information about the supported locations for this service.
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
name
Description : The resource that owns the locations collection, if applicable.
Type : string
Pattern : ^projects/[^/]+$
Required : Yes
Location : path
filter
Type : string
Location : query
Description : A filter to narrow down results to a preferred subset. The filtering language accepts strings like "displayName=tokyo", and is documented in more detail in [AIP-160](https://google.aip.dev/160).
pageSize
Type : integer
Description : The maximum number of results to return. If not set, the service selects a default.
Format : int32
Location : query
pageToken
Description : A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.
Type : string
Location : query