2023-03-18
▼ ▲ notebooks.projects.locations.get
Parameters:
name
Location: path
Type: string
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+$
Description: Resource name for the location.
Path: v2/{+name}
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: GET
Description: Gets information about a location.
Flat Path: v2/projects/{projectsId}/locations/{locationsId}
Parameter Order: name
▼ ▲ notebooks.projects.locations.list
Path: v2/{+name}/locations
Parameters:
pageSize
Description: The maximum number of results to return. If not set, the service selects a default.
Format: int32
Location: query
Type: integer
name
Description: The resource that owns the locations collection, if applicable.
Location: path
Required: Yes
Pattern: ^projects/[^/]+$
Type: string
filter
Location: query
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).
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
Description: Lists information about the supported locations for this service.
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: GET
Flat Path: v2/projects/{projectsId}/locations
▼ ▲ notebooks.projects.locations.instances.setIamPolicy
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: v2/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:setIamPolicy
Parameter Order: resource
Parameters:
resource
Location: path
Required: Yes
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/instances/[^/]+$
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.
Path: v2/{+resource}:setIamPolicy
HTTP Method: POST
▼ ▲ notebooks.projects.locations.instances.testIamPermissions
Flat Path: v2/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:testIamPermissions
Scopes: https://www.googleapis.com/auth/cloud-platform
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.
Parameters:
resource
Required: Yes
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/instances/[^/]+$
Location: path
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.
Path: v2/{+resource}:testIamPermissions
Parameter Order: resource
HTTP Method: POST
▼ ▲ notebooks.projects.locations.instances.getIamPolicy
Flat Path: v2/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:getIamPolicy
HTTP Method: GET
Description: Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: resource
Path: v2/{+resource}: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).
Location: query
Type: integer
resource
Required: Yes
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.
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/instances/[^/]+$
▼ ▲ notebooks.projects.locations.operations.cancel
Scopes: https://www.googleapis.com/auth/cloud-platform
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`.
Path: v2/{+name}:cancel
Flat Path: v2/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel
HTTP Method: POST
Parameter Order: name
Parameters:
name
Description: The name of the operation resource to be cancelled.
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/operations/[^/]+$
Required: Yes
Type: string
▼ ▲ notebooks.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`.
Parameter Order: name
Path: v2/{+name}/operations
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v2/projects/{projectsId}/locations/{locationsId}/operations
Parameters:
pageSize
Type: integer
Description: The standard list page size.
Format: int32
Location: query
filter
Description: The standard list filter.
Type: string
Location: query
name
Description: The name of the operation's parent resource.
Required: Yes
Type: string
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+$
pageToken
Description: The standard list page token.
Location: query
Type: string
HTTP Method: GET
▼ ▲ notebooks.projects.locations.operations.get
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
Flat Path: v2/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}
Path: v2/{+name}
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+/operations/[^/]+$
Type: string
Location: path
Description: The name of the operation resource.
Required: Yes
HTTP Method: GET
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.
▼ ▲ notebooks.projects.locations.operations.delete
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`.
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v2/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}
Path: v2/{+name}
Parameters:
name
Description: The name of the operation resource to be deleted.
Location: path
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/operations/[^/]+$
Type: string
HTTP Method: DELETE
Parameter Order: name