2022-01-15
▼ ▲ ids.projects.locations.list
Description: Lists information about the supported locations for this service.
Path: v1/{+name}/locations
Flat Path: v1/projects/{projectsId}/locations
Parameters:
name
Pattern: ^projects/[^/]+$
Required: Yes
Location: path
Type: string
Description: The resource that owns the locations collection, if applicable.
pageSize
Location: query
Type: integer
Format: int32
Description: The maximum number of results to return. If not set, the service selects a default.
filter
Type: string
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).
Location: query
pageToken
Type: string
Description: A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.
Location: query
Parameter Order: name
HTTP Method: GET
▼ ▲ ids.projects.locations.get
HTTP Method: GET
Parameter Order: name
Description: Gets information about a location.
Flat Path: v1/projects/{projectsId}/locations/{locationsId}
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1/{+name}
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+$
Location: path
Description: Resource name for the location.
Required: Yes
Type: string
▼ ▲ ids.projects.locations.operations.get
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
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.
HTTP Method: GET
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+/operations/[^/]+$
Required: Yes
Description: The name of the operation resource.
Type: string
Location: path
▼ ▲ ids.projects.locations.operations.cancel
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`.
HTTP Method: POST
Parameters:
name
Required: Yes
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/operations/[^/]+$
Description: The name of the operation resource to be cancelled.
Location: path
Parameter Order: name
Path: v1/{+name}:cancel
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel
▼ ▲ ids.projects.locations.operations.list
HTTP Method: GET
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/operations
Parameter Order: name
Parameters:
pageToken
Location: query
Description: The standard list page token.
Type: string
name
Required: Yes
Location: path
Description: The name of the operation's parent resource.
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+$
filter
Type: string
Description: The standard list filter.
Location: query
pageSize
Format: int32
Location: query
Type: integer
Description: The standard list page size.
Path: v1/{+name}/operations
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.
▼ ▲ ids.projects.locations.operations.delete
Parameter Order: name
Path: v1/{+name}
HTTP Method: DELETE
Parameters:
name
Required: Yes
Location: path
Type: string
Description: The name of the operation resource to be deleted.
Pattern: ^projects/[^/]+/locations/[^/]+/operations/[^/]+$
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}
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`.
▼ ▲ ids.projects.locations.endpoints.get
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}
Description: Gets details of a single Endpoint.
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: GET
Parameters:
name
Type: string
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$
Required: Yes
Description: Required. The name of the endpoint to retrieve. Format: projects/{project}/locations/{location}/endpoints/{endpoint}
Path: v1/{+name}
▼ ▲ ids.projects.locations.endpoints.list
Description: Lists Endpoints in a given project and location.
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/endpoints
Parameter Order: parent
Parameters:
parent
Pattern: ^projects/[^/]+/locations/[^/]+$
Description: Required. The parent, which owns this collection of endpoints.
Type: string
Location: path
Required: Yes
pageToken
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.
Type: string
Location: query
filter
Description: Optional. The filter expression, following the syntax outlined in https://google.aip.dev/160.
Location: query
Type: string
pageSize
Format: int32
Description: Optional. The maximum number of endpoints to return. The service may return fewer than this value.
Type: integer
Location: query
orderBy
Description: Optional. One or more fields to compare and use to sort the output. See https://google.aip.dev/132#ordering.
Location: query
Type: string
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1/{+parent}/endpoints
HTTP Method: GET
▼ ▲ ids.projects.locations.endpoints.testIamPermissions
HTTP Method: POST
Parameters:
resource
Description: REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.
Required: Yes
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$
Location: path
Parameter Order: resource
Path: v1/{+resource}:testIamPermissions
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}: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.
▼ ▲ ids.projects.locations.endpoints.delete
Description: Deletes a single Endpoint.
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}
Parameters:
requestId
Type: string
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
name
Description: Required. The name of the endpoint to delete.
Type: string
Required: Yes
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$
Path: v1/{+name}
HTTP Method: DELETE
Parameter Order: name
▼ ▲ ids.projects.locations.endpoints.setIamPolicy
HTTP Method: POST
Parameter Order: resource
Scopes: https://www.googleapis.com/auth/cloud-platform
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
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/[^/]+$
Required: Yes
Location: path
Type: string
Path: v1/{+resource}:setIamPolicy
▼ ▲ ids.projects.locations.endpoints.getIamPolicy
Parameters:
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
resource
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.
Required: Yes
Location: path
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}: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.
Path: v1/{+resource}:getIamPolicy
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: resource
HTTP Method: GET
▼ ▲ ids.projects.locations.endpoints.create
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Creates a new Endpoint in a given project and location.
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/endpoints
Parameters:
endpointId
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.
Location: query
requestId
Type: string
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).
Location: query
parent
Description: Required. The endpoint's parent.
Pattern: ^projects/[^/]+/locations/[^/]+$
Type: string
Location: path
Required: Yes
Parameter Order: parent
HTTP Method: POST
Path: v1/{+parent}/endpoints