Vertex AI API (aiplatform:v1)

Additions

Methods


• ▼ ▲ aiplatform.projects.locations.notebookRuntimeTemplates.delete

  Flat Path : v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}

  Path : v1/{+name}

  HTTP Method : DELETE

  Parameter Order : name

  Scopes : https://www.googleapis.com/auth/cloud-platform

  Parameters :

  name

  Required : Yes

  Description : Required. The name of the NotebookRuntimeTemplate resource to be deleted. Format: `projects/{project}/locations/{location}/notebookRuntimeTemplates/{notebook_runtime_template}`

  Pattern : ^projects/[^/]+/locations/[^/]+/notebookRuntimeTemplates/[^/]+$

  Location : path

  Type : string

  Description : Deletes a NotebookRuntimeTemplate.

• ▼ ▲ aiplatform.projects.locations.notebookRuntimeTemplates.get

  Description : Gets a NotebookRuntimeTemplate.

  Parameter Order : name

  HTTP Method : GET

  Scopes : https://www.googleapis.com/auth/cloud-platform

  Flat Path : v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}

  Path : v1/{+name}

  Parameters :

  name

  Location : path

  Required : Yes

  Pattern : ^projects/[^/]+/locations/[^/]+/notebookRuntimeTemplates/[^/]+$

  Description : Required. The name of the NotebookRuntimeTemplate resource. Format: `projects/{project}/locations/{location}/notebookRuntimeTemplates/{notebook_runtime_template}`

  Type : string

• ▼ ▲ aiplatform.projects.locations.notebookRuntimeTemplates.create

  Path : v1/{+parent}/notebookRuntimeTemplates

  Flat Path : v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates

  Parameter Order : parent

  Description : Creates a NotebookRuntimeTemplate.

  Parameters :

  notebookRuntimeTemplateId

  Description : Optional. User specified ID for the notebook runtime template.

  Type : string

  Location : query

  parent

  Description : Required. The resource name of the Location to create the NotebookRuntimeTemplate. Format: `projects/{project}/locations/{location}`

  Pattern : ^projects/[^/]+/locations/[^/]+$

  Type : string

  Required : Yes

  Location : path

  HTTP Method : POST

  Scopes : https://www.googleapis.com/auth/cloud-platform

• ▼ ▲ aiplatform.projects.locations.notebookRuntimeTemplates.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.

  Scopes : https://www.googleapis.com/auth/cloud-platform

  Parameter Order : resource

  HTTP Method : POST

  Parameters :

  resource

  Required : Yes

  Pattern : ^projects/[^/]+/locations/[^/]+/notebookRuntimeTemplates/[^/]+$

  Type : string

  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.

  Location : path

  Flat Path : v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}:setIamPolicy

  Path : v1/{+resource}:setIamPolicy

• ▼ ▲ aiplatform.projects.locations.notebookRuntimeTemplates.list

  Parameters :

  orderBy

  Location : query

  Type : string

  Description : Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `display_name` * `create_time` * `update_time` Example: `display_name, create_time desc`.

  pageSize

  Type : integer

  Description : Optional. The standard list page size.

  Location : query

  Format : int32

  pageToken

  Location : query

  Description : Optional. The standard list page token. Typically obtained via ListNotebookRuntimeTemplatesResponse.next_page_token of the previous NotebookService.ListNotebookRuntimeTemplates call.

  Type : string

  readMask

  Location : query

  Description : Optional. Mask specifying which fields to read.

  Format : google-fieldmask

  Type : string

  parent

  Location : path

  Description : Required. The resource name of the Location from which to list the NotebookRuntimeTemplates. Format: `projects/{project}/locations/{location}`

  Required : Yes

  Type : string

  Pattern : ^projects/[^/]+/locations/[^/]+$

  filter

  Type : string

  Location : query

  Description : Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `notebookRuntimeTemplate` supports = and !=. `notebookRuntimeTemplate` represents the NotebookRuntimeTemplate ID, i.e. the last segment of the NotebookRuntimeTemplate's resource name. * `display_name` supports = and != * `labels` supports general map functions that is: * `labels.key=value` - key:value equality * `labels.key:* or labels:key - key existence * A key including a space must be quoted. `labels."a key"`. Some examples: * `notebookRuntimeTemplate=notebookRuntimeTemplate123` * `displayName="myDisplayName"` * `labels.myKey="myValue"`

  Scopes : https://www.googleapis.com/auth/cloud-platform

  HTTP Method : GET

  Path : v1/{+parent}/notebookRuntimeTemplates

  Description : Lists NotebookRuntimeTemplates in a Location.

  Flat Path : v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates

  Parameter Order : parent

• ▼ ▲ aiplatform.projects.locations.notebookRuntimeTemplates.getIamPolicy

  HTTP Method : POST

  Description : Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

  Parameter Order : resource

  Parameters :

  resource

  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.

  Required : Yes

  Type : string

  Location : path

  Pattern : ^projects/[^/]+/locations/[^/]+/notebookRuntimeTemplates/[^/]+$

  options.requestedPolicyVersion

  Type : integer

  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

  Format : int32

  Path : v1/{+resource}:getIamPolicy

  Flat Path : v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}:getIamPolicy

  Scopes : https://www.googleapis.com/auth/cloud-platform

• ▼ ▲ aiplatform.projects.locations.notebookRuntimeTemplates.testIamPermissions

  Parameter Order : resource

  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.

  Scopes : https://www.googleapis.com/auth/cloud-platform

  Flat Path : v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}:testIamPermissions

  Parameters :

  permissions

  Type : string

  Description : The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).

  Repeated : Yes

  Location : query

  resource

  Required : Yes

  Pattern : ^projects/[^/]+/locations/[^/]+/notebookRuntimeTemplates/[^/]+$

  Location : path

  Type : string

  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.

  HTTP Method : POST

  Path : v1/{+resource}:testIamPermissions

• ▼ ▲ aiplatform.projects.locations.notebookRuntimes.get

  Description : Gets a NotebookRuntime.

  Scopes : https://www.googleapis.com/auth/cloud-platform

  Flat Path : v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}

  Parameters :

  name

  Description : Required. The name of the NotebookRuntime resource. Instead of checking whether the name is in valid NotebookRuntime resource name format, directly throw NotFound exception if there is no such NotebookRuntime in spanner.

  Location : path

  Pattern : ^projects/[^/]+/locations/[^/]+/notebookRuntimes/[^/]+$

  Type : string

  Required : Yes

  Parameter Order : name

  HTTP Method : GET

  Path : v1/{+name}

• ▼ ▲ aiplatform.projects.locations.notebookRuntimes.start

  Parameter Order : name

  Parameters :

  name

  Type : string

  Pattern : ^projects/[^/]+/locations/[^/]+/notebookRuntimes/[^/]+$

  Required : Yes

  Description : Required. The name of the NotebookRuntime resource to be started. Instead of checking whether the name is in valid NotebookRuntime resource name format, directly throw NotFound exception if there is no such NotebookRuntime in spanner.

  Location : path

  Flat Path : v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}:start

  HTTP Method : POST

  Scopes : https://www.googleapis.com/auth/cloud-platform

  Description : Starts a NotebookRuntime.

  Path : v1/{+name}:start

• ▼ ▲ aiplatform.projects.locations.notebookRuntimes.list

  Path : v1/{+parent}/notebookRuntimes

  Scopes : https://www.googleapis.com/auth/cloud-platform

  Flat Path : v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes

  Parameters :

  filter

  Description : Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `notebookRuntime` supports = and !=. `notebookRuntime` represents the NotebookRuntime ID, i.e. the last segment of the NotebookRuntime's resource name. * `displayName` supports = and != and regex. * `notebookRuntimeTemplate` supports = and !=. `notebookRuntimeTemplate` represents the NotebookRuntimeTemplate ID, i.e. the last segment of the NotebookRuntimeTemplate's resource name. * `healthState` supports = and !=. healthState enum: [HEALTHY, UNHEALTHY, HEALTH_STATE_UNSPECIFIED]. * `runtimeState` supports = and !=. runtimeState enum: [RUNTIME_STATE_UNSPECIFIED, RUNNING, BEING_STARTED, BEING_STOPPED, STOPPED, BEING_UPGRADED]. * `runtimeUser` supports = and !=. * API version is UI only: `uiState` supports = and !=. uiState enum: [UI_RESOURCE_STATE_UNSPECIFIED, UI_RESOURCE_STATE_BEING_CREATED, UI_RESOURCE_STATE_ACTIVE, UI_RESOURCE_STATE_BEING_DELETED, UI_RESOURCE_STATE_CREATION_FAILED]. Some examples: * `notebookRuntime="notebookRuntime123"` * `displayName="myDisplayName"` and `displayName=~"myDisplayNameRegex"` * `notebookRuntimeTemplate="notebookRuntimeTemplate321"` * `healthState=HEALTHY` * `runtimeState=RUNNING` * `runtimeUser="test@google.com"` * `uiState=UI_RESOURCE_STATE_BEING_DELETED`

  Type : string

  Location : query

  readMask

  Format : google-fieldmask

  Description : Optional. Mask specifying which fields to read.

  Type : string

  Location : query

  orderBy

  Description : Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `display_name` * `create_time` * `update_time` Example: `display_name, create_time desc`.

  Type : string

  Location : query

  parent

  Required : Yes

  Location : path

  Pattern : ^projects/[^/]+/locations/[^/]+$

  Description : Required. The resource name of the Location from which to list the NotebookRuntimes. Format: `projects/{project}/locations/{location}`

  Type : string

  pageToken

  Type : string

  Description : Optional. The standard list page token. Typically obtained via ListNotebookRuntimesResponse.next_page_token of the previous NotebookService.ListNotebookRuntimes call.

  Location : query

  pageSize

  Type : integer

  Description : Optional. The standard list page size.

  Format : int32

  Location : query

  Parameter Order : parent

  Description : Lists NotebookRuntimes in a Location.

  HTTP Method : GET

• ▼ ▲ aiplatform.projects.locations.notebookRuntimes.delete

  HTTP Method : DELETE

  Description : Deletes a NotebookRuntime.

  Path : v1/{+name}

  Parameters :

  name

  Location : path

  Description : Required. The name of the NotebookRuntime resource to be deleted. Instead of checking whether the name is in valid NotebookRuntime resource name format, directly throw NotFound exception if there is no such NotebookRuntime in spanner.

  Type : string

  Pattern : ^projects/[^/]+/locations/[^/]+/notebookRuntimes/[^/]+$

  Required : Yes

  Parameter Order : name

  Scopes : https://www.googleapis.com/auth/cloud-platform

  Flat Path : v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}

• ▼ ▲ aiplatform.projects.locations.notebookRuntimes.assign

  Parameters :

  parent

  Description : Required. The resource name of the Location to get the NotebookRuntime assignment. Format: `projects/{project}/locations/{location}`

  Pattern : ^projects/[^/]+/locations/[^/]+$

  Location : path

  Type : string

  Required : Yes

  Flat Path : v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes:assign

  Scopes : https://www.googleapis.com/auth/cloud-platform

  Path : v1/{+parent}/notebookRuntimes:assign

  Description : Assigns a NotebookRuntime to a user for a particular Notebook file. This method will either returns an existing assignment or generates a new one.

  HTTP Method : POST

  Parameter Order : parent