2023-08-08
▼ ▲ aiplatform.projects.locations.endpoints.countTokens
Path: v1beta1/{+endpoint}:countTokens
HTTP Method: POST
Parameter Order: endpoint
Description: Perform a token counting.
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:countTokens
Parameters:
endpoint
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$
Location: path
Type: string
Description: Required. The name of the Endpoint requested to perform token counting. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`
▼ ▲ aiplatform.projects.locations.publishers.models.countTokens
Parameter Order: endpoint
Parameters:
endpoint
Type: string
Description: Required. The name of the Endpoint requested to perform token counting. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/publishers/[^/]+/models/[^/]+$
Location: path
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:countTokens
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: POST
Description: Perform a token counting.
Path: v1beta1/{+endpoint}:countTokens
▼ ▲ aiplatform.publishers.models.get
Description: Gets a Model Garden publisher model.
Parameter Order: name
Path: v1beta1/{+name}
Parameters:
name
Type: string
Location: path
Required: Yes
Pattern: ^publishers/[^/]+/models/[^/]+$
Description: Required. The name of the PublisherModel resource. Format: `publishers/{publisher}/models/{publisher_model}`
view
Location: query
Type: string
Description: Optional. PublisherModel view specifying which fields to read.
Enum Descriptions:
Enum:
languageCode
Type: string
Location: query
Description: Optional. The IETF BCP-47 language code representing the language in which the publisher model's text information should be written in (see go/bcp47).
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1beta1/publishers/{publishersId}/models/{modelsId}
HTTP Method: GET
▼ ▲ aiplatform.projects.locations.featureOnlineStores.featureViews.operations.get
Parameter Order: name
Path: v1beta1/{+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.
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}/operations/{operationsId}
Parameters:
name
Description: The name of the operation resource.
Type: string
Location: path
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+/operations/[^/]+$
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: GET
▼ ▲ aiplatform.projects.locations.featureOnlineStores.featureViews.operations.list
Parameter Order: name
Description: Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
Parameters:
pageToken
Type: string
Location: query
Description: The standard list page token.
pageSize
Description: The standard list page size.
Type: integer
Location: query
Format: int32
filter
Type: string
Location: query
Description: The standard list filter.
name
Type: string
Location: path
Required: Yes
Description: The name of the operation's parent resource.
Pattern: ^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$
HTTP Method: GET
Path: v1beta1/{+name}/operations
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}/operations
▼ ▲ aiplatform.projects.locations.featureOnlineStores.featureViews.operations.delete
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}/operations/{operationsId}
Parameter Order: name
Path: v1beta1/{+name}
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: 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`.
Parameters:
name
Type: string
Location: path
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+/operations/[^/]+$
Description: The name of the operation resource to be deleted.
▼ ▲ aiplatform.projects.locations.featureOnlineStores.featureViews.operations.wait
Parameter Order: name
Parameters:
name
Location: path
Type: string
Required: Yes
Description: The name of the operation resource to wait on.
Pattern: ^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+/operations/[^/]+$
timeout
Location: query
Format: google-duration
Type: string
Description: The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
Path: v1beta1/{+name}:wait
Description: Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
HTTP Method: POST
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}/operations/{operationsId}:wait
▼ ▲ aiplatform.projects.locations.featureOnlineStores.operations.list
Description: Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
Path: v1beta1/{+name}/operations
HTTP Method: GET
Parameters:
name
Required: Yes
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+$
Location: path
Description: The name of the operation's parent resource.
pageToken
Description: The standard list page token.
Type: string
Location: query
pageSize
Type: integer
Format: int32
Location: query
Description: The standard list page size.
filter
Location: query
Type: string
Description: The standard list filter.
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/operations
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
▼ ▲ aiplatform.projects.locations.featureOnlineStores.operations.get
HTTP Method: GET
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/operations/{operationsId}
Parameter Order: name
Parameters:
name
Type: string
Location: path
Description: The name of the operation resource.
Pattern: ^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/operations/[^/]+$
Required: Yes
Path: v1beta1/{+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.
▼ ▲ aiplatform.projects.locations.featureOnlineStores.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`.
HTTP Method: DELETE
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/operations/{operationsId}
Parameter Order: name
Path: v1beta1/{+name}
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
name
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/operations/[^/]+$
Description: The name of the operation resource to be deleted.
Required: Yes
Location: path
▼ ▲ aiplatform.projects.locations.featureOnlineStores.operations.wait
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/operations/{operationsId}:wait
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
Path: v1beta1/{+name}:wait
HTTP Method: POST
Description: Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
Parameters:
name
Description: The name of the operation resource to wait on.
Pattern: ^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/operations/[^/]+$
Type: string
Location: path
Required: Yes
timeout
Format: google-duration
Type: string
Description: The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
Location: query
▼ ▲ aiplatform.projects.locations.modelMonitors.operations.wait
Path: v1beta1/{+name}:wait
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/modelMonitors/{modelMonitorsId}/operations/{operationsId}:wait
Description: Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
HTTP Method: POST
Parameters:
timeout
Format: google-duration
Type: string
Description: The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
Location: query
name
Type: string
Location: path
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/modelMonitors/[^/]+/operations/[^/]+$
Description: The name of the operation resource to wait on.
▼ ▲ aiplatform.projects.locations.modelMonitors.operations.get
Parameters:
name
Required: Yes
Type: string
Location: path
Description: The name of the operation resource.
Pattern: ^projects/[^/]+/locations/[^/]+/modelMonitors/[^/]+/operations/[^/]+$
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
Path: v1beta1/{+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.
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/modelMonitors/{modelMonitorsId}/operations/{operationsId}
HTTP Method: GET
▼ ▲ aiplatform.projects.locations.modelMonitors.operations.list
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/modelMonitors/{modelMonitorsId}/operations
Scopes: https://www.googleapis.com/auth/cloud-platform
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
Parameters:
pageToken
Location: query
Description: The standard list page token.
Type: string
filter
Location: query
Type: string
Description: The standard list filter.
name
Required: Yes
Description: The name of the operation's parent resource.
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/modelMonitors/[^/]+$
Type: string
pageSize
Description: The standard list page size.
Location: query
Format: int32
Type: integer
HTTP Method: GET
Path: v1beta1/{+name}/operations
▼ ▲ aiplatform.projects.locations.modelMonitors.operations.cancel
Parameter Order: name
Path: v1beta1/{+name}:cancel
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/modelMonitors/{modelMonitorsId}/operations/{operationsId}: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
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+/modelMonitors/[^/]+/operations/[^/]+$
Description: The name of the operation resource to be cancelled.
Type: string
Location: path
Required: Yes
▼ ▲ aiplatform.projects.locations.modelMonitors.operations.delete
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/modelMonitors/{modelMonitorsId}/operations/{operationsId}
Parameters:
name
Required: Yes
Type: string
Description: The name of the operation resource to be deleted.
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/modelMonitors/[^/]+/operations/[^/]+$
Parameter Order: name
Path: v1beta1/{+name}
Scopes: https://www.googleapis.com/auth/cloud-platform
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
▼ ▲ aiplatform.projects.locations.extensionControllers.operations.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.
Parameter Order: name
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/extensionControllers/{extensionControllersId}/operations/{operationsId}
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+/extensionControllers/[^/]+/operations/[^/]+$
Required: Yes
Location: path
Description: The name of the operation resource.
Type: string
HTTP Method: GET
Path: v1beta1/{+name}
▼ ▲ aiplatform.projects.locations.extensionControllers.operations.list
HTTP Method: GET
Path: v1beta1/{+name}/operations
Description: Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/extensionControllers/{extensionControllersId}/operations
Parameters:
pageSize
Format: int32
Location: query
Description: The standard list page size.
Type: integer
pageToken
Description: The standard list page token.
Type: string
Location: query
name
Description: The name of the operation's parent resource.
Required: Yes
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/extensionControllers/[^/]+$
Location: path
filter
Location: query
Description: The standard list filter.
Type: string
▼ ▲ aiplatform.projects.locations.extensionControllers.operations.wait
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/extensionControllers/{extensionControllersId}/operations/{operationsId}:wait
Description: Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
HTTP Method: POST
Parameter Order: name
Path: v1beta1/{+name}:wait
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+/extensionControllers/[^/]+/operations/[^/]+$
Type: string
Required: Yes
Location: path
Description: The name of the operation resource to wait on.
timeout
Description: The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
Format: google-duration
Location: query
Type: string
▼ ▲ aiplatform.projects.locations.extensionControllers.operations.cancel
Parameter Order: name
HTTP Method: POST
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+/extensionControllers/[^/]+/operations/[^/]+$
Description: The name of the operation resource to be cancelled.
Location: path
Type: string
Required: Yes
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`.
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/extensionControllers/{extensionControllersId}/operations/{operationsId}:cancel
Path: v1beta1/{+name}:cancel
▼ ▲ aiplatform.projects.locations.extensionControllers.operations.delete
Parameters:
name
Description: The name of the operation resource to be deleted.
Pattern: ^projects/[^/]+/locations/[^/]+/extensionControllers/[^/]+/operations/[^/]+$
Location: path
Type: string
Required: Yes
HTTP Method: DELETE
Parameter Order: 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`.
Path: v1beta1/{+name}
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/extensionControllers/{extensionControllersId}/operations/{operationsId}
▼ ▲ aiplatform.projects.locations.customJobs.operations.cancel
Parameters:
name
Type: string
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/customJobs/[^/]+/operations/[^/]+$
Description: The name of the operation resource to be cancelled.
Required: Yes
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/customJobs/{customJobsId}/operations/{operationsId}:cancel
Path: v1beta1/{+name}:cancel
HTTP Method: POST
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`.
▼ ▲ aiplatform.projects.locations.customJobs.operations.get
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/customJobs/{customJobsId}/operations/{operationsId}
Parameters:
name
Location: path
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/customJobs/[^/]+/operations/[^/]+$
Description: The name of the operation resource.
Type: string
Path: v1beta1/{+name}
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
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.
▼ ▲ aiplatform.projects.locations.customJobs.operations.wait
Parameters:
name
Description: The name of the operation resource to wait on.
Required: Yes
Type: string
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/customJobs/[^/]+/operations/[^/]+$
timeout
Description: The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
Format: google-duration
Type: string
Location: query
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/customJobs/{customJobsId}/operations/{operationsId}:wait
Parameter Order: name
Description: Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
Path: v1beta1/{+name}:wait
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: POST
▼ ▲ aiplatform.projects.locations.customJobs.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`.
Parameters:
name
Type: string
Location: path
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/customJobs/[^/]+/operations/[^/]+$
Description: The name of the operation resource to be deleted.
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1beta1/{+name}
Parameter Order: name
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/customJobs/{customJobsId}/operations/{operationsId}
HTTP Method: DELETE
▼ ▲ aiplatform.projects.locations.customJobs.operations.list
HTTP Method: GET
Path: v1beta1/{+name}/operations
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/customJobs/{customJobsId}/operations
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
pageToken
Description: The standard list page token.
Type: string
Location: query
pageSize
Description: The standard list page size.
Type: integer
Location: query
Format: int32
name
Description: The name of the operation's parent resource.
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/customJobs/[^/]+$
Type: string
Location: path
filter
Type: string
Description: The standard list filter.
Location: query
Parameter Order: name
Description: Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
▼ ▲ aiplatform.projects.locations.customJobs.get
Path: v1beta1/{+name}
HTTP Method: GET
Parameters:
name
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/customJobs/[^/]+$
Location: path
Description: Required. The name of the CustomJob resource. Format: `projects/{project}/locations/{location}/customJobs/{custom_job}`
Required: Yes
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
Description: Gets a CustomJob.
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/customJobs/{customJobsId}
▼ ▲ aiplatform.projects.locations.customJobs.list
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/customJobs
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Lists CustomJobs in a Location.
Parameters:
filter
Description: The standard list filter. Supported fields: * `display_name` supports `=`, `!=` comparisons, and `:` wildcard. * `state` supports `=`, `!=` comparisons. * `create_time` supports `=`, `!=`,`<`, `<=`,`>`, `>=` comparisons. `create_time` must be in RFC 3339 format. * `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* - key existence Some examples of using the filter are: * `state="JOB_STATE_SUCCEEDED" AND display_name:"my_job_*"` * `state!="JOB_STATE_FAILED" OR display_name="my_job"` * `NOT display_name="my_job"` * `create_time>"2021-05-18T00:00:00Z"` * `labels.keyA=valueA` * `labels.keyB:*`
Type: string
Location: query
pageSize
Format: int32
Location: query
Description: The standard list page size.
Type: integer
readMask
Type: string
Description: Mask specifying which fields to read.
Format: google-fieldmask
Location: query
parent
Pattern: ^projects/[^/]+/locations/[^/]+$
Required: Yes
Type: string
Location: path
Description: Required. The resource name of the Location to list the CustomJobs from. Format: `projects/{project}/locations/{location}`
pageToken
Type: string
Location: query
Description: The standard list page token. Typically obtained via ListCustomJobsResponse.next_page_token of the previous JobService.ListCustomJobs call.
HTTP Method: GET
Path: v1beta1/{+parent}/customJobs
Parameter Order: parent
▼ ▲ aiplatform.projects.locations.customJobs.create
Path: v1beta1/{+parent}/customJobs
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/customJobs
Parameters:
parent
Type: string
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+$
Required: Yes
Description: Required. The resource name of the Location to create the CustomJob in. Format: `projects/{project}/locations/{location}`
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: POST
Description: Creates a CustomJob. A created CustomJob right away will be attempted to be run.
Parameter Order: parent
▼ ▲ aiplatform.projects.locations.customJobs.delete
Parameter Order: name
Parameters:
name
Required: Yes
Description: Required. The name of the CustomJob resource to be deleted. Format: `projects/{project}/locations/{location}/customJobs/{custom_job}`
Type: string
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/customJobs/[^/]+$
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1beta1/{+name}
Description: Deletes a CustomJob.
HTTP Method: DELETE
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/customJobs/{customJobsId}
▼ ▲ aiplatform.projects.locations.customJobs.cancel
Parameter Order: name
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/customJobs/{customJobsId}:cancel
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1beta1/{+name}:cancel
Description: Cancels a CustomJob. Starts asynchronous cancellation on the CustomJob. The server makes a best effort to cancel the job, but success is not guaranteed. Clients can use JobService.GetCustomJob or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On successful cancellation, the CustomJob is not deleted; instead it becomes a job with a CustomJob.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`, and CustomJob.state is set to `CANCELLED`.
Parameters:
name
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/customJobs/[^/]+$
Required: Yes
Location: path
Description: Required. The name of the CustomJob to cancel. Format: `projects/{project}/locations/{location}/customJobs/{custom_job}`
HTTP Method: POST
▼ ▲ aiplatform.projects.locations.pipelineJobs.operations.cancel
Parameters:
name
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/pipelineJobs/[^/]+/operations/[^/]+$
Description: The name of the operation resource to be cancelled.
Required: Yes
Type: string
Path: v1beta1/{+name}: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`.
Parameter Order: name
HTTP Method: POST
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/pipelineJobs/{pipelineJobsId}/operations/{operationsId}:cancel
▼ ▲ aiplatform.projects.locations.pipelineJobs.operations.get
Parameters:
name
Required: Yes
Description: The name of the operation resource.
Pattern: ^projects/[^/]+/locations/[^/]+/pipelineJobs/[^/]+/operations/[^/]+$
Type: string
Location: path
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/pipelineJobs/{pipelineJobsId}/operations/{operationsId}
HTTP Method: GET
Parameter Order: 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.
Path: v1beta1/{+name}
▼ ▲ aiplatform.projects.locations.pipelineJobs.operations.list
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/pipelineJobs/{pipelineJobsId}/operations
HTTP Method: GET
Path: v1beta1/{+name}/operations
Description: Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
Parameters:
name
Required: Yes
Type: string
Location: path
Description: The name of the operation's parent resource.
Pattern: ^projects/[^/]+/locations/[^/]+/pipelineJobs/[^/]+$
pageToken
Type: string
Location: query
Description: The standard list page token.
filter
Type: string
Description: The standard list filter.
Location: query
pageSize
Location: query
Type: integer
Description: The standard list page size.
Format: int32
▼ ▲ aiplatform.projects.locations.pipelineJobs.operations.delete
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/pipelineJobs/{pipelineJobsId}/operations/{operationsId}
Parameter Order: name
HTTP Method: DELETE
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
name
Type: string
Description: The name of the operation resource to be deleted.
Pattern: ^projects/[^/]+/locations/[^/]+/pipelineJobs/[^/]+/operations/[^/]+$
Location: path
Required: Yes
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`.
Path: v1beta1/{+name}
▼ ▲ aiplatform.projects.locations.pipelineJobs.operations.wait
Parameters:
name
Required: Yes
Type: string
Description: The name of the operation resource to wait on.
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/pipelineJobs/[^/]+/operations/[^/]+$
timeout
Description: The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
Type: string
Format: google-duration
Location: query
Path: v1beta1/{+name}:wait
HTTP Method: POST
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/pipelineJobs/{pipelineJobsId}/operations/{operationsId}:wait
Description: Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
Parameter Order: name
▼ ▲ aiplatform.projects.locations.pipelineJobs.get
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1beta1/{+name}
Parameters:
name
Description: Required. The name of the PipelineJob resource. Format: `projects/{project}/locations/{location}/pipelineJobs/{pipeline_job}`
Type: string
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/pipelineJobs/[^/]+$
Location: path
Description: Gets a PipelineJob.
HTTP Method: GET
Parameter Order: name
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/pipelineJobs/{pipelineJobsId}
▼ ▲ aiplatform.projects.locations.pipelineJobs.create
Parameters:
parent
Required: Yes
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+$
Location: path
Description: Required. The resource name of the Location to create the PipelineJob in. Format: `projects/{project}/locations/{location}`
pipelineJobId
Description: The ID to use for the PipelineJob, which will become the final component of the PipelineJob name. If not provided, an ID will be automatically generated. This value should be less than 128 characters, and valid characters are /a-z-/.
Location: query
Type: string
HTTP Method: POST
Description: Creates a PipelineJob. A PipelineJob will run immediately when created.
Parameter Order: parent
Path: v1beta1/{+parent}/pipelineJobs
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/pipelineJobs
▼ ▲ aiplatform.projects.locations.pipelineJobs.list
Parameter Order: parent
Path: v1beta1/{+parent}/pipelineJobs
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: GET
Description: Lists PipelineJobs in a Location.
Parameters:
orderBy
Location: query
Description: A comma-separated list of fields to order by. The default sort order is in ascending order. Use "desc" after a field name for descending. You can have multiple order_by fields provided e.g. "create_time desc, end_time", "end_time, start_time, update_time" For example, using "create_time desc, end_time" will order results by create time in descending order, and if there are multiple jobs having the same create time, order them by the end time in ascending order. if order_by is not specified, it will order by default order is create time in descending order. Supported fields: * `create_time` * `update_time` * `end_time` * `start_time`
Type: string
readMask
Type: string
Description: Mask specifying which fields to read.
Location: query
Format: google-fieldmask
filter
Type: string
Location: query
Description: Lists the PipelineJobs that match the filter expression. The following fields are supported: * `pipeline_name`: Supports `=` and `!=` comparisons. * `display_name`: Supports `=`, `!=` comparisons, and `:` wildcard. * `pipeline_job_user_id`: Supports `=`, `!=` comparisons, and `:` wildcard. for example, can check if pipeline's display_name contains *step* by doing display_name:\"*step*\" * `state`: Supports `=` and `!=` comparisons. * `create_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be in RFC 3339 format. * `update_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be in RFC 3339 format. * `end_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be in RFC 3339 format. * `labels`: Supports key-value equality and key presence. * `template_uri`: Supports `=`, `!=` comparisons, and `:` wildcard. * `template_metadata.version`: Supports `=`, `!=` comparisons, and `:` wildcard. Filter expressions can be combined together using logical operators (`AND` & `OR`). For example: `pipeline_name="test" AND create_time>"2020-05-18T13:30:00Z"`. The syntax to define filter expression is based on https://google.aip.dev/160. Examples: * `create_time>"2021-05-18T00:00:00Z" OR update_time>"2020-05-18T00:00:00Z"` PipelineJobs created or updated after 2020-05-18 00:00:00 UTC. * `labels.env = "prod"` PipelineJobs with label "env" set to "prod".
parent
Location: path
Type: string
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+$
Description: Required. The resource name of the Location to list the PipelineJobs from. Format: `projects/{project}/locations/{location}`
pageToken
Location: query
Description: The standard list page token. Typically obtained via ListPipelineJobsResponse.next_page_token of the previous PipelineService.ListPipelineJobs call.
Type: string
pageSize
Description: The standard list page size.
Format: int32
Type: integer
Location: query
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/pipelineJobs
▼ ▲ aiplatform.projects.locations.pipelineJobs.delete
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+/pipelineJobs/[^/]+$
Description: Required. The name of the PipelineJob resource to be deleted. Format: `projects/{project}/locations/{location}/pipelineJobs/{pipeline_job}`
Type: string
Location: path
Required: Yes
Description: Deletes a PipelineJob.
Path: v1beta1/{+name}
Parameter Order: name
HTTP Method: DELETE
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/pipelineJobs/{pipelineJobsId}
▼ ▲ aiplatform.projects.locations.pipelineJobs.cancel
Path: v1beta1/{+name}:cancel
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/pipelineJobs/{pipelineJobsId}:cancel
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: POST
Description: Cancels a PipelineJob. Starts asynchronous cancellation on the PipelineJob. The server makes a best effort to cancel the pipeline, but success is not guaranteed. Clients can use PipelineService.GetPipelineJob or other methods to check whether the cancellation succeeded or whether the pipeline completed despite cancellation. On successful cancellation, the PipelineJob is not deleted; instead it becomes a pipeline with a PipelineJob.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`, and PipelineJob.state is set to `CANCELLED`.
Parameter Order: name
Parameters:
name
Type: string
Location: path
Required: Yes
Description: Required. The name of the PipelineJob to cancel. Format: `projects/{project}/locations/{location}/pipelineJobs/{pipeline_job}`
Pattern: ^projects/[^/]+/locations/[^/]+/pipelineJobs/[^/]+$
▼ ▲ aiplatform.projects.locations.solvers.operations.list
Parameters:
name
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/solvers/[^/]+$
Description: The name of the operation's parent resource.
Required: Yes
Type: string
pageToken
Type: string
Location: query
Description: The standard list page token.
filter
Location: query
Description: The standard list filter.
Type: string
pageSize
Format: int32
Description: The standard list page size.
Location: query
Type: integer
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
HTTP Method: GET
Path: v1beta1/{+name}/operations
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/solvers/{solversId}/operations
Parameter Order: name
▼ ▲ aiplatform.projects.locations.solvers.operations.get
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/solvers/{solversId}/operations/{operationsId}
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
Path: v1beta1/{+name}
Parameter Order: name
Parameters:
name
Description: The name of the operation resource.
Required: Yes
Type: string
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/solvers/[^/]+/operations/[^/]+$
▼ ▲ aiplatform.projects.locations.solvers.operations.delete
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/solvers/{solversId}/operations/{operationsId}
HTTP Method: DELETE
Path: v1beta1/{+name}
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
name
Required: Yes
Description: The name of the operation resource to be deleted.
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/solvers/[^/]+/operations/[^/]+$
Type: string
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`.
Parameter Order: name
▼ ▲ aiplatform.projects.locations.batchPredictionJobs.delete
Parameters:
name
Description: Required. The name of the BatchPredictionJob resource to be deleted. Format: `projects/{project}/locations/{location}/batchPredictionJobs/{batch_prediction_job}`
Pattern: ^projects/[^/]+/locations/[^/]+/batchPredictionJobs/[^/]+$
Location: path
Type: string
Required: Yes
Parameter Order: name
Path: v1beta1/{+name}
Description: Deletes a BatchPredictionJob. Can only be called on jobs that already finished.
HTTP Method: DELETE
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/batchPredictionJobs/{batchPredictionJobsId}
▼ ▲ aiplatform.projects.locations.batchPredictionJobs.get
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/batchPredictionJobs/{batchPredictionJobsId}
HTTP Method: GET
Path: v1beta1/{+name}
Parameters:
name
Type: string
Description: Required. The name of the BatchPredictionJob resource. Format: `projects/{project}/locations/{location}/batchPredictionJobs/{batch_prediction_job}`
Required: Yes
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/batchPredictionJobs/[^/]+$
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
Description: Gets a BatchPredictionJob
▼ ▲ aiplatform.projects.locations.batchPredictionJobs.list
HTTP Method: GET
Parameters:
pageSize
Type: integer
Description: The standard list page size.
Format: int32
Location: query
pageToken
Location: query
Description: The standard list page token. Typically obtained via ListBatchPredictionJobsResponse.next_page_token of the previous JobService.ListBatchPredictionJobs call.
Type: string
readMask
Location: query
Format: google-fieldmask
Type: string
Description: Mask specifying which fields to read.
filter
Type: string
Location: query
Description: The standard list filter. Supported fields: * `display_name` supports `=`, `!=` comparisons, and `:` wildcard. * `model_display_name` supports `=`, `!=` comparisons. * `state` supports `=`, `!=` comparisons. * `create_time` supports `=`, `!=`,`<`, `<=`,`>`, `>=` comparisons. `create_time` must be in RFC 3339 format. * `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* - key existence Some examples of using the filter are: * `state="JOB_STATE_SUCCEEDED" AND display_name:"my_job_*"` * `state!="JOB_STATE_FAILED" OR display_name="my_job"` * `NOT display_name="my_job"` * `create_time>"2021-05-18T00:00:00Z"` * `labels.keyA=valueA` * `labels.keyB:*`
parent
Description: Required. The resource name of the Location to list the BatchPredictionJobs from. Format: `projects/{project}/locations/{location}`
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+$
Type: string
Required: Yes
Parameter Order: parent
Path: v1beta1/{+parent}/batchPredictionJobs
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/batchPredictionJobs
Description: Lists BatchPredictionJobs in a Location.
▼ ▲ aiplatform.projects.locations.batchPredictionJobs.create
Parameters:
parent
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+$
Location: path
Type: string
Description: Required. The resource name of the Location to create the BatchPredictionJob in. Format: `projects/{project}/locations/{location}`
Parameter Order: parent
HTTP Method: POST
Path: v1beta1/{+parent}/batchPredictionJobs
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Creates a BatchPredictionJob. A BatchPredictionJob once created will right away be attempted to start.
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/batchPredictionJobs
▼ ▲ aiplatform.projects.locations.batchPredictionJobs.cancel
Path: v1beta1/{+name}:cancel
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
name
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/batchPredictionJobs/[^/]+$
Description: Required. The name of the BatchPredictionJob to cancel. Format: `projects/{project}/locations/{location}/batchPredictionJobs/{batch_prediction_job}`
Required: Yes
Type: string
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/batchPredictionJobs/{batchPredictionJobsId}:cancel
Parameter Order: name
HTTP Method: POST
Description: Cancels a BatchPredictionJob. Starts asynchronous cancellation on the BatchPredictionJob. The server makes the best effort to cancel the job, but success is not guaranteed. Clients can use JobService.GetBatchPredictionJob or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On a successful cancellation, the BatchPredictionJob is not deleted;instead its BatchPredictionJob.state is set to `CANCELLED`. Any files already outputted by the job are not deleted.
▼ ▲ aiplatform.projects.locations.dataLabelingJobs.list
Parameters:
orderBy
Type: string
Description: A comma-separated list of fields to order by, sorted in ascending order by default. Use `desc` after a field name for descending.
Location: query
parent
Location: path
Required: Yes
Description: Required. The parent of the DataLabelingJob. Format: `projects/{project}/locations/{location}`
Pattern: ^projects/[^/]+/locations/[^/]+$
Type: string
pageToken
Description: The standard list page token.
Location: query
Type: string
readMask
Type: string
Location: query
Description: Mask specifying which fields to read. FieldMask represents a set of symbolic field paths. For example, the mask can be `paths: "name"`. The "name" here is a field in DataLabelingJob. If this field is not set, all fields of the DataLabelingJob are returned.
Format: google-fieldmask
filter
Description: The standard list filter. Supported fields: * `display_name` supports `=`, `!=` comparisons, and `:` wildcard. * `state` supports `=`, `!=` comparisons. * `create_time` supports `=`, `!=`,`<`, `<=`,`>`, `>=` comparisons. `create_time` must be in RFC 3339 format. * `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* - key existence Some examples of using the filter are: * `state="JOB_STATE_SUCCEEDED" AND display_name:"my_job_*"` * `state!="JOB_STATE_FAILED" OR display_name="my_job"` * `NOT display_name="my_job"` * `create_time>"2021-05-18T00:00:00Z"` * `labels.keyA=valueA` * `labels.keyB:*`
Location: query
Type: string
pageSize
Type: integer
Format: int32
Location: query
Description: The standard list page size.
Parameter Order: parent
Description: Lists DataLabelingJobs in a Location.
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: GET
Path: v1beta1/{+parent}/dataLabelingJobs
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs
▼ ▲ aiplatform.projects.locations.dataLabelingJobs.get
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+/dataLabelingJobs/[^/]+$
Required: Yes
Type: string
Description: Required. The name of the DataLabelingJob. Format: `projects/{project}/locations/{location}/dataLabelingJobs/{data_labeling_job}`
Location: path
Description: Gets a DataLabelingJob.
Path: v1beta1/{+name}
HTTP Method: GET
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs/{dataLabelingJobsId}
▼ ▲ aiplatform.projects.locations.dataLabelingJobs.delete
Path: v1beta1/{+name}
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
name
Location: path
Type: string
Description: Required. The name of the DataLabelingJob to be deleted. Format: `projects/{project}/locations/{location}/dataLabelingJobs/{data_labeling_job}`
Pattern: ^projects/[^/]+/locations/[^/]+/dataLabelingJobs/[^/]+$
Required: Yes
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs/{dataLabelingJobsId}
HTTP Method: DELETE
Parameter Order: name
Description: Deletes a DataLabelingJob.
▼ ▲ aiplatform.projects.locations.dataLabelingJobs.cancel
Parameter Order: name
Path: v1beta1/{+name}:cancel
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
name
Description: Required. The name of the DataLabelingJob. Format: `projects/{project}/locations/{location}/dataLabelingJobs/{data_labeling_job}`
Required: Yes
Location: path
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/dataLabelingJobs/[^/]+$
Description: Cancels a DataLabelingJob. Success of cancellation is not guaranteed.
HTTP Method: POST
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs/{dataLabelingJobsId}:cancel
▼ ▲ aiplatform.projects.locations.dataLabelingJobs.create
Path: v1beta1/{+parent}/dataLabelingJobs
Parameter Order: parent
Description: Creates a DataLabelingJob.
HTTP Method: POST
Parameters:
parent
Description: Required. The parent of the DataLabelingJob. Format: `projects/{project}/locations/{location}`
Required: Yes
Location: path
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+$
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs
▼ ▲ aiplatform.projects.locations.dataLabelingJobs.operations.cancel
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
HTTP Method: POST
Path: v1beta1/{+name}:cancel
Parameters:
name
Description: The name of the operation resource to be cancelled.
Type: string
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/dataLabelingJobs/[^/]+/operations/[^/]+$
Required: Yes
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs/{dataLabelingJobsId}/operations/{operationsId}: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`.
▼ ▲ aiplatform.projects.locations.dataLabelingJobs.operations.list
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs/{dataLabelingJobsId}/operations
Path: v1beta1/{+name}/operations
Parameters:
pageToken
Description: The standard list page token.
Type: string
Location: query
name
Location: path
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/dataLabelingJobs/[^/]+$
Required: Yes
Description: The name of the operation's parent resource.
filter
Description: The standard list filter.
Type: string
Location: query
pageSize
Description: The standard list page size.
Type: integer
Format: int32
Location: query
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
HTTP Method: GET
▼ ▲ aiplatform.projects.locations.dataLabelingJobs.operations.get
Path: v1beta1/{+name}
Parameter Order: name
Parameters:
name
Type: string
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/dataLabelingJobs/[^/]+/operations/[^/]+$
Description: The name of the operation resource.
Required: Yes
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.
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs/{dataLabelingJobsId}/operations/{operationsId}
HTTP Method: GET
▼ ▲ aiplatform.projects.locations.dataLabelingJobs.operations.wait
Parameter Order: name
Path: v1beta1/{+name}:wait
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs/{dataLabelingJobsId}/operations/{operationsId}:wait
Parameters:
timeout
Format: google-duration
Type: string
Location: query
Description: The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
name
Pattern: ^projects/[^/]+/locations/[^/]+/dataLabelingJobs/[^/]+/operations/[^/]+$
Description: The name of the operation resource to wait on.
Type: string
Location: path
Required: Yes
HTTP Method: POST
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
▼ ▲ aiplatform.projects.locations.dataLabelingJobs.operations.delete
Parameters:
name
Location: path
Required: Yes
Type: string
Description: The name of the operation resource to be deleted.
Pattern: ^projects/[^/]+/locations/[^/]+/dataLabelingJobs/[^/]+/operations/[^/]+$
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs/{dataLabelingJobsId}/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`.
HTTP Method: DELETE
Path: v1beta1/{+name}
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
▼ ▲ aiplatform.projects.locations.notebookRuntimes.start
Parameter Order: name
Path: v1beta1/{+name}:start
HTTP Method: POST
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+/notebookRuntimes/[^/]+$
Type: string
Location: path
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.
Required: Yes
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}:start
Description: Starts a NotebookRuntime.
▼ ▲ aiplatform.projects.locations.notebookRuntimes.assign
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes:assign
Path: v1beta1/{+parent}/notebookRuntimes:assign
Parameters:
parent
Pattern: ^projects/[^/]+/locations/[^/]+$
Type: string
Required: Yes
Description: Required. The resource name of the Location to get the NotebookRuntime assignment. Format: `projects/{project}/locations/{location}`
Location: path
HTTP Method: POST
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.
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: parent
▼ ▲ aiplatform.projects.locations.notebookRuntimes.delete
HTTP Method: DELETE
Path: v1beta1/{+name}
Description: Deletes a NotebookRuntime.
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}
Parameters:
name
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
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/notebookRuntimes/[^/]+$
Required: Yes
▼ ▲ aiplatform.projects.locations.notebookRuntimes.reportEvent
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}:reportEvent
HTTP Method: POST
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
name
Description: Required. The name of the NotebookRuntime resource. Format: `projects/{project}/locations/{location}/notebookRuntimes/{notebook_runtime}`
Pattern: ^projects/[^/]+/locations/[^/]+/notebookRuntimes/[^/]+$
Type: string
Location: path
Required: Yes
Path: v1beta1/{+name}:reportEvent
▼ ▲ aiplatform.projects.locations.notebookRuntimes.list
Parameter Order: parent
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes
Parameters:
filter
Location: query
Type: string
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`
parent
Location: path
Description: Required. The resource name of the Location from which to list the NotebookRuntimes. Format: `projects/{project}/locations/{location}`
Pattern: ^projects/[^/]+/locations/[^/]+$
Required: Yes
Type: string
readMask
Format: google-fieldmask
Location: query
Description: Optional. Mask specifying which fields to read.
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
Location: query
Type: integer
Format: int32
Description: Optional. The standard list page size.
orderBy
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`.
Location: query
Path: v1beta1/{+parent}/notebookRuntimes
HTTP Method: GET
Description: Lists NotebookRuntimes in a Location.
▼ ▲ aiplatform.projects.locations.notebookRuntimes.get
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}
HTTP Method: GET
Description: Gets a NotebookRuntime.
Path: v1beta1/{+name}
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.
Pattern: ^projects/[^/]+/locations/[^/]+/notebookRuntimes/[^/]+$
Type: string
Location: path
Required: Yes
▼ ▲ aiplatform.projects.locations.notebookRuntimes.generateAccessToken
Parameters:
name
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/notebookRuntimes/[^/]+$
Description: Required. The name of the NotebookRuntime resource. Format: `projects/{project}/locations/{location}/notebookRuntimes/{notebook_runtime}`
Location: path
Required: Yes
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Internal only: Called from Compute Engine instance to obtain EUC for owner Anonymous access: authenticates caller using VM identity JWT. Design doc: go/colab-on-vertex-euc-dd
Path: v1beta1/{+name}:generateAccessToken
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}:generateAccessToken
HTTP Method: POST
▼ ▲ aiplatform.projects.locations.endpoints.predict
Parameter Order: endpoint
Path: v1beta1/{+endpoint}:predict
Description: Perform an online prediction.
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:predict
HTTP Method: POST
Parameters:
endpoint
Type: string
Description: Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`
Pattern: ^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$
Location: path
Required: Yes
▼ ▲ aiplatform.projects.locations.endpoints.rawPredict
Parameter Order: endpoint
HTTP Method: POST
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:rawPredict
Path: v1beta1/{+endpoint}:rawPredict
Parameters:
endpoint
Description: Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`
Pattern: ^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$
Required: Yes
Type: string
Location: path
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Perform an online prediction with an arbitrary HTTP payload. The response includes the following HTTP headers: * `X-Vertex-AI-Endpoint-Id`: ID of the Endpoint that served this prediction. * `X-Vertex-AI-Deployed-Model-Id`: ID of the Endpoint's DeployedModel that served this prediction.
▼ ▲ aiplatform.projects.locations.endpoints.patch
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$
Type: string
Required: Yes
Description: Output only. The resource name of the Endpoint.
Location: path
updateMask
Format: google-fieldmask
Description: Required. The update mask applies to the resource. See google.protobuf.FieldMask.
Type: string
Location: query
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}
Description: Updates an Endpoint.
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
HTTP Method: PATCH
Path: v1beta1/{+name}
▼ ▲ aiplatform.projects.locations.endpoints.create
Parameter Order: parent
Description: Creates an Endpoint.
Path: v1beta1/{+parent}/endpoints
Parameters:
endpointId
Location: query
Description: Immutable. The ID to use for endpoint, which will become the final component of the endpoint resource name. If not provided, Vertex AI will generate a value for this ID. If the first character is a letter, this value may be up to 63 characters, and valid characters are `[a-z0-9-]`. The last character must be a letter or number. If the first character is a number, this value may be up to 9 characters, and valid characters are `[0-9]` with no leading zeros. When using HTTP/JSON, this field is populated based on a query string argument, such as `?endpoint_id=12345`. This is the fallback for fields that are not included in either the URI or the body.
Type: string
parent
Description: Required. The resource name of the Location to create the Endpoint in. Format: `projects/{project}/locations/{location}`
Location: path
Type: string
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+$
HTTP Method: POST
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints
▼ ▲ aiplatform.projects.locations.endpoints.list
Path: v1beta1/{+parent}/endpoints
Parameters:
filter
Type: string
Description: Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `endpoint` supports = and !=. `endpoint` represents the Endpoint ID, i.e. the last segment of the Endpoint'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: * `endpoint=1` * `displayName="myDisplayName"` * `labels.myKey="myValue"`
Location: query
parent
Type: string
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+$
Description: Required. The resource name of the Location from which to list the Endpoints. Format: `projects/{project}/locations/{location}`
Location: path
readMask
Description: Optional. Mask specifying which fields to read.
Type: string
Location: query
Format: google-fieldmask
pageSize
Description: Optional. The standard list page size.
Type: integer
Format: int32
Location: query
pageToken
Location: query
Description: Optional. The standard list page token. Typically obtained via ListEndpointsResponse.next_page_token of the previous EndpointService.ListEndpoints call.
Type: string
HTTP Method: GET
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints
Description: Lists Endpoints in a Location.
Parameter Order: parent
▼ ▲ aiplatform.projects.locations.endpoints.delete
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}
Description: Deletes an Endpoint.
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1beta1/{+name}
Parameter Order: name
HTTP Method: DELETE
Parameters:
name
Description: Required. The name of the Endpoint resource to be deleted. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`
Pattern: ^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$
Type: string
Required: Yes
Location: path
▼ ▲ aiplatform.projects.locations.endpoints.mutateDeployedModel
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:mutateDeployedModel
HTTP Method: POST
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1beta1/{+endpoint}:mutateDeployedModel
Parameters:
endpoint
Required: Yes
Location: path
Description: Required. The name of the Endpoint resource into which to mutate a DeployedModel. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`
Pattern: ^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$
Type: string
Description: Updates an existing deployed model. Updatable fields include `min_replica_count`, `max_replica_count`, `autoscaling_metric_specs`, `disable_container_logging` (v1 only), and `enable_container_logging` (v1beta1 only).
Parameter Order: endpoint
▼ ▲ aiplatform.projects.locations.endpoints.undeployModel
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:undeployModel
Parameters:
endpoint
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$
Required: Yes
Description: Required. The name of the Endpoint resource from which to undeploy a Model. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`
Type: string
Parameter Order: endpoint
Path: v1beta1/{+endpoint}:undeployModel
Description: Undeploys a Model from an Endpoint, removing a DeployedModel from it, and freeing all resources it's using.
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: POST
▼ ▲ aiplatform.projects.locations.endpoints.get
Path: v1beta1/{+name}
Parameters:
name
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$
Description: Required. The name of the Endpoint resource. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`
Type: string
Location: path
Description: Gets an Endpoint.
HTTP Method: GET
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}
Parameter Order: name
▼ ▲ aiplatform.projects.locations.endpoints.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.
Path: v1beta1/{+resource}:setIamPolicy
Parameter Order: resource
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
resource
Required: Yes
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.
Pattern: ^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$
Location: path
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:setIamPolicy
HTTP Method: POST
▼ ▲ aiplatform.projects.locations.endpoints.testIamPermissions
Path: v1beta1/{+resource}:testIamPermissions
HTTP Method: POST
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.
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:testIamPermissions
Parameter Order: resource
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).
Location: query
Repeated: Yes
resource
Location: path
Type: string
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$
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.
▼ ▲ aiplatform.projects.locations.endpoints.explain
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:explain
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
endpoint
Pattern: ^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$
Type: string
Required: Yes
Description: Required. The name of the Endpoint requested to serve the explanation. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`
Location: path
HTTP Method: POST
Path: v1beta1/{+endpoint}:explain
Description: Perform an online explanation. If deployed_model_id is specified, the corresponding DeployModel must have explanation_spec populated. If deployed_model_id is not specified, all DeployedModels must have explanation_spec populated.
Parameter Order: endpoint
▼ ▲ aiplatform.projects.locations.endpoints.getIamPolicy
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:getIamPolicy
Scopes: https://www.googleapis.com/auth/cloud-platform
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
HTTP Method: POST
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
Required: Yes
Location: path
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.
Pattern: ^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$
Path: v1beta1/{+resource}:getIamPolicy
▼ ▲ aiplatform.projects.locations.endpoints.deployModel
Parameters:
endpoint
Description: Required. The name of the Endpoint resource into which to deploy a Model. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`
Required: Yes
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$
Type: string
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:deployModel
Parameter Order: endpoint
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1beta1/{+endpoint}:deployModel
HTTP Method: POST
Description: Deploys a Model into this Endpoint, creating a DeployedModel within it.
▼ ▲ aiplatform.projects.locations.endpoints.serverStreamingPredict
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Perform a server-side streaming online prediction request for Vertex LLM streaming.
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:serverStreamingPredict
Parameters:
endpoint
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$
Type: string
Location: path
Description: Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`
Path: v1beta1/{+endpoint}:serverStreamingPredict
Parameter Order: endpoint
HTTP Method: POST
▼ ▲ aiplatform.projects.locations.endpoints.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`.
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}/operations/{operationsId}
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
Parameters:
name
Required: Yes
Type: string
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/endpoints/[^/]+/operations/[^/]+$
Description: The name of the operation resource to be deleted.
Path: v1beta1/{+name}
HTTP Method: DELETE
▼ ▲ aiplatform.projects.locations.endpoints.operations.get
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}/operations/{operationsId}
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
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/[^/]+/endpoints/[^/]+/operations/[^/]+$
Required: Yes
Location: path
Description: The name of the operation resource.
Type: string
Path: v1beta1/{+name}
▼ ▲ aiplatform.projects.locations.endpoints.operations.cancel
HTTP Method: POST
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: v1beta1/{+name}:cancel
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}/operations/{operationsId}:cancel
Parameters:
name
Location: path
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/endpoints/[^/]+/operations/[^/]+$
Type: string
Description: The name of the operation resource to be cancelled.
Parameter Order: name
▼ ▲ aiplatform.projects.locations.endpoints.operations.wait
Description: Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
Parameters:
timeout
Location: query
Type: string
Format: google-duration
Description: The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
name
Required: Yes
Description: The name of the operation resource to wait on.
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/endpoints/[^/]+/operations/[^/]+$
Type: string
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}/operations/{operationsId}:wait
HTTP Method: POST
Path: v1beta1/{+name}:wait
Parameter Order: name
▼ ▲ aiplatform.projects.locations.endpoints.operations.list
Parameter Order: name
Path: v1beta1/{+name}/operations
Description: Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
HTTP Method: GET
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}/operations
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
pageToken
Description: The standard list page token.
Location: query
Type: string
name
Required: Yes
Type: string
Description: The name of the operation's parent resource.
Pattern: ^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$
Location: path
pageSize
Type: integer
Format: int32
Location: query
Description: The standard list page size.
filter
Type: string
Location: query
Description: The standard list filter.
▼ ▲ aiplatform.projects.locations.publishers.models.rawPredict
Parameters:
endpoint
Description: Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`
Pattern: ^projects/[^/]+/locations/[^/]+/publishers/[^/]+/models/[^/]+$
Required: Yes
Type: string
Location: path
Description: Perform an online prediction with an arbitrary HTTP payload. The response includes the following HTTP headers: * `X-Vertex-AI-Endpoint-Id`: ID of the Endpoint that served this prediction. * `X-Vertex-AI-Deployed-Model-Id`: ID of the Endpoint's DeployedModel that served this prediction.
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:rawPredict
Path: v1beta1/{+endpoint}:rawPredict
Parameter Order: endpoint
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: POST
▼ ▲ aiplatform.projects.locations.publishers.models.serverStreamingPredict
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:serverStreamingPredict
Parameters:
endpoint
Type: string
Required: Yes
Description: Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`
Pattern: ^projects/[^/]+/locations/[^/]+/publishers/[^/]+/models/[^/]+$
Location: path
Path: v1beta1/{+endpoint}:serverStreamingPredict
Parameter Order: endpoint
HTTP Method: POST
Description: Perform a server-side streaming online prediction request for Vertex LLM streaming.
▼ ▲ aiplatform.projects.locations.publishers.models.predict
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:predict
Description: Perform an online prediction.
Parameter Order: endpoint
HTTP Method: POST
Parameters:
endpoint
Pattern: ^projects/[^/]+/locations/[^/]+/publishers/[^/]+/models/[^/]+$
Description: Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`
Required: Yes
Type: string
Location: path
Path: v1beta1/{+endpoint}:predict
▼ ▲ aiplatform.projects.locations.schedules.patch
Description: Updates an active or paused Schedule. When the Schedule is updated, new runs will be scheduled starting from the updated next execution time after the update time based on the time_specification in the updated Schedule. All unstarted runs before the update time will be skipped while already created runs will NOT be paused or canceled.
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}
HTTP Method: PATCH
Parameters:
updateMask
Format: google-fieldmask
Type: string
Description: Required. The update mask applies to the resource. See google.protobuf.FieldMask.
Location: query
name
Type: string
Location: path
Description: Output only. The resource name of the Schedule.
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/schedules/[^/]+$
Path: v1beta1/{+name}
▼ ▲ aiplatform.projects.locations.schedules.list
Parameter Order: parent
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/schedules
Path: v1beta1/{+parent}/schedules
Description: Lists Schedules in a Location.
HTTP Method: GET
Parameters:
pageSize
Format: int32
Type: integer
Location: query
Description: The standard list page size. Default to 100 if not specified.
filter
Type: string
Location: query
Description: Lists the Schedules that match the filter expression. The following fields are supported: * `display_name`: Supports `=`, `!=` comparisons, and `:` wildcard. * `state`: Supports `=` and `!=` comparisons. * `request`: Supports existence of the check. (e.g. `create_pipeline_job_request:*` --> Schedule has create_pipeline_job_request). * `create_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be in RFC 3339 format. * `start_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be in RFC 3339 format. * `end_time`: Supports `=`, `!=`, `<`, `>`, `<=`, `>=` comparisons and `:*` existence check. Values must be in RFC 3339 format. * `next_run_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be in RFC 3339 format. Filter expressions can be combined together using logical operators (`NOT`, `AND` & `OR`). The syntax to define filter expression is based on https://google.aip.dev/160. Examples: * `state="ACTIVE" AND display_name:"my_schedule_*"` * `NOT display_name="my_schedule"` * `create_time>"2021-05-18T00:00:00Z"` * `end_time>"2021-05-18T00:00:00Z" OR NOT end_time:*` * `create_pipeline_job_request:*`
orderBy
Location: query
Type: string
Description: A comma-separated list of fields to order by. The default sort order is in ascending order. Use "desc" after a field name for descending. You can have multiple order_by fields provided. For example, using "create_time desc, end_time" will order results by create time in descending order, and if there are multiple schedules having the same create time, order them by the end time in ascending order. If order_by is not specified, it will order by default with create_time in descending order. Supported fields: * `create_time` * `start_time` * `end_time` * `next_run_time`
pageToken
Type: string
Description: The standard list page token. Typically obtained via ListSchedulesResponse.next_page_token of the previous ScheduleService.ListSchedules call.
Location: query
parent
Description: Required. The resource name of the Location to list the Schedules from. Format: `projects/{project}/locations/{location}`
Required: Yes
Location: path
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+$
▼ ▲ aiplatform.projects.locations.schedules.resume
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}:resume
Description: Resumes a paused Schedule to start scheduling new runs. Will mark Schedule.state to 'ACTIVE'. Only paused Schedule can be resumed. When the Schedule is resumed, new runs will be scheduled starting from the next execution time after the current time based on the time_specification in the Schedule. If Schedule.catchUp is set up true, all missed runs will be scheduled for backfill first.
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+/schedules/[^/]+$
Required: Yes
Type: string
Description: Required. The name of the Schedule resource to be resumed. Format: `projects/{project}/locations/{location}/schedules/{schedule}`
Location: path
Parameter Order: name
HTTP Method: POST
Path: v1beta1/{+name}:resume
▼ ▲ aiplatform.projects.locations.schedules.create
Parameters:
parent
Pattern: ^projects/[^/]+/locations/[^/]+$
Required: Yes
Location: path
Type: string
Description: Required. The resource name of the Location to create the Schedule in. Format: `projects/{project}/locations/{location}`
Path: v1beta1/{+parent}/schedules
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: parent
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/schedules
Description: Creates a Schedule.
HTTP Method: POST
▼ ▲ aiplatform.projects.locations.schedules.pause
Parameter Order: name
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}:pause
Path: v1beta1/{+name}:pause
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: POST
Description: Pauses a Schedule. Will mark Schedule.state to 'PAUSED'. If the schedule is paused, no new runs will be created. Already created runs will NOT be paused or canceled.
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+/schedules/[^/]+$
Description: Required. The name of the Schedule resource to be paused. Format: `projects/{project}/locations/{location}/schedules/{schedule}`
Type: string
Location: path
Required: Yes
▼ ▲ aiplatform.projects.locations.schedules.delete
Parameter Order: name
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+/schedules/[^/]+$
Required: Yes
Description: Required. The name of the Schedule resource to be deleted. Format: `projects/{project}/locations/{location}/schedules/{schedule}`
Type: string
Location: path
Path: v1beta1/{+name}
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}
Description: Deletes a Schedule.
HTTP Method: DELETE
▼ ▲ aiplatform.projects.locations.schedules.get
Path: v1beta1/{+name}
HTTP Method: GET
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Gets a Schedule.
Parameters:
name
Required: Yes
Description: Required. The name of the Schedule resource. Format: `projects/{project}/locations/{location}/schedules/{schedule}`
Pattern: ^projects/[^/]+/locations/[^/]+/schedules/[^/]+$
Type: string
Location: path
▼ ▲ aiplatform.projects.locations.schedules.operations.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.
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+/schedules/[^/]+/operations/[^/]+$
Location: path
Description: The name of the operation resource.
Type: string
Required: Yes
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}/operations/{operationsId}
Parameter Order: name
HTTP Method: GET
Path: v1beta1/{+name}
▼ ▲ aiplatform.projects.locations.schedules.operations.cancel
HTTP Method: POST
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`.
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}/operations/{operationsId}:cancel
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+/schedules/[^/]+/operations/[^/]+$
Location: path
Description: The name of the operation resource to be cancelled.
Type: string
Required: Yes
Path: v1beta1/{+name}:cancel
▼ ▲ aiplatform.projects.locations.schedules.operations.wait
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}/operations/{operationsId}:wait
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+/schedules/[^/]+/operations/[^/]+$
Type: string
Description: The name of the operation resource to wait on.
Required: Yes
Location: path
timeout
Format: google-duration
Type: string
Description: The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
Location: query
Parameter Order: name
HTTP Method: POST
Description: Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
Path: v1beta1/{+name}:wait
▼ ▲ aiplatform.projects.locations.schedules.operations.list
Parameters:
filter
Description: The standard list filter.
Type: string
Location: query
pageSize
Location: query
Type: integer
Description: The standard list page size.
Format: int32
pageToken
Location: query
Type: string
Description: The standard list page token.
name
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/schedules/[^/]+$
Required: Yes
Type: string
Description: The name of the operation's parent resource.
Parameter Order: name
Path: v1beta1/{+name}/operations
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}/operations
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: GET
Description: Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
▼ ▲ aiplatform.projects.locations.schedules.operations.delete
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}/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`.
Parameters:
name
Type: string
Location: path
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/schedules/[^/]+/operations/[^/]+$
Description: The name of the operation resource to be deleted.
Path: v1beta1/{+name}
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: DELETE
Parameter Order: name
▼ ▲ aiplatform.projects.locations.indexes.delete
Path: v1beta1/{+name}
Parameters:
name
Type: string
Location: path
Description: Required. The name of the Index resource to be deleted. Format: `projects/{project}/locations/{location}/indexes/{index}`
Pattern: ^projects/[^/]+/locations/[^/]+/indexes/[^/]+$
Required: Yes
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}
Description: Deletes an Index. An Index can only be deleted when all its DeployedIndexes had been undeployed.
HTTP Method: DELETE
▼ ▲ aiplatform.projects.locations.indexes.create
Parameters:
parent
Description: Required. The resource name of the Location to create the Index in. Format: `projects/{project}/locations/{location}`
Type: string
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+$
Location: path
Description: Creates an Index.
Parameter Order: parent
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/indexes
HTTP Method: POST
Path: v1beta1/{+parent}/indexes
▼ ▲ aiplatform.projects.locations.indexes.patch
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
Description: Updates an Index.
HTTP Method: PATCH
Parameters:
updateMask
Type: string
Format: google-fieldmask
Location: query
Description: The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask.
name
Location: path
Required: Yes
Description: Output only. The resource name of the Index.
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/indexes/[^/]+$
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}
Path: v1beta1/{+name}
▼ ▲ aiplatform.projects.locations.indexes.removeDatapoints
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1beta1/{+index}:removeDatapoints
Description: Remove Datapoints from an Index.
Parameters:
index
Pattern: ^projects/[^/]+/locations/[^/]+/indexes/[^/]+$
Location: path
Description: Required. The name of the Index resource to be updated. Format: `projects/{project}/locations/{location}/indexes/{index}`
Required: Yes
Type: string
Parameter Order: index
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}:removeDatapoints
HTTP Method: POST
▼ ▲ aiplatform.projects.locations.indexes.list
Path: v1beta1/{+parent}/indexes
Parameter Order: parent
HTTP Method: GET
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/indexes
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
filter
Description: The standard list filter.
Type: string
Location: query
readMask
Location: query
Description: Mask specifying which fields to read.
Type: string
Format: google-fieldmask
pageSize
Description: The standard list page size.
Type: integer
Format: int32
Location: query
pageToken
Type: string
Description: The standard list page token. Typically obtained via ListIndexesResponse.next_page_token of the previous IndexService.ListIndexes call.
Location: query
parent
Location: path
Description: Required. The resource name of the Location from which to list the Indexes. Format: `projects/{project}/locations/{location}`
Pattern: ^projects/[^/]+/locations/[^/]+$
Required: Yes
Type: string
Description: Lists Indexes in a Location.
▼ ▲ aiplatform.projects.locations.indexes.get
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}
Description: Gets an Index.
HTTP Method: GET
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
name
Description: Required. The name of the Index resource. Format: `projects/{project}/locations/{location}/indexes/{index}`
Pattern: ^projects/[^/]+/locations/[^/]+/indexes/[^/]+$
Location: path
Required: Yes
Type: string
Path: v1beta1/{+name}
▼ ▲ aiplatform.projects.locations.indexes.upsertDatapoints
HTTP Method: POST
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}:upsertDatapoints
Parameters:
index
Required: Yes
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/indexes/[^/]+$
Location: path
Description: Required. The name of the Index resource to be updated. Format: `projects/{project}/locations/{location}/indexes/{index}`
Path: v1beta1/{+index}:upsertDatapoints
Description: Add/update Datapoints into an Index.
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: index
▼ ▲ aiplatform.projects.locations.indexes.operations.cancel
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}/operations/{operationsId}:cancel
Parameters:
name
Required: Yes
Location: path
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/indexes/[^/]+/operations/[^/]+$
Description: The name of the operation resource to be cancelled.
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: v1beta1/{+name}:cancel
HTTP Method: POST
Parameter Order: name
▼ ▲ aiplatform.projects.locations.indexes.operations.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.
Parameter Order: name
HTTP Method: GET
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+/indexes/[^/]+/operations/[^/]+$
Description: The name of the operation resource.
Type: string
Location: path
Required: Yes
Path: v1beta1/{+name}
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}/operations/{operationsId}
▼ ▲ aiplatform.projects.locations.indexes.operations.list
Description: Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
HTTP Method: GET
Parameter Order: name
Path: v1beta1/{+name}/operations
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}/operations
Parameters:
name
Location: path
Required: Yes
Type: string
Description: The name of the operation's parent resource.
Pattern: ^projects/[^/]+/locations/[^/]+/indexes/[^/]+$
filter
Description: The standard list filter.
Type: string
Location: query
pageToken
Location: query
Description: The standard list page token.
Type: string
pageSize
Format: int32
Location: query
Type: integer
Description: The standard list page size.
▼ ▲ aiplatform.projects.locations.indexes.operations.delete
Parameter Order: name
HTTP Method: 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
Path: v1beta1/{+name}
Parameters:
name
Description: The name of the operation resource to be deleted.
Type: string
Location: path
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/indexes/[^/]+/operations/[^/]+$
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}/operations/{operationsId}
▼ ▲ aiplatform.projects.locations.indexes.operations.wait
Parameter Order: name
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}/operations/{operationsId}:wait
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1beta1/{+name}:wait
Parameters:
name
Location: path
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/indexes/[^/]+/operations/[^/]+$
Type: string
Description: The name of the operation resource to wait on.
timeout
Format: google-duration
Description: The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
Type: string
Location: query
HTTP Method: POST
Description: Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
▼ ▲ aiplatform.projects.locations.notebookRuntimeTemplates.create
HTTP Method: POST
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates
Description: Creates a NotebookRuntimeTemplate.
Parameters:
notebookRuntimeTemplateId
Type: string
Location: query
Description: Optional. User specified ID for the notebook runtime template.
parent
Pattern: ^projects/[^/]+/locations/[^/]+$
Description: Required. The resource name of the Location to create the NotebookRuntimeTemplate. Format: `projects/{project}/locations/{location}`
Location: path
Required: Yes
Type: string
Path: v1beta1/{+parent}/notebookRuntimeTemplates
Parameter Order: parent
▼ ▲ aiplatform.projects.locations.notebookRuntimeTemplates.get
Parameters:
name
Required: Yes
Location: path
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/notebookRuntimeTemplates/[^/]+$
Description: Required. The name of the NotebookRuntimeTemplate resource. Format: `projects/{project}/locations/{location}/notebookRuntimeTemplates/{notebook_runtime_template}`
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: GET
Description: Gets a NotebookRuntimeTemplate.
Parameter Order: name
Path: v1beta1/{+name}
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}
▼ ▲ aiplatform.projects.locations.notebookRuntimeTemplates.delete
Parameter Order: name
Path: v1beta1/{+name}
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}
Description: Deletes a NotebookRuntimeTemplate.
Parameters:
name
Location: path
Description: Required. The name of the NotebookRuntimeTemplate resource to be deleted. Format: `projects/{project}/locations/{location}/notebookRuntimeTemplates/{notebook_runtime_template}`
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/notebookRuntimeTemplates/[^/]+$
Type: string
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: DELETE
▼ ▲ aiplatform.projects.locations.notebookRuntimeTemplates.getIamPolicy
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1beta1/{+resource}:getIamPolicy
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}:getIamPolicy
Parameters:
resource
Type: string
Required: Yes
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.
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/notebookRuntimeTemplates/[^/]+$
options.requestedPolicyVersion
Type: integer
Format: int32
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).
Parameter Order: resource
Description: Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
HTTP Method: POST
▼ ▲ aiplatform.projects.locations.notebookRuntimeTemplates.list
Description: Lists NotebookRuntimeTemplates in a Location.
Path: v1beta1/{+parent}/notebookRuntimeTemplates
Parameter Order: parent
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates
Parameters:
orderBy
Location: query
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
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"`
parent
Pattern: ^projects/[^/]+/locations/[^/]+$
Description: Required. The resource name of the Location from which to list the NotebookRuntimeTemplates. Format: `projects/{project}/locations/{location}`
Required: Yes
Location: path
Type: string
pageSize
Location: query
Type: integer
Description: Optional. The standard list page size.
Format: int32
pageToken
Description: Optional. The standard list page token. Typically obtained via ListNotebookRuntimeTemplatesResponse.next_page_token of the previous NotebookService.ListNotebookRuntimeTemplates call.
Location: query
Type: string
readMask
Location: query
Description: Optional. Mask specifying which fields to read.
Format: google-fieldmask
Type: string
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: GET
▼ ▲ aiplatform.projects.locations.notebookRuntimeTemplates.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.
Required: Yes
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/notebookRuntimeTemplates/[^/]+$
Location: path
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: v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}:setIamPolicy
HTTP Method: POST
Path: v1beta1/{+resource}:setIamPolicy
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: resource
▼ ▲ aiplatform.projects.locations.notebookRuntimeTemplates.testIamPermissions
HTTP Method: POST
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}:testIamPermissions
Parameter Order: resource
Path: v1beta1/{+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.
Parameters:
permissions
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
Type: string
resource
Location: path
Type: string
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/notebookRuntimeTemplates/[^/]+$
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.
▼ ▲ aiplatform.projects.locations.extensions.operations.delete
Scopes: https://www.googleapis.com/auth/cloud-platform
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`.
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/extensions/{extensionsId}/operations/{operationsId}
Path: v1beta1/{+name}
Parameters:
name
Description: The name of the operation resource to be deleted.
Pattern: ^projects/[^/]+/locations/[^/]+/extensions/[^/]+/operations/[^/]+$
Required: Yes
Type: string
Location: path
HTTP Method: DELETE
Parameter Order: name
▼ ▲ aiplatform.projects.locations.extensions.operations.cancel
Parameter Order: name
HTTP Method: POST
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`.
Parameters:
name
Required: Yes
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/extensions/[^/]+/operations/[^/]+$
Type: string
Description: The name of the operation resource to be cancelled.
Path: v1beta1/{+name}:cancel
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/extensions/{extensionsId}/operations/{operationsId}:cancel
▼ ▲ aiplatform.projects.locations.extensions.operations.list
Path: v1beta1/{+name}/operations
Parameter Order: name
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/extensions/{extensionsId}/operations
Description: Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
HTTP Method: GET
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
filter
Description: The standard list filter.
Location: query
Type: string
name
Pattern: ^projects/[^/]+/locations/[^/]+/extensions/[^/]+$
Type: string
Description: The name of the operation's parent resource.
Required: Yes
Location: path
pageSize
Format: int32
Description: The standard list page size.
Location: query
Type: integer
pageToken
Type: string
Location: query
Description: The standard list page token.
▼ ▲ aiplatform.projects.locations.extensions.operations.get
HTTP Method: GET
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+/extensions/[^/]+/operations/[^/]+$
Location: path
Type: string
Description: The name of the operation resource.
Required: Yes
Path: v1beta1/{+name}
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/extensions/{extensionsId}/operations/{operationsId}
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.
▼ ▲ aiplatform.projects.locations.extensions.operations.wait
Path: v1beta1/{+name}:wait
Parameter Order: name
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/extensions/{extensionsId}/operations/{operationsId}:wait
Description: Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: POST
Parameters:
timeout
Location: query
Description: The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
Format: google-duration
Type: string
name
Required: Yes
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/extensions/[^/]+/operations/[^/]+$
Description: The name of the operation resource to wait on.
Location: path
▼ ▲ aiplatform.projects.locations.extensions.deployments.operations.wait
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/extensions/{extensionsId}/deployments/{deploymentsId}/operations/{operationsId}:wait
Parameter Order: name
Path: v1beta1/{+name}:wait
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
HTTP Method: POST
Parameters:
name
Description: The name of the operation resource to wait on.
Type: string
Required: Yes
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/extensions/[^/]+/deployments/[^/]+/operations/[^/]+$
timeout
Location: query
Format: google-duration
Description: The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
Type: string
▼ ▲ aiplatform.projects.locations.extensions.deployments.operations.cancel
Parameters:
name
Required: Yes
Type: string
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/extensions/[^/]+/deployments/[^/]+/operations/[^/]+$
Description: The name of the operation resource to be cancelled.
Path: v1beta1/{+name}:cancel
HTTP Method: POST
Parameter Order: name
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`.
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/extensions/{extensionsId}/deployments/{deploymentsId}/operations/{operationsId}:cancel
▼ ▲ aiplatform.projects.locations.extensions.deployments.operations.list
Description: Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/extensions/{extensionsId}/deployments/{deploymentsId}/operations
Parameters:
filter
Description: The standard list filter.
Location: query
Type: string
pageToken
Description: The standard list page token.
Location: query
Type: string
pageSize
Description: The standard list page size.
Format: int32
Type: integer
Location: query
name
Type: string
Description: The name of the operation's parent resource.
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/extensions/[^/]+/deployments/[^/]+$
Required: Yes
HTTP Method: GET
Path: v1beta1/{+name}/operations
Parameter Order: name
▼ ▲ aiplatform.projects.locations.extensions.deployments.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`.
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/extensions/{extensionsId}/deployments/{deploymentsId}/operations/{operationsId}
Parameter Order: name
HTTP Method: DELETE
Path: v1beta1/{+name}
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
name
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/extensions/[^/]+/deployments/[^/]+/operations/[^/]+$
Location: path
Type: string
Description: The name of the operation resource to be deleted.
▼ ▲ aiplatform.projects.locations.extensions.deployments.operations.get
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+/extensions/[^/]+/deployments/[^/]+/operations/[^/]+$
Description: The name of the operation resource.
Required: Yes
Location: path
Type: string
Parameter Order: name
HTTP Method: GET
Scopes: https://www.googleapis.com/auth/cloud-platform
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.
Path: v1beta1/{+name}
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/extensions/{extensionsId}/deployments/{deploymentsId}/operations/{operationsId}
▼ ▲ aiplatform.projects.locations.hyperparameterTuningJobs.delete
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
name
Description: Required. The name of the HyperparameterTuningJob resource to be deleted. Format: `projects/{project}/locations/{location}/hyperparameterTuningJobs/{hyperparameter_tuning_job}`
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/hyperparameterTuningJobs/[^/]+$
Location: path
Type: string
HTTP Method: DELETE
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs/{hyperparameterTuningJobsId}
Parameter Order: name
Description: Deletes a HyperparameterTuningJob.
Path: v1beta1/{+name}
▼ ▲ aiplatform.projects.locations.hyperparameterTuningJobs.create
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
parent
Pattern: ^projects/[^/]+/locations/[^/]+$
Required: Yes
Type: string
Location: path
Description: Required. The resource name of the Location to create the HyperparameterTuningJob in. Format: `projects/{project}/locations/{location}`
Description: Creates a HyperparameterTuningJob
HTTP Method: POST
Parameter Order: parent
Path: v1beta1/{+parent}/hyperparameterTuningJobs
▼ ▲ aiplatform.projects.locations.hyperparameterTuningJobs.list
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1beta1/{+parent}/hyperparameterTuningJobs
Parameter Order: parent
Parameters:
filter
Type: string
Description: The standard list filter. Supported fields: * `display_name` supports `=`, `!=` comparisons, and `:` wildcard. * `state` supports `=`, `!=` comparisons. * `create_time` supports `=`, `!=`,`<`, `<=`,`>`, `>=` comparisons. `create_time` must be in RFC 3339 format. * `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* - key existence Some examples of using the filter are: * `state="JOB_STATE_SUCCEEDED" AND display_name:"my_job_*"` * `state!="JOB_STATE_FAILED" OR display_name="my_job"` * `NOT display_name="my_job"` * `create_time>"2021-05-18T00:00:00Z"` * `labels.keyA=valueA` * `labels.keyB:*`
Location: query
readMask
Location: query
Format: google-fieldmask
Type: string
Description: Mask specifying which fields to read.
pageToken
Description: The standard list page token. Typically obtained via ListHyperparameterTuningJobsResponse.next_page_token of the previous JobService.ListHyperparameterTuningJobs call.
Location: query
Type: string
parent
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+$
Type: string
Location: path
Description: Required. The resource name of the Location to list the HyperparameterTuningJobs from. Format: `projects/{project}/locations/{location}`
pageSize
Type: integer
Description: The standard list page size.
Format: int32
Location: query
Description: Lists HyperparameterTuningJobs in a Location.
HTTP Method: GET
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs
▼ ▲ aiplatform.projects.locations.hyperparameterTuningJobs.cancel
Parameter Order: name
Parameters:
name
Required: Yes
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/hyperparameterTuningJobs/[^/]+$
Description: Required. The name of the HyperparameterTuningJob to cancel. Format: `projects/{project}/locations/{location}/hyperparameterTuningJobs/{hyperparameter_tuning_job}`
Type: string
HTTP Method: POST
Path: v1beta1/{+name}:cancel
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs/{hyperparameterTuningJobsId}:cancel
Description: Cancels a HyperparameterTuningJob. Starts asynchronous cancellation on the HyperparameterTuningJob. The server makes a best effort to cancel the job, but success is not guaranteed. Clients can use JobService.GetHyperparameterTuningJob or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On successful cancellation, the HyperparameterTuningJob is not deleted; instead it becomes a job with a HyperparameterTuningJob.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`, and HyperparameterTuningJob.state is set to `CANCELLED`.
▼ ▲ aiplatform.projects.locations.hyperparameterTuningJobs.get
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+/hyperparameterTuningJobs/[^/]+$
Type: string
Required: Yes
Description: Required. The name of the HyperparameterTuningJob resource. Format: `projects/{project}/locations/{location}/hyperparameterTuningJobs/{hyperparameter_tuning_job}`
Location: path
Path: v1beta1/{+name}
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs/{hyperparameterTuningJobsId}
Description: Gets a HyperparameterTuningJob
HTTP Method: GET
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
▼ ▲ aiplatform.projects.locations.hyperparameterTuningJobs.operations.list
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
HTTP Method: GET
Parameters:
pageToken
Description: The standard list page token.
Location: query
Type: string
filter
Description: The standard list filter.
Location: query
Type: string
pageSize
Description: The standard list page size.
Location: query
Type: integer
Format: int32
name
Description: The name of the operation's parent resource.
Required: Yes
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/hyperparameterTuningJobs/[^/]+$
Location: path
Path: v1beta1/{+name}/operations
Description: Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs/{hyperparameterTuningJobsId}/operations
▼ ▲ aiplatform.projects.locations.hyperparameterTuningJobs.operations.cancel
Path: v1beta1/{+name}: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
Description: The name of the operation resource to be cancelled.
Required: Yes
Location: path
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/hyperparameterTuningJobs/[^/]+/operations/[^/]+$
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs/{hyperparameterTuningJobsId}/operations/{operationsId}:cancel
▼ ▲ aiplatform.projects.locations.hyperparameterTuningJobs.operations.get
Path: v1beta1/{+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.
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: GET
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs/{hyperparameterTuningJobsId}/operations/{operationsId}
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+/hyperparameterTuningJobs/[^/]+/operations/[^/]+$
Location: path
Required: Yes
Description: The name of the operation resource.
Type: string
▼ ▲ aiplatform.projects.locations.hyperparameterTuningJobs.operations.delete
HTTP Method: 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`.
Parameters:
name
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/hyperparameterTuningJobs/[^/]+/operations/[^/]+$
Location: path
Type: string
Description: The name of the operation resource to be deleted.
Parameter Order: name
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs/{hyperparameterTuningJobsId}/operations/{operationsId}
Path: v1beta1/{+name}
▼ ▲ aiplatform.projects.locations.hyperparameterTuningJobs.operations.wait
Path: v1beta1/{+name}:wait
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs/{hyperparameterTuningJobsId}/operations/{operationsId}:wait
HTTP Method: POST
Description: Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
timeout
Format: google-duration
Type: string
Description: The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
Location: query
name
Type: string
Description: The name of the operation resource to wait on.
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/hyperparameterTuningJobs/[^/]+/operations/[^/]+$
Required: Yes
▼ ▲ aiplatform.projects.locations.trainingPipelines.create
HTTP Method: POST
Parameter Order: parent
Description: Creates a TrainingPipeline. A created TrainingPipeline right away will be attempted to be run.
Parameters:
parent
Description: Required. The resource name of the Location to create the TrainingPipeline in. Format: `projects/{project}/locations/{location}`
Type: string
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+$
Location: path
Path: v1beta1/{+parent}/trainingPipelines
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/trainingPipelines
▼ ▲ aiplatform.projects.locations.trainingPipelines.delete
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}
HTTP Method: DELETE
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Deletes a TrainingPipeline.
Parameters:
name
Location: path
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/trainingPipelines/[^/]+$
Description: Required. The name of the TrainingPipeline resource to be deleted. Format: `projects/{project}/locations/{location}/trainingPipelines/{training_pipeline}`
Required: Yes
Path: v1beta1/{+name}
Parameter Order: name
▼ ▲ aiplatform.projects.locations.trainingPipelines.list
Description: Lists TrainingPipelines in a Location.
Parameters:
parent
Description: Required. The resource name of the Location to list the TrainingPipelines from. Format: `projects/{project}/locations/{location}`
Location: path
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+$
Type: string
filter
Location: query
Description: The standard list filter. Supported fields: * `display_name` supports `=`, `!=` comparisons, and `:` wildcard. * `state` supports `=`, `!=` comparisons. * `training_task_definition` `=`, `!=` comparisons, and `:` wildcard. * `create_time` supports `=`, `!=`,`<`, `<=`,`>`, `>=` comparisons. `create_time` must be in RFC 3339 format. * `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* - key existence Some examples of using the filter are: * `state="PIPELINE_STATE_SUCCEEDED" AND display_name:"my_pipeline_*"` * `state!="PIPELINE_STATE_FAILED" OR display_name="my_pipeline"` * `NOT display_name="my_pipeline"` * `create_time>"2021-05-18T00:00:00Z"` * `training_task_definition:"*automl_text_classification*"`
Type: string
readMask
Description: Mask specifying which fields to read.
Format: google-fieldmask
Type: string
Location: query
pageToken
Description: The standard list page token. Typically obtained via ListTrainingPipelinesResponse.next_page_token of the previous PipelineService.ListTrainingPipelines call.
Type: string
Location: query
pageSize
Type: integer
Format: int32
Description: The standard list page size.
Location: query
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/trainingPipelines
Parameter Order: parent
Path: v1beta1/{+parent}/trainingPipelines
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: GET
▼ ▲ aiplatform.projects.locations.trainingPipelines.cancel
Parameters:
name
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/trainingPipelines/[^/]+$
Location: path
Description: Required. The name of the TrainingPipeline to cancel. Format: `projects/{project}/locations/{location}/trainingPipelines/{training_pipeline}`
Required: Yes
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Cancels a TrainingPipeline. Starts asynchronous cancellation on the TrainingPipeline. The server makes a best effort to cancel the pipeline, but success is not guaranteed. Clients can use PipelineService.GetTrainingPipeline or other methods to check whether the cancellation succeeded or whether the pipeline completed despite cancellation. On successful cancellation, the TrainingPipeline is not deleted; instead it becomes a pipeline with a TrainingPipeline.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`, and TrainingPipeline.state is set to `CANCELLED`.
HTTP Method: POST
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}:cancel
Path: v1beta1/{+name}:cancel
▼ ▲ aiplatform.projects.locations.trainingPipelines.get
Description: Gets a TrainingPipeline.
Parameter Order: name
HTTP Method: GET
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1beta1/{+name}
Parameters:
name
Type: string
Description: Required. The name of the TrainingPipeline resource. Format: `projects/{project}/locations/{location}/trainingPipelines/{training_pipeline}`
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/trainingPipelines/[^/]+$
Required: Yes
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}
▼ ▲ aiplatform.projects.locations.trainingPipelines.operations.get
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}/operations/{operationsId}
Parameter Order: name
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+/trainingPipelines/[^/]+/operations/[^/]+$
Type: string
Description: The name of the operation resource.
Location: path
Required: Yes
HTTP Method: GET
Path: v1beta1/{+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.
▼ ▲ aiplatform.projects.locations.trainingPipelines.operations.delete
Parameters:
name
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/trainingPipelines/[^/]+/operations/[^/]+$
Required: Yes
Location: path
Description: The name of the operation resource to be deleted.
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}/operations/{operationsId}
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1beta1/{+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`.
Parameter Order: name
HTTP Method: DELETE
▼ ▲ aiplatform.projects.locations.trainingPipelines.operations.wait
Description: Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}/operations/{operationsId}:wait
HTTP Method: POST
Parameter Order: name
Path: v1beta1/{+name}:wait
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
name
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/trainingPipelines/[^/]+/operations/[^/]+$
Description: The name of the operation resource to wait on.
Required: Yes
Location: path
timeout
Type: string
Location: query
Format: google-duration
Description: The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
▼ ▲ aiplatform.projects.locations.trainingPipelines.operations.cancel
Path: v1beta1/{+name}: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`.
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}/operations/{operationsId}:cancel
HTTP Method: POST
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+/trainingPipelines/[^/]+/operations/[^/]+$
Description: The name of the operation resource to be cancelled.
Location: path
Required: Yes
Type: string
▼ ▲ aiplatform.projects.locations.trainingPipelines.operations.list
HTTP Method: GET
Parameters:
filter
Description: The standard list filter.
Location: query
Type: string
pageSize
Location: query
Type: integer
Format: int32
Description: The standard list page size.
pageToken
Type: string
Description: The standard list page token.
Location: query
name
Description: The name of the operation's parent resource.
Type: string
Location: path
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/trainingPipelines/[^/]+$
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}/operations
Parameter Order: name
Description: Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
Path: v1beta1/{+name}/operations
▼ ▲ aiplatform.projects.locations.studies.trials.operations.delete
Path: v1beta1/{+name}
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+/operations/[^/]+$
Type: string
Location: path
Required: Yes
Description: The name of the operation resource to be deleted.
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}/operations/{operationsId}
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: 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`.
▼ ▲ aiplatform.projects.locations.studies.trials.operations.wait
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
HTTP Method: POST
Parameters:
timeout
Type: string
Description: The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
Location: query
Format: google-duration
name
Pattern: ^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+/operations/[^/]+$
Type: string
Location: path
Required: Yes
Description: The name of the operation resource to wait on.
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}/operations/{operationsId}:wait
Path: v1beta1/{+name}:wait
▼ ▲ aiplatform.projects.locations.studies.trials.operations.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.
Path: v1beta1/{+name}
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}/operations/{operationsId}
Parameters:
name
Type: string
Description: The name of the operation resource.
Location: path
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+/operations/[^/]+$
HTTP Method: GET
▼ ▲ aiplatform.projects.locations.studies.trials.operations.list
HTTP Method: GET
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1beta1/{+name}/operations
Parameters:
pageToken
Description: The standard list page token.
Location: query
Type: string
name
Description: The name of the operation's parent resource.
Required: Yes
Type: string
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+$
filter
Type: string
Location: query
Description: The standard list filter.
pageSize
Format: int32
Description: The standard list page size.
Location: query
Type: integer
Description: Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}/operations
▼ ▲ aiplatform.projects.locations.studies.trials.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`.
Parameters:
name
Description: The name of the operation resource to be cancelled.
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+/operations/[^/]+$
Location: path
Required: Yes
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}/operations/{operationsId}:cancel
HTTP Method: POST
Parameter Order: name
Path: v1beta1/{+name}:cancel
▼ ▲ aiplatform.projects.locations.studies.trials.create
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials
Parameters:
parent
Type: string
Description: Required. The resource name of the Study to create the Trial in. Format: `projects/{project}/locations/{location}/studies/{study}`
Required: Yes
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/studies/[^/]+$
Description: Adds a user provided Trial to a Study.
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1beta1/{+parent}/trials
HTTP Method: POST
Parameter Order: parent
▼ ▲ aiplatform.projects.locations.studies.trials.get
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+$
Location: path
Type: string
Description: Required. The name of the Trial resource. Format: `projects/{project}/locations/{location}/studies/{study}/trials/{trial}`
Required: Yes
HTTP Method: GET
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}
Description: Gets a Trial.
Path: v1beta1/{+name}
▼ ▲ aiplatform.projects.locations.studies.trials.suggest
HTTP Method: POST
Description: Adds one or more Trials to a Study, with parameter values suggested by Vertex AI Vizier. Returns a long-running operation associated with the generation of Trial suggestions. When this long-running operation succeeds, it will contain a SuggestTrialsResponse.
Parameters:
parent
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/studies/[^/]+$
Location: path
Description: Required. The project and location that the Study belongs to. Format: `projects/{project}/locations/{location}/studies/{study}`
Required: Yes
Path: v1beta1/{+parent}/trials:suggest
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials:suggest
Parameter Order: parent
▼ ▲ aiplatform.projects.locations.studies.trials.complete
HTTP Method: POST
Parameter Order: name
Path: v1beta1/{+name}:complete
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+$
Required: Yes
Type: string
Description: Required. The Trial's name. Format: `projects/{project}/locations/{location}/studies/{study}/trials/{trial}`
Location: path
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}:complete
Description: Marks a Trial as complete.
▼ ▲ aiplatform.projects.locations.studies.trials.listOptimalTrials
Parameters:
parent
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/studies/[^/]+$
Description: Required. The name of the Study that the optimal Trial belongs to.
Type: string
Location: path
Path: v1beta1/{+parent}/trials:listOptimalTrials
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials:listOptimalTrials
HTTP Method: POST
Description: Lists the pareto-optimal Trials for multi-objective Study or the optimal Trials for single-objective Study. The definition of pareto-optimal can be checked in wiki page. https://en.wikipedia.org/wiki/Pareto_efficiency
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: parent
▼ ▲ aiplatform.projects.locations.studies.trials.list
Path: v1beta1/{+parent}/trials
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials
Parameters:
pageSize
Type: integer
Description: Optional. The number of Trials to retrieve per "page" of results. If unspecified, the service will pick an appropriate default.
Format: int32
Location: query
parent
Location: path
Type: string
Description: Required. The resource name of the Study to list the Trial from. Format: `projects/{project}/locations/{location}/studies/{study}`
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/studies/[^/]+$
pageToken
Description: Optional. A page token to request the next page of results. If unspecified, there are no subsequent pages.
Type: string
Location: query
Parameter Order: parent
HTTP Method: GET
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Lists the Trials associated with a Study.
▼ ▲ aiplatform.projects.locations.studies.trials.stop
HTTP Method: POST
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Stops a Trial.
Parameter Order: name
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}:stop
Parameters:
name
Type: string
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+$
Required: Yes
Description: Required. The Trial's name. Format: `projects/{project}/locations/{location}/studies/{study}/trials/{trial}`
Path: v1beta1/{+name}:stop
▼ ▲ aiplatform.projects.locations.studies.trials.checkTrialEarlyStoppingState
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: POST
Path: v1beta1/{+trialName}:checkTrialEarlyStoppingState
Parameter Order: trialName
Parameters:
trialName
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+$
Required: Yes
Location: path
Description: Required. The Trial's name. Format: `projects/{project}/locations/{location}/studies/{study}/trials/{trial}`
Description: Checks whether a Trial should stop or not. Returns a long-running operation. When the operation is successful, it will contain a CheckTrialEarlyStoppingStateResponse.
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}:checkTrialEarlyStoppingState
▼ ▲ aiplatform.projects.locations.studies.trials.addTrialMeasurement
Path: v1beta1/{+trialName}:addTrialMeasurement
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}:addTrialMeasurement
Parameters:
trialName
Type: string
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+$
Required: Yes
Description: Required. The name of the trial to add measurement. Format: `projects/{project}/locations/{location}/studies/{study}/trials/{trial}`
HTTP Method: POST
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Adds a measurement of the objective metrics to a Trial. This measurement is assumed to have been taken before the Trial is complete.
Parameter Order: trialName
▼ ▲ aiplatform.projects.locations.studies.trials.delete
Parameters:
name
Type: string
Description: Required. The Trial's name. Format: `projects/{project}/locations/{location}/studies/{study}/trials/{trial}`
Required: Yes
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+$
Path: v1beta1/{+name}
Description: Deletes a Trial.
Parameter Order: name
HTTP Method: DELETE
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}
▼ ▲ aiplatform.projects.locations.studies.operations.cancel
HTTP Method: POST
Path: v1beta1/{+name}:cancel
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
name
Required: Yes
Description: The name of the operation resource to be cancelled.
Pattern: ^projects/[^/]+/locations/[^/]+/studies/[^/]+/operations/[^/]+$
Type: string
Location: path
Parameter Order: name
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/operations/{operationsId}: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`.
▼ ▲ aiplatform.projects.locations.studies.operations.get
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: GET
Path: v1beta1/{+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.
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/operations/{operationsId}
Parameter Order: name
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+/studies/[^/]+/operations/[^/]+$
Required: Yes
Description: The name of the operation resource.
Type: string
Location: path
▼ ▲ aiplatform.projects.locations.studies.operations.list
Description: Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
Path: v1beta1/{+name}/operations
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/operations
Parameters:
name
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/studies/[^/]+$
Description: The name of the operation's parent resource.
Location: path
Type: string
filter
Description: The standard list filter.
Type: string
Location: query
pageSize
Location: query
Format: int32
Description: The standard list page size.
Type: integer
pageToken
Type: string
Description: The standard list page token.
Location: query
HTTP Method: GET
Parameter Order: name
▼ ▲ aiplatform.projects.locations.studies.operations.wait
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/operations/{operationsId}:wait
Path: v1beta1/{+name}:wait
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: POST
Parameters:
timeout
Location: query
Format: google-duration
Type: string
Description: The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
name
Location: path
Type: string
Description: The name of the operation resource to wait on.
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/studies/[^/]+/operations/[^/]+$
Description: Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
Parameter Order: name
▼ ▲ aiplatform.projects.locations.studies.operations.delete
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/operations/{operationsId}
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+/studies/[^/]+/operations/[^/]+$
Description: The name of the operation resource to be deleted.
Required: Yes
Type: string
Location: path
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: DELETE
Path: v1beta1/{+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`.
Parameter Order: name
▼ ▲ aiplatform.projects.locations.studies.lookup
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/studies:lookup
Description: Looks a study up using the user-defined display_name field instead of the fully qualified resource name.
Parameters:
parent
Description: Required. The resource name of the Location to get the Study from. Format: `projects/{project}/locations/{location}`
Type: string
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+$
Required: Yes
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1beta1/{+parent}/studies:lookup
HTTP Method: POST
Parameter Order: parent
▼ ▲ aiplatform.projects.locations.studies.list
HTTP Method: GET
Description: Lists all the studies in a region for an associated project.
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1beta1/{+parent}/studies
Parameters:
parent
Description: Required. The resource name of the Location to list the Study from. Format: `projects/{project}/locations/{location}`
Required: Yes
Location: path
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+$
pageToken
Location: query
Description: Optional. A page token to request the next page of results. If unspecified, there are no subsequent pages.
Type: string
pageSize
Location: query
Format: int32
Type: integer
Description: Optional. The maximum number of studies to return per "page" of results. If unspecified, service will pick an appropriate default.
Parameter Order: parent
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/studies
▼ ▲ aiplatform.projects.locations.studies.get
HTTP Method: GET
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
Path: v1beta1/{+name}
Parameters:
name
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/studies/[^/]+$
Location: path
Type: string
Description: Required. The name of the Study resource. Format: `projects/{project}/locations/{location}/studies/{study}`
Description: Gets a Study by name.
▼ ▲ aiplatform.projects.locations.studies.delete
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1beta1/{+name}
Parameter Order: name
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}
Description: Deletes a Study.
Parameters:
name
Type: string
Description: Required. The name of the Study resource to be deleted. Format: `projects/{project}/locations/{location}/studies/{study}`
Pattern: ^projects/[^/]+/locations/[^/]+/studies/[^/]+$
Required: Yes
Location: path
HTTP Method: DELETE
▼ ▲ aiplatform.projects.locations.studies.create
Parameter Order: parent
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/studies
Parameters:
parent
Location: path
Description: Required. The resource name of the Location to create the CustomJob in. Format: `projects/{project}/locations/{location}`
Type: string
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+$
Path: v1beta1/{+parent}/studies
Description: Creates a Study. A resource name will be generated after creation of the Study.
HTTP Method: POST
▼ ▲ aiplatform.projects.locations.operations.get
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: GET
Parameters:
name
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/operations/[^/]+$
Location: path
Required: Yes
Description: The name of the operation resource.
Path: v1beta1/{+name}
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}
Parameter Order: 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.
▼ ▲ aiplatform.projects.locations.operations.wait
Path: v1beta1/{+name}:wait
HTTP Method: POST
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:wait
Parameter Order: name
Parameters:
timeout
Description: The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
Type: string
Location: query
Format: google-duration
name
Location: path
Type: string
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/operations/[^/]+$
Description: The name of the operation resource to wait on.
Description: Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
▼ ▲ aiplatform.projects.locations.operations.cancel
Parameters:
name
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/operations/[^/]+$
Required: Yes
Description: The name of the operation resource to be cancelled.
Type: string
Parameter Order: name
HTTP Method: POST
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: v1beta1/{+name}:cancel
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel
▼ ▲ aiplatform.projects.locations.operations.delete
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: DELETE
Parameter Order: name
Path: v1beta1/{+name}
Parameters:
name
Required: Yes
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/operations/[^/]+$
Description: The name of the operation resource to be deleted.
Type: string
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`.
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}
▼ ▲ aiplatform.projects.locations.operations.list
Parameters:
name
Type: string
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+$
Description: The name of the operation's parent resource.
Location: path
filter
Location: query
Description: The standard list filter.
Type: string
pageToken
Description: The standard list page token.
Location: query
Type: string
pageSize
Type: integer
Format: int32
Location: query
Description: The standard list page size.
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/operations
Description: Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
Path: v1beta1/{+name}/operations
HTTP Method: GET
▼ ▲ aiplatform.projects.locations.indexEndpoints.patch
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}
HTTP Method: PATCH
Path: v1beta1/{+name}
Parameters:
updateMask
Format: google-fieldmask
Description: Required. The update mask applies to the resource. See google.protobuf.FieldMask.
Type: string
Location: query
name
Description: Output only. The resource name of the IndexEndpoint.
Pattern: ^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+$
Type: string
Location: path
Required: Yes
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
Description: Updates an IndexEndpoint.
▼ ▲ aiplatform.projects.locations.indexEndpoints.get
Path: v1beta1/{+name}
HTTP Method: GET
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+$
Required: Yes
Description: Required. The name of the IndexEndpoint resource. Format: `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}`
Type: string
Location: path
Description: Gets an IndexEndpoint.
Parameter Order: name
▼ ▲ aiplatform.projects.locations.indexEndpoints.delete
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}
Parameters:
name
Required: Yes
Location: path
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+$
Description: Required. The name of the IndexEndpoint resource to be deleted. Format: `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}`
HTTP Method: DELETE
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1beta1/{+name}
Description: Deletes an IndexEndpoint.
Parameter Order: name
▼ ▲ aiplatform.projects.locations.indexEndpoints.deployIndex
Parameters:
indexEndpoint
Required: Yes
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+$
Description: Required. The name of the IndexEndpoint resource into which to deploy an Index. Format: `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}`
Type: string
Parameter Order: indexEndpoint
Description: Deploys an Index into this IndexEndpoint, creating a DeployedIndex within it. Only non-empty Indexes can be deployed.
Path: v1beta1/{+indexEndpoint}:deployIndex
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}:deployIndex
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: POST
▼ ▲ aiplatform.projects.locations.indexEndpoints.findNeighbors
Parameters:
indexEndpoint
Required: Yes
Description: Required. The name of the index endpoint. Format: `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}`
Type: string
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+$
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Finds the nearest neighbors of each vector within the request.
Parameter Order: indexEndpoint
Path: v1beta1/{+indexEndpoint}:findNeighbors
HTTP Method: POST
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}:findNeighbors
▼ ▲ aiplatform.projects.locations.indexEndpoints.undeployIndex
Description: Undeploys an Index from an IndexEndpoint, removing a DeployedIndex from it, and freeing all resources it's using.
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}:undeployIndex
Path: v1beta1/{+indexEndpoint}:undeployIndex
HTTP Method: POST
Parameters:
indexEndpoint
Description: Required. The name of the IndexEndpoint resource from which to undeploy an Index. Format: `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}`
Location: path
Type: string
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+$
Parameter Order: indexEndpoint
▼ ▲ aiplatform.projects.locations.indexEndpoints.mutateDeployedIndex
Parameters:
indexEndpoint
Description: Required. The name of the IndexEndpoint resource into which to deploy an Index. Format: `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}`
Location: path
Type: string
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+$
HTTP Method: POST
Parameter Order: indexEndpoint
Description: Update an existing DeployedIndex under an IndexEndpoint.
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}:mutateDeployedIndex
Path: v1beta1/{+indexEndpoint}:mutateDeployedIndex
▼ ▲ aiplatform.projects.locations.indexEndpoints.readIndexDatapoints
Description: Reads the datapoints/vectors of the given IDs. A maximum of 1000 datapoints can be retrieved in a batch.
Path: v1beta1/{+indexEndpoint}:readIndexDatapoints
HTTP Method: POST
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}:readIndexDatapoints
Parameter Order: indexEndpoint
Parameters:
indexEndpoint
Location: path
Description: Required. The name of the index endpoint. Format: `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}`
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+$
Type: string
▼ ▲ aiplatform.projects.locations.indexEndpoints.create
Parameters:
parent
Description: Required. The resource name of the Location to create the IndexEndpoint in. Format: `projects/{project}/locations/{location}`
Pattern: ^projects/[^/]+/locations/[^/]+$
Location: path
Required: Yes
Type: string
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: parent
Description: Creates an IndexEndpoint.
Path: v1beta1/{+parent}/indexEndpoints
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/indexEndpoints
HTTP Method: POST
▼ ▲ aiplatform.projects.locations.indexEndpoints.list
Description: Lists IndexEndpoints in a Location.
Parameter Order: parent
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/indexEndpoints
HTTP Method: GET
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
readMask
Location: query
Description: Optional. Mask specifying which fields to read.
Type: string
Format: google-fieldmask
filter
Description: Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `index_endpoint` supports = and !=. `index_endpoint` represents the IndexEndpoint ID, ie. the last segment of the IndexEndpoint's resourcename. * `display_name` supports =, != and regex() (uses [re2](https://github.com/google/re2/wiki/Syntax) syntax) * `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: * `index_endpoint="1"` * `display_name="myDisplayName"` * `regex(display_name, "^A") -> The display name starts with an A. * `labels.myKey="myValue"`
Location: query
Type: string
pageSize
Description: Optional. The standard list page size.
Type: integer
Location: query
Format: int32
parent
Required: Yes
Description: Required. The resource name of the Location from which to list the IndexEndpoints. Format: `projects/{project}/locations/{location}`
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+$
Location: path
pageToken
Type: string
Description: Optional. The standard list page token. Typically obtained via ListIndexEndpointsResponse.next_page_token of the previous IndexEndpointService.ListIndexEndpoints call.
Location: query
Path: v1beta1/{+parent}/indexEndpoints
▼ ▲ aiplatform.projects.locations.indexEndpoints.operations.delete
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1beta1/{+name}
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}/operations/{operationsId}
HTTP Method: 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`.
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+/operations/[^/]+$
Location: path
Description: The name of the operation resource to be deleted.
Type: string
Required: Yes
Parameter Order: name
▼ ▲ aiplatform.projects.locations.indexEndpoints.operations.wait
Path: v1beta1/{+name}:wait
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}/operations/{operationsId}:wait
Description: Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: POST
Parameters:
timeout
Location: query
Format: google-duration
Description: The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
Type: string
name
Type: string
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+/operations/[^/]+$
Description: The name of the operation resource to wait on.
Location: path
▼ ▲ aiplatform.projects.locations.indexEndpoints.operations.get
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}/operations/{operationsId}
Parameter Order: 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.
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+/operations/[^/]+$
Required: Yes
Type: string
Location: path
Description: The name of the operation resource.
Path: v1beta1/{+name}
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: GET
▼ ▲ aiplatform.projects.locations.indexEndpoints.operations.cancel
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: POST
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`.
Parameters:
name
Required: Yes
Type: string
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+/operations/[^/]+$
Description: The name of the operation resource to be cancelled.
Path: v1beta1/{+name}:cancel
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}/operations/{operationsId}:cancel
▼ ▲ aiplatform.projects.locations.indexEndpoints.operations.list
Description: Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
HTTP Method: GET
Parameters:
pageSize
Description: The standard list page size.
Type: integer
Location: query
Format: int32
filter
Description: The standard list filter.
Type: string
Location: query
pageToken
Location: query
Type: string
Description: The standard list page token.
name
Type: string
Required: Yes
Description: The name of the operation's parent resource.
Pattern: ^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+$
Location: path
Parameter Order: name
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}/operations
Path: v1beta1/{+name}/operations
▼ ▲ aiplatform.projects.locations.nasJobs.nasTrialDetails.list
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1beta1/{+parent}/nasTrialDetails
Description: List top NasTrialDetails of a NasJob.
Parameters:
pageSize
Format: int32
Type: integer
Description: The standard list page size.
Location: query
pageToken
Description: The standard list page token. Typically obtained via ListNasTrialDetailsResponse.next_page_token of the previous JobService.ListNasTrialDetails call.
Location: query
Type: string
parent
Location: path
Type: string
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/nasJobs/[^/]+$
Description: Required. The name of the NasJob resource. Format: `projects/{project}/locations/{location}/nasJobs/{nas_job}`
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/nasJobs/{nasJobsId}/nasTrialDetails
HTTP Method: GET
▼ ▲ aiplatform.projects.locations.nasJobs.nasTrialDetails.get
HTTP Method: GET
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/nasJobs/{nasJobsId}/nasTrialDetails/{nasTrialDetailsId}
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Gets a NasTrialDetail.
Path: v1beta1/{+name}
Parameter Order: name
Parameters:
name
Required: Yes
Location: path
Description: Required. The name of the NasTrialDetail resource. Format: `projects/{project}/locations/{location}/nasJobs/{nas_job}/nasTrialDetails/{nas_trial_detail}`
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/nasJobs/[^/]+/nasTrialDetails/[^/]+$
▼ ▲ aiplatform.projects.locations.nasJobs.list
HTTP Method: GET
Description: Lists NasJobs in a Location.
Parameter Order: parent
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/nasJobs
Parameters:
pageSize
Format: int32
Description: The standard list page size.
Location: query
Type: integer
pageToken
Description: The standard list page token. Typically obtained via ListNasJobsResponse.next_page_token of the previous JobService.ListNasJobs call.
Location: query
Type: string
readMask
Type: string
Format: google-fieldmask
Location: query
Description: Mask specifying which fields to read.
parent
Location: path
Required: Yes
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+$
Description: Required. The resource name of the Location to list the NasJobs from. Format: `projects/{project}/locations/{location}`
filter
Type: string
Location: query
Description: The standard list filter. Supported fields: * `display_name` supports `=`, `!=` comparisons, and `:` wildcard. * `state` supports `=`, `!=` comparisons. * `create_time` supports `=`, `!=`,`<`, `<=`,`>`, `>=` comparisons. `create_time` must be in RFC 3339 format. * `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* - key existence Some examples of using the filter are: * `state="JOB_STATE_SUCCEEDED" AND display_name:"my_job_*"` * `state!="JOB_STATE_FAILED" OR display_name="my_job"` * `NOT display_name="my_job"` * `create_time>"2021-05-18T00:00:00Z"` * `labels.keyA=valueA` * `labels.keyB:*`
Path: v1beta1/{+parent}/nasJobs
▼ ▲ aiplatform.projects.locations.nasJobs.delete
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Deletes a NasJob.
Path: v1beta1/{+name}
Parameter Order: name
HTTP Method: DELETE
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+/nasJobs/[^/]+$
Description: Required. The name of the NasJob resource to be deleted. Format: `projects/{project}/locations/{location}/nasJobs/{nas_job}`
Location: path
Required: Yes
Type: string
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/nasJobs/{nasJobsId}
▼ ▲ aiplatform.projects.locations.nasJobs.create
Parameter Order: parent
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/nasJobs
Parameters:
parent
Location: path
Description: Required. The resource name of the Location to create the NasJob in. Format: `projects/{project}/locations/{location}`
Pattern: ^projects/[^/]+/locations/[^/]+$
Type: string
Required: Yes
Path: v1beta1/{+parent}/nasJobs
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Creates a NasJob
HTTP Method: POST
▼ ▲ aiplatform.projects.locations.nasJobs.cancel
Path: v1beta1/{+name}:cancel
Parameters:
name
Required: Yes
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/nasJobs/[^/]+$
Description: Required. The name of the NasJob to cancel. Format: `projects/{project}/locations/{location}/nasJobs/{nas_job}`
Type: string
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/nasJobs/{nasJobsId}:cancel
HTTP Method: POST
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Cancels a NasJob. Starts asynchronous cancellation on the NasJob. The server makes a best effort to cancel the job, but success is not guaranteed. Clients can use JobService.GetNasJob or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On successful cancellation, the NasJob is not deleted; instead it becomes a job with a NasJob.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`, and NasJob.state is set to `CANCELLED`.
▼ ▲ aiplatform.projects.locations.nasJobs.get
Description: Gets a NasJob
Path: v1beta1/{+name}
Scopes:
HTTP Method: GET
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/nasJobs/{nasJobsId}
Parameters:
name
Description: Required. The name of the NasJob resource. Format: `projects/{project}/locations/{location}/nasJobs/{nas_job}`
Pattern: ^projects/[^/]+/locations/[^/]+/nasJobs/[^/]+$
Required: Yes
Type: string
Location: path
Parameter Order: name
▼ ▲ aiplatform.projects.locations.datasets.annotationSpecs.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: v1beta1/{+name}/operations
HTTP Method: GET
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/annotationSpecs/{annotationSpecsId}/operations
Parameters:
pageToken
Location: query
Description: The standard list page token.
Type: string
pageSize
Description: The standard list page size.
Location: query
Format: int32
Type: integer
filter
Location: query
Description: The standard list filter.
Type: string
name
Required: Yes
Description: The name of the operation's parent resource.
Location: path
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/datasets/[^/]+/annotationSpecs/[^/]+$
▼ ▲ aiplatform.projects.locations.datasets.annotationSpecs.operations.delete
Parameters:
name
Location: path
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/datasets/[^/]+/annotationSpecs/[^/]+/operations/[^/]+$
Description: The name of the operation resource to be deleted.
Type: string
Path: v1beta1/{+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`.
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/annotationSpecs/{annotationSpecsId}/operations/{operationsId}
HTTP Method: DELETE
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
▼ ▲ aiplatform.projects.locations.datasets.annotationSpecs.operations.wait
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/annotationSpecs/{annotationSpecsId}/operations/{operationsId}:wait
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1beta1/{+name}:wait
HTTP Method: POST
Parameter Order: name
Description: Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
Parameters:
name
Location: path
Description: The name of the operation resource to wait on.
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/datasets/[^/]+/annotationSpecs/[^/]+/operations/[^/]+$
Required: Yes
timeout
Format: google-duration
Location: query
Description: The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
Type: string
▼ ▲ aiplatform.projects.locations.datasets.annotationSpecs.operations.get
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: 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.
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/annotationSpecs/{annotationSpecsId}/operations/{operationsId}
Path: v1beta1/{+name}
HTTP Method: GET
Parameters:
name
Type: string
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/datasets/[^/]+/annotationSpecs/[^/]+/operations/[^/]+$
Required: Yes
Description: The name of the operation resource.
▼ ▲ aiplatform.projects.locations.datasets.annotationSpecs.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`.
Parameter Order: name
Path: v1beta1/{+name}:cancel
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+/datasets/[^/]+/annotationSpecs/[^/]+/operations/[^/]+$
Description: The name of the operation resource to be cancelled.
Type: string
Required: Yes
Location: path
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/annotationSpecs/{annotationSpecsId}/operations/{operationsId}:cancel
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: POST
▼ ▲ aiplatform.projects.locations.datasets.annotationSpecs.get
Parameters:
readMask
Type: string
Location: query
Format: google-fieldmask
Description: Mask specifying which fields to read.
name
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/datasets/[^/]+/annotationSpecs/[^/]+$
Location: path
Type: string
Description: Required. The name of the AnnotationSpec resource. Format: `projects/{project}/locations/{location}/datasets/{dataset}/annotationSpecs/{annotation_spec}`
Path: v1beta1/{+name}
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/annotationSpecs/{annotationSpecsId}
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: GET
Description: Gets an AnnotationSpec.
Parameter Order: name
▼ ▲ aiplatform.projects.locations.datasets.dataItems.annotations.operations.delete
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dataItems/[^/]+/annotations/[^/]+/operations/[^/]+$
Required: Yes
Type: string
Location: path
Description: The name of the operation resource to be deleted.
Parameter Order: 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`.
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/annotations/{annotationsId}/operations/{operationsId}
Path: v1beta1/{+name}
HTTP Method: DELETE
▼ ▲ aiplatform.projects.locations.datasets.dataItems.annotations.operations.cancel
HTTP Method: POST
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`.
Parameter Order: name
Parameters:
name
Required: Yes
Description: The name of the operation resource to be cancelled.
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dataItems/[^/]+/annotations/[^/]+/operations/[^/]+$
Location: path
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/annotations/{annotationsId}/operations/{operationsId}:cancel
Path: v1beta1/{+name}:cancel
▼ ▲ aiplatform.projects.locations.datasets.dataItems.annotations.operations.list
HTTP Method: GET
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/annotations/{annotationsId}/operations
Parameter Order: name
Parameters:
name
Description: The name of the operation's parent resource.
Type: string
Location: path
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dataItems/[^/]+/annotations/[^/]+$
pageToken
Location: query
Type: string
Description: The standard list page token.
filter
Description: The standard list filter.
Location: query
Type: string
pageSize
Description: The standard list page size.
Type: integer
Location: query
Format: int32
Description: Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
Path: v1beta1/{+name}/operations
▼ ▲ aiplatform.projects.locations.datasets.dataItems.annotations.operations.wait
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dataItems/[^/]+/annotations/[^/]+/operations/[^/]+$
Location: path
Type: string
Required: Yes
Description: The name of the operation resource to wait on.
timeout
Location: query
Format: google-duration
Type: string
Description: The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1beta1/{+name}:wait
Description: Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/annotations/{annotationsId}/operations/{operationsId}:wait
HTTP Method: POST
▼ ▲ aiplatform.projects.locations.datasets.dataItems.annotations.operations.get
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1beta1/{+name}
Parameter Order: name
HTTP Method: GET
Parameters:
name
Type: string
Description: The name of the operation resource.
Location: path
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dataItems/[^/]+/annotations/[^/]+/operations/[^/]+$
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.
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/annotations/{annotationsId}/operations/{operationsId}
▼ ▲ aiplatform.projects.locations.datasets.dataItems.annotations.list
Parameters:
pageToken
Type: string
Location: query
Description: The standard list page token.
orderBy
Type: string
Location: query
Description: A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending.
readMask
Description: Mask specifying which fields to read.
Type: string
Format: google-fieldmask
Location: query
parent
Pattern: ^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dataItems/[^/]+$
Location: path
Type: string
Required: Yes
Description: Required. The resource name of the DataItem to list Annotations from. Format: `projects/{project}/locations/{location}/datasets/{dataset}/dataItems/{data_item}`
filter
Description: The standard list filter.
Type: string
Location: query
pageSize
Format: int32
Description: The standard list page size.
Type: integer
Location: query
Parameter Order: parent
Description: Lists Annotations belongs to a dataitem
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/annotations
Path: v1beta1/{+parent}/annotations
HTTP Method: GET
▼ ▲ aiplatform.projects.locations.datasets.dataItems.operations.get
Parameters:
name
Description: The name of the operation resource.
Type: string
Location: path
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dataItems/[^/]+/operations/[^/]+$
Parameter Order: 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.
Path: v1beta1/{+name}
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/operations/{operationsId}
HTTP Method: GET
▼ ▲ aiplatform.projects.locations.datasets.dataItems.operations.list
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
pageSize
Format: int32
Type: integer
Description: The standard list page size.
Location: query
pageToken
Description: The standard list page token.
Location: query
Type: string
filter
Type: string
Description: The standard list filter.
Location: query
name
Description: The name of the operation's parent resource.
Required: Yes
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dataItems/[^/]+$
Type: string
Parameter Order: name
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/operations
Path: v1beta1/{+name}/operations
Description: Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
HTTP Method: GET
▼ ▲ aiplatform.projects.locations.datasets.dataItems.operations.wait
HTTP Method: POST
Parameters:
name
Required: Yes
Location: path
Type: string
Description: The name of the operation resource to wait on.
Pattern: ^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dataItems/[^/]+/operations/[^/]+$
timeout
Type: string
Format: google-duration
Description: The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
Location: query
Description: Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/operations/{operationsId}:wait
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1beta1/{+name}:wait
Parameter Order: name
▼ ▲ aiplatform.projects.locations.datasets.dataItems.operations.cancel
Parameters:
name
Required: Yes
Type: string
Location: path
Description: The name of the operation resource to be cancelled.
Pattern: ^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dataItems/[^/]+/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`.
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: POST
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/operations/{operationsId}:cancel
Path: v1beta1/{+name}:cancel
▼ ▲ aiplatform.projects.locations.datasets.dataItems.operations.delete
HTTP Method: 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`.
Path: v1beta1/{+name}
Parameter Order: name
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/operations/{operationsId}
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dataItems/[^/]+/operations/[^/]+$
Location: path
Type: string
Description: The name of the operation resource to be deleted.
Required: Yes
▼ ▲ aiplatform.projects.locations.datasets.dataItems.list
HTTP Method: GET
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Lists DataItems in a Dataset.
Path: v1beta1/{+parent}/dataItems
Parameter Order: parent
Parameters:
parent
Description: Required. The resource name of the Dataset to list DataItems from. Format: `projects/{project}/locations/{location}/datasets/{dataset}`
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/datasets/[^/]+$
Required: Yes
Type: string
readMask
Format: google-fieldmask
Type: string
Description: Mask specifying which fields to read.
Location: query
filter
Location: query
Description: The standard list filter.
Type: string
orderBy
Description: A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending.
Type: string
Location: query
pageToken
Location: query
Type: string
Description: The standard list page token.
pageSize
Type: integer
Description: The standard list page size.
Format: int32
Location: query
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems
▼ ▲ aiplatform.projects.locations.datasets.operations.delete
HTTP Method: DELETE
Parameter Order: name
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/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`.
Parameters:
name
Location: path
Required: Yes
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/datasets/[^/]+/operations/[^/]+$
Description: The name of the operation resource to be deleted.
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1beta1/{+name}
▼ ▲ aiplatform.projects.locations.datasets.operations.get
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+/datasets/[^/]+/operations/[^/]+$
Type: string
Location: path
Required: Yes
Description: The name of the operation resource.
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/operations/{operationsId}
Parameter Order: 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.
Path: v1beta1/{+name}
HTTP Method: GET
▼ ▲ aiplatform.projects.locations.datasets.operations.cancel
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/operations/{operationsId}:cancel
HTTP Method: POST
Parameter Order: name
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+/datasets/[^/]+/operations/[^/]+$
Location: path
Required: Yes
Description: The name of the operation resource to be cancelled.
Type: string
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: v1beta1/{+name}:cancel
▼ ▲ aiplatform.projects.locations.datasets.operations.wait
HTTP Method: POST
Path: v1beta1/{+name}:wait
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/operations/{operationsId}:wait
Description: Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
name
Type: string
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/datasets/[^/]+/operations/[^/]+$
Location: path
Description: The name of the operation resource to wait on.
timeout
Format: google-duration
Description: The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
Location: query
Type: string
Parameter Order: name
▼ ▲ aiplatform.projects.locations.datasets.operations.list
HTTP Method: GET
Path: v1beta1/{+name}/operations
Description: Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
Parameters:
pageToken
Location: query
Type: string
Description: The standard list page token.
pageSize
Format: int32
Description: The standard list page size.
Type: integer
Location: query
filter
Description: The standard list filter.
Type: string
Location: query
name
Location: path
Required: Yes
Type: string
Description: The name of the operation's parent resource.
Pattern: ^projects/[^/]+/locations/[^/]+/datasets/[^/]+$
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/operations
Parameter Order: name
▼ ▲ aiplatform.projects.locations.datasets.savedQueries.operations.list
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/savedQueries/{savedQueriesId}/operations
Path: v1beta1/{+name}/operations
Parameter Order: name
Description: Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: GET
Parameters:
pageToken
Type: string
Location: query
Description: The standard list page token.
filter
Type: string
Location: query
Description: The standard list filter.
name
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/datasets/[^/]+/savedQueries/[^/]+$
Required: Yes
Description: The name of the operation's parent resource.
Type: string
pageSize
Location: query
Format: int32
Type: integer
Description: The standard list page size.
▼ ▲ aiplatform.projects.locations.datasets.savedQueries.operations.get
Parameter Order: name
Path: v1beta1/{+name}
Parameters:
name
Type: string
Description: The name of the operation resource.
Pattern: ^projects/[^/]+/locations/[^/]+/datasets/[^/]+/savedQueries/[^/]+/operations/[^/]+$
Required: Yes
Location: path
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/savedQueries/{savedQueriesId}/operations/{operationsId}
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.
▼ ▲ aiplatform.projects.locations.datasets.savedQueries.operations.cancel
Parameters:
name
Type: string
Required: Yes
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/datasets/[^/]+/savedQueries/[^/]+/operations/[^/]+$
Description: The name of the operation resource to be cancelled.
HTTP Method: POST
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/savedQueries/{savedQueriesId}/operations/{operationsId}:cancel
Path: v1beta1/{+name}: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`.
Parameter Order: name
▼ ▲ aiplatform.projects.locations.datasets.savedQueries.operations.delete
Path: v1beta1/{+name}
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/savedQueries/{savedQueriesId}/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`.
Parameters:
name
Description: The name of the operation resource to be deleted.
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/datasets/[^/]+/savedQueries/[^/]+/operations/[^/]+$
Type: string
Required: Yes
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
HTTP Method: DELETE
▼ ▲ aiplatform.projects.locations.datasets.savedQueries.operations.wait
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/savedQueries/{savedQueriesId}/operations/{operationsId}:wait
HTTP Method: POST
Parameters:
name
Type: string
Description: The name of the operation resource to wait on.
Pattern: ^projects/[^/]+/locations/[^/]+/datasets/[^/]+/savedQueries/[^/]+/operations/[^/]+$
Required: Yes
Location: path
timeout
Description: The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
Format: google-duration
Type: string
Location: query
Parameter Order: name
Path: v1beta1/{+name}:wait
▼ ▲ aiplatform.projects.locations.datasets.savedQueries.list
Parameter Order: parent
Parameters:
filter
Location: query
Description: The standard list filter.
Type: string
pageSize
Location: query
Format: int32
Description: The standard list page size.
Type: integer
readMask
Format: google-fieldmask
Description: Mask specifying which fields to read.
Location: query
Type: string
parent
Pattern: ^projects/[^/]+/locations/[^/]+/datasets/[^/]+$
Type: string
Required: Yes
Description: Required. The resource name of the Dataset to list SavedQueries from. Format: `projects/{project}/locations/{location}/datasets/{dataset}`
Location: path
orderBy
Description: A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending.
Location: query
Type: string
pageToken
Description: The standard list page token.
Location: query
Type: string
HTTP Method: GET
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/savedQueries
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1beta1/{+parent}/savedQueries
Description: Lists SavedQueries in a Dataset.
▼ ▲ aiplatform.projects.locations.datasets.savedQueries.delete
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
Description: Deletes a SavedQuery.
Path: v1beta1/{+name}
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/savedQueries/{savedQueriesId}
HTTP Method: DELETE
Parameters:
name
Description: Required. The resource name of the SavedQuery to delete. Format: `projects/{project}/locations/{location}/datasets/{dataset}/savedQueries/{saved_query}`
Type: string
Location: path
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/datasets/[^/]+/savedQueries/[^/]+$
▼ ▲ aiplatform.projects.locations.datasets.create
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Creates a Dataset.
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/datasets
Parameter Order: parent
Parameters:
parent
Pattern: ^projects/[^/]+/locations/[^/]+$
Type: string
Required: Yes
Description: Required. The resource name of the Location to create the Dataset in. Format: `projects/{project}/locations/{location}`
Location: path
Path: v1beta1/{+parent}/datasets
HTTP Method: POST
▼ ▲ aiplatform.projects.locations.datasets.get
HTTP Method: GET
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}
Parameters:
readMask
Location: query
Type: string
Format: google-fieldmask
Description: Mask specifying which fields to read.
name
Description: Required. The name of the Dataset resource.
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/datasets/[^/]+$
Location: path
Required: Yes
Path: v1beta1/{+name}
Description: Gets a Dataset.
▼ ▲ aiplatform.projects.locations.datasets.list
Description: Lists Datasets in a Location.
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: GET
Parameters:
orderBy
Description: 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`
Location: query
Type: string
parent
Pattern: ^projects/[^/]+/locations/[^/]+$
Location: path
Required: Yes
Type: string
Description: Required. The name of the Dataset's parent resource. Format: `projects/{project}/locations/{location}`
pageToken
Description: The standard list page token.
Location: query
Type: string
pageSize
Type: integer
Format: int32
Description: The standard list page size.
Location: query
filter
Description: An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `display_name`: supports = and != * `metadata_schema_uri`: 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: * `displayName="myDisplayName"` * `labels.myKey="myValue"`
Type: string
Location: query
readMask
Location: query
Description: Mask specifying which fields to read.
Type: string
Format: google-fieldmask
Parameter Order: parent
Path: v1beta1/{+parent}/datasets
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/datasets
▼ ▲ aiplatform.projects.locations.datasets.import
Description: Imports data into a Dataset.
Parameter Order: name
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+/datasets/[^/]+$
Required: Yes
Location: path
Description: Required. The name of the Dataset resource. Format: `projects/{project}/locations/{location}/datasets/{dataset}`
Type: string
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}:import
HTTP Method: POST
Path: v1beta1/{+name}:import
▼ ▲ aiplatform.projects.locations.datasets.searchDataItems
Description: Searches DataItems in a Dataset.
Parameter Order: dataset
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}:searchDataItems
HTTP Method: GET
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
pageToken
Type: string
Description: A token identifying a page of results for the server to return Typically obtained via SearchDataItemsResponse.next_page_token of the previous DatasetService.SearchDataItems call.
Location: query
annotationsFilter
Description: An expression for filtering the Annotations that will be returned per DataItem. * `annotation_spec_id` - for = or !=.
Location: query
Deprecated: Yes
Type: string
orderByAnnotation.savedQuery
Type: string
Description: Required. Saved query of the Annotation. Only Annotations belong to this saved query will be considered for ordering.
Location: query
orderBy
Location: query
Description: A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending.
Type: string
Deprecated: Yes
annotationFilters
Description: An expression that specifies what Annotations will be returned per DataItem. Annotations satisfied either of the conditions will be returned. * `annotation_spec_id` - for = or !=. Must specify `saved_query_id=` - saved query id that annotations should belong to.
Repeated: Yes
Type: string
Location: query
savedQuery
Location: query
Deprecated: Yes
Type: string
Description: The resource name of a SavedQuery(annotation set in UI). Format: `projects/{project}/locations/{location}/datasets/{dataset}/savedQueries/{saved_query}` All of the search will be done in the context of this SavedQuery.
dataItemFilter
Description: An expression for filtering the DataItem that will be returned. * `data_item_id` - for = or !=. * `labeled` - for = or !=. * `has_annotation(ANNOTATION_SPEC_ID)` - true only for DataItem that have at least one annotation with annotation_spec_id = `ANNOTATION_SPEC_ID` in the context of SavedQuery or DataLabelingJob. For example: * `data_item=1` * `has_annotation(5)`
Type: string
Location: query
dataset
Type: string
Description: Required. The resource name of the Dataset from which to search DataItems. Format: `projects/{project}/locations/{location}/datasets/{dataset}`
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/datasets/[^/]+$
Required: Yes
fieldMask
Description: Mask specifying which fields of DataItemView to read.
Type: string
Location: query
Format: google-fieldmask
pageSize
Format: int32
Location: query
Type: integer
Description: Requested page size. Server may return fewer results than requested. Default and maximum page size is 100.
orderByDataItem
Location: query
Description: A comma-separated list of data item fields to order by, sorted in ascending order. Use "desc" after a field name for descending.
Type: string
orderByAnnotation.orderBy
Location: query
Type: string
Description: A comma-separated list of annotation fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Must also specify saved_query.
annotationsLimit
Location: query
Format: int32
Description: If set, only up to this many of Annotations will be returned per DataItemView. The maximum value is 1000. If not set, the maximum value will be used.
Type: integer
dataLabelingJob
Description: The resource name of a DataLabelingJob. Format: `projects/{project}/locations/{location}/dataLabelingJobs/{data_labeling_job}` If this field is set, all of the search will be done in the context of this DataLabelingJob.
Location: query
Type: string
Path: v1beta1/{+dataset}:searchDataItems
▼ ▲ aiplatform.projects.locations.datasets.patch
HTTP Method: PATCH
Description: Updates a Dataset.
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1beta1/{+name}
Parameter Order: name
Parameters:
name
Description: Output only. The resource name of the Dataset.
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/datasets/[^/]+$
Required: Yes
Location: path
updateMask
Type: string
Format: google-fieldmask
Location: query
Description: Required. The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask. Updatable fields: * `display_name` * `description` * `labels`
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}
▼ ▲ aiplatform.projects.locations.datasets.delete
Description: Deletes a Dataset.
Path: v1beta1/{+name}
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+/datasets/[^/]+$
Location: path
Required: Yes
Type: string
Description: Required. The resource name of the Dataset to delete. Format: `projects/{project}/locations/{location}/datasets/{dataset}`
HTTP Method: DELETE
Parameter Order: name
▼ ▲ aiplatform.projects.locations.datasets.export
Parameters:
name
Type: string
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/datasets/[^/]+$
Description: Required. The name of the Dataset resource. Format: `projects/{project}/locations/{location}/datasets/{dataset}`
Required: Yes
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}:export
Path: v1beta1/{+name}:export
HTTP Method: POST
Description: Exports data from a Dataset.
▼ ▲ aiplatform.projects.locations.specialistPools.get
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1beta1/{+name}
HTTP Method: GET
Description: Gets a SpecialistPool.
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}
Parameters:
name
Description: Required. The name of the SpecialistPool resource. The form is `projects/{project}/locations/{location}/specialistPools/{specialist_pool}`.
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/specialistPools/[^/]+$
Type: string
Required: Yes
▼ ▲ aiplatform.projects.locations.specialistPools.patch
Parameters:
name
Description: Required. The resource name of the SpecialistPool.
Required: Yes
Type: string
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/specialistPools/[^/]+$
updateMask
Format: google-fieldmask
Type: string
Description: Required. The update mask applies to the resource.
Location: query
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
HTTP Method: PATCH
Path: v1beta1/{+name}
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}
Description: Updates a SpecialistPool.
▼ ▲ aiplatform.projects.locations.specialistPools.list
Description: Lists SpecialistPools in a Location.
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
pageSize
Location: query
Type: integer
Format: int32
Description: The standard list page size.
readMask
Location: query
Format: google-fieldmask
Description: Mask specifying which fields to read. FieldMask represents a set of
Type: string
parent
Description: Required. The name of the SpecialistPool's parent resource. Format: `projects/{project}/locations/{location}`
Location: path
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+$
Required: Yes
pageToken
Description: The standard list page token. Typically obtained by ListSpecialistPoolsResponse.next_page_token of the previous SpecialistPoolService.ListSpecialistPools call. Return first page if empty.
Type: string
Location: query
Parameter Order: parent
Path: v1beta1/{+parent}/specialistPools
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/specialistPools
HTTP Method: GET
▼ ▲ aiplatform.projects.locations.specialistPools.delete
Parameters:
force
Type: boolean
Location: query
Description: If set to true, any specialist managers in this SpecialistPool will also be deleted. (Otherwise, the request will only work if the SpecialistPool has no specialist managers.)
name
Description: Required. The resource name of the SpecialistPool to delete. Format: `projects/{project}/locations/{location}/specialistPools/{specialist_pool}`
Pattern: ^projects/[^/]+/locations/[^/]+/specialistPools/[^/]+$
Required: Yes
Location: path
Type: string
Description: Deletes a SpecialistPool as well as all Specialists in the pool.
HTTP Method: DELETE
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
Path: v1beta1/{+name}
▼ ▲ aiplatform.projects.locations.specialistPools.create
Parameter Order: parent
Parameters:
parent
Pattern: ^projects/[^/]+/locations/[^/]+$
Required: Yes
Location: path
Description: Required. The parent Project name for the new SpecialistPool. The form is `projects/{project}/locations/{location}`.
Type: string
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1beta1/{+parent}/specialistPools
Description: Creates a SpecialistPool.
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/specialistPools
HTTP Method: POST
▼ ▲ aiplatform.projects.locations.specialistPools.operations.wait
HTTP Method: POST
Parameter Order: name
Parameters:
name
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/specialistPools/[^/]+/operations/[^/]+$
Description: The name of the operation resource to wait on.
Location: path
Required: Yes
timeout
Location: query
Format: google-duration
Type: string
Description: The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
Path: v1beta1/{+name}:wait
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}/operations/{operationsId}:wait
Description: Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
▼ ▲ aiplatform.projects.locations.specialistPools.operations.list
Description: Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
HTTP Method: GET
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}/operations
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
filter
Description: The standard list filter.
Type: string
Location: query
pageToken
Location: query
Description: The standard list page token.
Type: string
pageSize
Type: integer
Format: int32
Description: The standard list page size.
Location: query
name
Pattern: ^projects/[^/]+/locations/[^/]+/specialistPools/[^/]+$
Description: The name of the operation's parent resource.
Required: Yes
Type: string
Location: path
Parameter Order: name
Path: v1beta1/{+name}/operations
▼ ▲ aiplatform.projects.locations.specialistPools.operations.get
Path: v1beta1/{+name}
HTTP Method: GET
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}/operations/{operationsId}
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.
Parameters:
name
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/specialistPools/[^/]+/operations/[^/]+$
Description: The name of the operation resource.
Type: string
Required: Yes
Parameter Order: name
▼ ▲ aiplatform.projects.locations.specialistPools.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`.
HTTP Method: DELETE
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}/operations/{operationsId}
Path: v1beta1/{+name}
Parameters:
name
Location: path
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/specialistPools/[^/]+/operations/[^/]+$
Required: Yes
Description: The name of the operation resource to be deleted.
Parameter Order: name
▼ ▲ aiplatform.projects.locations.specialistPools.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`.
Parameter Order: name
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}/operations/{operationsId}:cancel
Path: v1beta1/{+name}:cancel
Parameters:
name
Required: Yes
Description: The name of the operation resource to be cancelled.
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/specialistPools/[^/]+/operations/[^/]+$
Type: string
HTTP Method: POST
▼ ▲ aiplatform.projects.locations.persistentResources.operations.wait
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}/operations/{operationsId}:wait
Path: v1beta1/{+name}:wait
HTTP Method: POST
Parameter Order: name
Parameters:
name
Location: path
Description: The name of the operation resource to wait on.
Type: string
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/persistentResources/[^/]+/operations/[^/]+$
timeout
Format: google-duration
Location: query
Type: string
Description: The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
Description: Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
▼ ▲ aiplatform.projects.locations.persistentResources.operations.delete
Parameters:
name
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/persistentResources/[^/]+/operations/[^/]+$
Location: path
Description: The name of the operation resource to be deleted.
Type: string
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: DELETE
Parameter Order: 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`.
Path: v1beta1/{+name}
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}/operations/{operationsId}
▼ ▲ aiplatform.projects.locations.persistentResources.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`.
Parameter Order: name
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}/operations/{operationsId}:cancel
HTTP Method: POST
Path: v1beta1/{+name}:cancel
Parameters:
name
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/persistentResources/[^/]+/operations/[^/]+$
Description: The name of the operation resource to be cancelled.
Location: path
Required: Yes
▼ ▲ aiplatform.projects.locations.persistentResources.operations.get
Path: v1beta1/{+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.
Parameters:
name
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/persistentResources/[^/]+/operations/[^/]+$
Description: The name of the operation resource.
Type: string
Required: Yes
HTTP Method: GET
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}/operations/{operationsId}
▼ ▲ aiplatform.projects.locations.persistentResources.operations.list
Parameters:
pageSize
Type: integer
Format: int32
Description: The standard list page size.
Location: query
filter
Location: query
Type: string
Description: The standard list filter.
name
Type: string
Required: Yes
Description: The name of the operation's parent resource.
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/persistentResources/[^/]+$
pageToken
Description: The standard list page token.
Location: query
Type: string
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}/operations
Parameter Order: name
Path: v1beta1/{+name}/operations
HTTP Method: GET
▼ ▲ aiplatform.projects.locations.persistentResources.get
Description: Gets a PersistentResource.
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}
Parameters:
name
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/persistentResources/[^/]+$
Required: Yes
Type: string
Description: Required. The name of the PersistentResource resource. Format: `projects/{project_id_or_number}/locations/{location_id}/persistentResources/{persistent_resource_id}`
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1beta1/{+name}
HTTP Method: GET
Parameter Order: name
▼ ▲ aiplatform.projects.locations.persistentResources.create
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/persistentResources
Path: v1beta1/{+parent}/persistentResources
Description: Creates a PersistentResource.
HTTP Method: POST
Parameters:
persistentResourceId
Type: string
Description: Required. The ID to use for the PersistentResource, which become the final component of the PersistentResource's resource name. The maximum length is 63 characters, and valid characters are /^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$/.
Location: query
parent
Description: Required. The resource name of the Location to create the PersistentResource in. Format: `projects/{project}/locations/{location}`
Location: path
Type: string
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+$
Parameter Order: parent
▼ ▲ aiplatform.projects.locations.persistentResources.list
Path: v1beta1/{+parent}/persistentResources
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/persistentResources
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
pageSize
Location: query
Description: Optional. The standard list page size.
Format: int32
Type: integer
pageToken
Type: string
Description: Optional. The standard list page token. Typically obtained via ListPersistentResourceResponse.next_page_token of the previous PersistentResourceService.ListPersistentResource call.
Location: query
parent
Required: Yes
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+$
Type: string
Description: Required. The resource name of the Location to list the PersistentResources from. Format: `projects/{project}/locations/{location}`
HTTP Method: GET
Description: Lists PersistentResources in a Location.
Parameter Order: parent
▼ ▲ aiplatform.projects.locations.persistentResources.delete
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}
Parameters:
name
Required: Yes
Description: Required. The name of the PersistentResource to be deleted. Format: `projects/{project}/locations/{location}/persistentResources/{persistent_resource}`
Pattern: ^projects/[^/]+/locations/[^/]+/persistentResources/[^/]+$
Location: path
Type: string
Parameter Order: name
HTTP Method: DELETE
Description: Deletes a PersistentResource.
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1beta1/{+name}
▼ ▲ aiplatform.projects.locations.featurestores.entityTypes.operations.cancel
Parameters:
name
Description: The name of the operation resource to be cancelled.
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+/operations/[^/]+$
Required: Yes
Location: path
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`.
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/operations/{operationsId}:cancel
HTTP Method: POST
Parameter Order: name
Path: v1beta1/{+name}:cancel
▼ ▲ aiplatform.projects.locations.featurestores.entityTypes.operations.wait
Parameter Order: name
Path: v1beta1/{+name}:wait
Parameters:
timeout
Location: query
Format: google-duration
Type: string
Description: The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
name
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+/operations/[^/]+$
Description: The name of the operation resource to wait on.
Type: string
Location: path
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/operations/{operationsId}:wait
HTTP Method: POST
Description: Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
▼ ▲ aiplatform.projects.locations.featurestores.entityTypes.operations.list
Parameters:
filter
Location: query
Type: string
Description: The standard list filter.
name
Description: The name of the operation's parent resource.
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$
Location: path
Required: Yes
pageSize
Location: query
Description: The standard list page size.
Type: integer
Format: int32
pageToken
Type: string
Description: The standard list page token.
Location: query
HTTP Method: GET
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/operations
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
Description: Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
Path: v1beta1/{+name}/operations
▼ ▲ aiplatform.projects.locations.featurestores.entityTypes.operations.get
HTTP Method: GET
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/operations/{operationsId}
Parameters:
name
Required: Yes
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+/operations/[^/]+$
Type: string
Description: The name of the operation resource.
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.
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1beta1/{+name}
Parameter Order: name
▼ ▲ aiplatform.projects.locations.featurestores.entityTypes.operations.delete
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: DELETE
Parameter Order: name
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/operations/{operationsId}
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+/operations/[^/]+$
Type: string
Location: path
Required: Yes
Description: The name of the operation resource to be deleted.
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`.
Path: v1beta1/{+name}
▼ ▲ aiplatform.projects.locations.featurestores.entityTypes.features.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
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1beta1/{+name}:cancel
Parameter Order: name
Parameters:
name
Location: path
Required: Yes
Description: The name of the operation resource to be cancelled.
Pattern: ^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+/features/[^/]+/operations/[^/]+$
Type: string
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}/operations/{operationsId}:cancel
▼ ▲ aiplatform.projects.locations.featurestores.entityTypes.features.operations.list
Parameter Order: name
Description: Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}/operations
Parameters:
pageToken
Description: The standard list page token.
Type: string
Location: query
name
Pattern: ^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+/features/[^/]+$
Type: string
Required: Yes
Location: path
Description: The name of the operation's parent resource.
filter
Description: The standard list filter.
Location: query
Type: string
pageSize
Location: query
Type: integer
Description: The standard list page size.
Format: int32
HTTP Method: GET
Path: v1beta1/{+name}/operations
▼ ▲ aiplatform.projects.locations.featurestores.entityTypes.features.operations.delete
Path: v1beta1/{+name}
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}/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`.
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: DELETE
Parameters:
name
Location: path
Type: string
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+/features/[^/]+/operations/[^/]+$
Description: The name of the operation resource to be deleted.
▼ ▲ aiplatform.projects.locations.featurestores.entityTypes.features.operations.get
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1beta1/{+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.
Parameter Order: name
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}/operations/{operationsId}
HTTP Method: GET
Parameters:
name
Location: path
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+/features/[^/]+/operations/[^/]+$
Description: The name of the operation resource.
Type: string
▼ ▲ aiplatform.projects.locations.featurestores.entityTypes.features.operations.wait
Path: v1beta1/{+name}:wait
HTTP Method: POST
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}/operations/{operationsId}:wait
Parameter Order: name
Description: Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
Parameters:
timeout
Location: query
Type: string
Format: google-duration
Description: The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
name
Description: The name of the operation resource to wait on.
Pattern: ^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+/features/[^/]+/operations/[^/]+$
Type: string
Location: path
Required: Yes
▼ ▲ aiplatform.projects.locations.featurestores.entityTypes.features.delete
HTTP Method: DELETE
Path: v1beta1/{+name}
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}
Parameter Order: name
Description: Deletes a single Feature.
Parameters:
name
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+/features/[^/]+$
Type: string
Description: Required. The name of the Features to be deleted. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}/features/{feature}` `projects/{project}/locations/{location}/featureGroups/{feature_group}/features/{feature}`
Required: Yes
▼ ▲ aiplatform.projects.locations.featurestores.entityTypes.features.list
Parameters:
orderBy
Type: string
Location: query
Description: A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `feature_id` * `value_type` * `create_time` * `update_time`
pageSize
Location: query
Type: integer
Format: int32
Description: The maximum number of Features to return. The service may return fewer than this value. If unspecified, at most 1000 Features will be returned. The maximum value is 1000; any value greater than 1000 will be coerced to 1000.
latestStatsCount
Type: integer
Format: int32
Description: If set, return the most recent ListFeaturesRequest.latest_stats_count of stats for each Feature in response. Valid value is [0, 10]. If number of stats exists < ListFeaturesRequest.latest_stats_count, return all existing stats.
Location: query
parent
Type: string
Description: Required. The resource name of the Location to list Features. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` `projects/{project}/locations/{location}/featureGroups/{feature_group}`
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$
Required: Yes
readMask
Type: string
Format: google-fieldmask
Location: query
Description: Mask specifying which fields to read.
pageToken
Type: string
Location: query
Description: A page token, received from a previous FeaturestoreService.ListFeatures call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeaturestoreService.ListFeatures must match the call that provided the page token.
filter
Description: Lists the Features that match the filter expression. The following filters are supported: * `value_type`: Supports = and != comparisons. * `create_time`: Supports =, !=, <, >, >=, and <= comparisons. Values must be in RFC 3339 format. * `update_time`: Supports =, !=, <, >, >=, and <= comparisons. Values must be in RFC 3339 format. * `labels`: Supports key-value equality as well as key presence. Examples: * `value_type = DOUBLE` --> Features whose type is DOUBLE. * `create_time > \"2020-01-31T15:30:00.000000Z\" OR update_time > \"2020-01-31T15:30:00.000000Z\"` --> EntityTypes created or updated after 2020-01-31T15:30:00.000000Z. * `labels.active = yes AND labels.env = prod` --> Features having both (active: yes) and (env: prod) labels. * `labels.env: *` --> Any Feature which has a label with 'env' as the key.
Type: string
Location: query
HTTP Method: GET
Path: v1beta1/{+parent}/features
Parameter Order: parent
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Lists Features in a given EntityType.
▼ ▲ aiplatform.projects.locations.featurestores.entityTypes.features.batchCreate
Parameters:
parent
Description: Required. The resource name of the EntityType to create the batch of Features under. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}`
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$
Location: path
Required: Yes
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features:batchCreate
HTTP Method: POST
Description: Creates a batch of Features in a given EntityType.
Path: v1beta1/{+parent}/features:batchCreate
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: parent
▼ ▲ aiplatform.projects.locations.featurestores.entityTypes.features.create
Parameter Order: parent
Path: v1beta1/{+parent}/features
Description: Creates a new Feature in a given EntityType.
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features
HTTP Method: POST
Parameters:
featureId
Location: query
Description: Required. The ID to use for the Feature, which will become the final component of the Feature's resource name. This value may be up to 128 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within an EntityType/FeatureGroup.
Type: string
parent
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$
Required: Yes
Location: path
Description: Required. The resource name of the EntityType or FeatureGroup to create a Feature. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` `projects/{project}/locations/{location}/featureGroups/{feature_group}`
▼ ▲ aiplatform.projects.locations.featurestores.entityTypes.features.get
Parameter Order: name
Parameters:
name
Required: Yes
Description: Required. The name of the Feature resource. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` `projects/{project}/locations/{location}/featureGroups/{feature_group}`
Type: string
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+/features/[^/]+$
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}
Description: Gets details of a single Feature.
HTTP Method: GET
Path: v1beta1/{+name}
▼ ▲ aiplatform.projects.locations.featurestores.entityTypes.features.patch
Parameter Order: name
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+/features/[^/]+$
Location: path
Required: Yes
Description: Immutable. Name of the Feature. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}/features/{feature}` The last part feature is assigned by the client. The feature can be up to 64 characters long and can consist only of ASCII Latin letters A-Z and a-z, underscore(_), and ASCII digits 0-9 starting with a letter. The value will be unique given an entity type.
Type: string
updateMask
Description: Field mask is used to specify the fields to be overwritten in the Features 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 only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `description` * `labels` * `disable_monitoring`
Format: google-fieldmask
Location: query
Type: string
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: PATCH
Description: Updates the parameters of a single Feature.
Path: v1beta1/{+name}
▼ ▲ aiplatform.projects.locations.featurestores.entityTypes.writeFeatureValues
Description: Writes Feature values of one or more entities of an EntityType. The Feature values are merged into existing entities if any. The Feature values to be written must have timestamp within the online storage retention.
Parameters:
entityType
Required: Yes
Location: path
Description: Required. The resource name of the EntityType for the entities being written. Value format: `projects/{project}/locations/{location}/featurestores/ {featurestore}/entityTypes/{entityType}`. For example, for a machine learning model predicting user clicks on a website, an EntityType ID could be `user`.
Pattern: ^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$
Type: string
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: entityType
Path: v1beta1/{+entityType}:writeFeatureValues
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:writeFeatureValues
HTTP Method: POST
▼ ▲ aiplatform.projects.locations.featurestores.entityTypes.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
HTTP Method: POST
Parameters:
resource
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
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$
Required: Yes
permissions
Repeated: Yes
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).
Location: query
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:testIamPermissions
Path: v1beta1/{+resource}:testIamPermissions
▼ ▲ aiplatform.projects.locations.featurestores.entityTypes.patch
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}
Parameters:
name
Location: path
Description: Immutable. Name of the EntityType. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` The last part entity_type is assigned by the client. The entity_type can be up to 64 characters long and can consist only of ASCII Latin letters A-Z and a-z and underscore(_), and ASCII digits 0-9 starting with a letter. The value will be unique given a featurestore.
Pattern: ^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$
Type: string
Required: Yes
updateMask
Description: Field mask is used to specify the fields to be overwritten in the EntityType 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 only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `description` * `labels` * `monitoring_config.snapshot_analysis.disabled` * `monitoring_config.snapshot_analysis.monitoring_interval_days` * `monitoring_config.snapshot_analysis.staleness_days` * `monitoring_config.import_features_analysis.state` * `monitoring_config.import_features_analysis.anomaly_detection_baseline` * `monitoring_config.numerical_threshold_config.value` * `monitoring_config.categorical_threshold_config.value` * `offline_storage_ttl_days`
Format: google-fieldmask
Type: string
Location: query
Description: Updates the parameters of a single EntityType.
HTTP Method: PATCH
Parameter Order: name
Path: v1beta1/{+name}
▼ ▲ aiplatform.projects.locations.featurestores.entityTypes.list
Path: v1beta1/{+parent}/entityTypes
Parameter Order: parent
Parameters:
parent
Type: string
Location: path
Required: Yes
Description: Required. The resource name of the Featurestore to list EntityTypes. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}`
Pattern: ^projects/[^/]+/locations/[^/]+/featurestores/[^/]+$
pageToken
Type: string
Description: A page token, received from a previous FeaturestoreService.ListEntityTypes call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeaturestoreService.ListEntityTypes must match the call that provided the page token.
Location: query
filter
Type: string
Description: Lists the EntityTypes that match the filter expression. The following filters are supported: * `create_time`: Supports `=`, `!=`, `<`, `>`, `>=`, and `<=` comparisons. Values must be in RFC 3339 format. * `update_time`: Supports `=`, `!=`, `<`, `>`, `>=`, and `<=` comparisons. Values must be in RFC 3339 format. * `labels`: Supports key-value equality as well as key presence. Examples: * `create_time > \"2020-01-31T15:30:00.000000Z\" OR update_time > \"2020-01-31T15:30:00.000000Z\"` --> EntityTypes created or updated after 2020-01-31T15:30:00.000000Z. * `labels.active = yes AND labels.env = prod` --> EntityTypes having both (active: yes) and (env: prod) labels. * `labels.env: *` --> Any EntityType which has a label with 'env' as the key.
Location: query
pageSize
Location: query
Format: int32
Type: integer
Description: The maximum number of EntityTypes to return. The service may return fewer than this value. If unspecified, at most 1000 EntityTypes will be returned. The maximum value is 1000; any value greater than 1000 will be coerced to 1000.
orderBy
Description: A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `entity_type_id` * `create_time` * `update_time`
Location: query
Type: string
readMask
Format: google-fieldmask
Type: string
Location: query
Description: Mask specifying which fields to read.
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes
HTTP Method: GET
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Lists EntityTypes in a given Featurestore.
▼ ▲ aiplatform.projects.locations.featurestores.entityTypes.get
Parameter Order: name
Parameters:
name
Required: Yes
Description: Required. The name of the EntityType resource. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}`
Pattern: ^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$
Location: path
Type: string
HTTP Method: GET
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Gets details of a single EntityType.
Path: v1beta1/{+name}
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}
▼ ▲ aiplatform.projects.locations.featurestores.entityTypes.create
HTTP Method: POST
Description: Creates a new EntityType in a given Featurestore.
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes
Parameters:
parent
Location: path
Required: Yes
Description: Required. The resource name of the Featurestore to create EntityTypes. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}`
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/featurestores/[^/]+$
entityTypeId
Location: query
Description: Required. The ID to use for the EntityType, which will become the final component of the EntityType's resource name. This value may be up to 60 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within a featurestore.
Type: string
Path: v1beta1/{+parent}/entityTypes
Parameter Order: parent
▼ ▲ aiplatform.projects.locations.featurestores.entityTypes.deleteFeatureValues
Parameters:
entityType
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$
Type: string
Description: Required. The resource name of the EntityType grouping the Features for which values are being deleted from. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entityType}`
Required: Yes
Parameter Order: entityType
Description: Delete Feature values from Featurestore. The progress of the deletion is tracked by the returned operation. The deleted feature values are guaranteed to be invisible to subsequent read operations after the operation is marked as successfully done. If a delete feature values operation fails, the feature values returned from reads and exports may be inconsistent. If consistency is required, the caller must retry the same delete request again and wait till the new operation returned is marked as successfully done.
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:deleteFeatureValues
Path: v1beta1/{+entityType}:deleteFeatureValues
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: POST
▼ ▲ aiplatform.projects.locations.featurestores.entityTypes.readFeatureValues
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
entityType
Description: Required. The resource name of the EntityType for the entity being read. Value format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entityType}`. For example, for a machine learning model predicting user clicks on a website, an EntityType ID could be `user`.
Location: path
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$
Type: string
Parameter Order: entityType
HTTP Method: POST
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:readFeatureValues
Path: v1beta1/{+entityType}:readFeatureValues
Description: Reads Feature values of a specific entity of an EntityType. For reading feature values of multiple entities of an EntityType, please use StreamingReadFeatureValues.
▼ ▲ aiplatform.projects.locations.featurestores.entityTypes.setIamPolicy
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:setIamPolicy
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: resource
HTTP Method: POST
Path: v1beta1/{+resource}:setIamPolicy
Parameters:
resource
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.
Pattern: ^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$
Required: Yes
Location: path
Description: Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
▼ ▲ aiplatform.projects.locations.featurestores.entityTypes.getIamPolicy
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}: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.
HTTP Method: POST
Parameters:
resource
Type: string
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$
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
options.requestedPolicyVersion
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).
Type: integer
Format: int32
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1beta1/{+resource}:getIamPolicy
Parameter Order: resource
▼ ▲ aiplatform.projects.locations.featurestores.entityTypes.importFeatureValues
Parameters:
entityType
Required: Yes
Type: string
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$
Description: Required. The resource name of the EntityType grouping the Features for which values are being imported. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entityType}`
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:importFeatureValues
Description: Imports Feature values into the Featurestore from a source storage. The progress of the import is tracked by the returned operation. The imported features are guaranteed to be visible to subsequent read operations after the operation is marked as successfully done. If an import operation fails, the Feature values returned from reads and exports may be inconsistent. If consistency is required, the caller must retry the same import request again and wait till the new operation returned is marked as successfully done. There are also scenarios where the caller can cause inconsistency. - Source data for import contains multiple distinct Feature values for the same entity ID and timestamp. - Source is modified during an import. This includes adding, updating, or removing source data and/or metadata. Examples of updating metadata include but are not limited to changing storage location, storage class, or retention policy. - Online serving cluster is under-provisioned.
Parameter Order: entityType
Path: v1beta1/{+entityType}:importFeatureValues
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: POST
▼ ▲ aiplatform.projects.locations.featurestores.entityTypes.delete
Path: v1beta1/{+name}
Description: Deletes a single EntityType. The EntityType must not have any Features or `force` must be set to true for the request to succeed.
Parameters:
force
Type: boolean
Description: If set to true, any Features for this EntityType will also be deleted. (Otherwise, the request will only work if the EntityType has no Features.)
Location: query
name
Type: string
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$
Description: Required. The name of the EntityType to be deleted. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}`
Location: path
HTTP Method: DELETE
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}
Parameter Order: name
▼ ▲ aiplatform.projects.locations.featurestores.entityTypes.exportFeatureValues
HTTP Method: POST
Path: v1beta1/{+entityType}:exportFeatureValues
Description: Exports Feature values from all the entities of a target EntityType.
Parameter Order: entityType
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:exportFeatureValues
Parameters:
entityType
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$
Location: path
Type: string
Description: Required. The resource name of the EntityType from which to export Feature values. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}`
▼ ▲ aiplatform.projects.locations.featurestores.entityTypes.streamingReadFeatureValues
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1beta1/{+entityType}:streamingReadFeatureValues
Parameters:
entityType
Type: string
Description: Required. The resource name of the entities' type. Value format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entityType}`. For example, for a machine learning model predicting user clicks on a website, an EntityType ID could be `user`.
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$
Location: path
Parameter Order: entityType
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:streamingReadFeatureValues
HTTP Method: POST
Description: Reads Feature values for multiple entities. Depending on their size, data for different entities may be broken up across multiple responses.
▼ ▲ aiplatform.projects.locations.featurestores.operations.list
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/operations
HTTP Method: GET
Path: v1beta1/{+name}/operations
Parameters:
pageSize
Description: The standard list page size.
Type: integer
Format: int32
Location: query
pageToken
Type: string
Location: query
Description: The standard list page token.
name
Type: string
Description: The name of the operation's parent resource.
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/featurestores/[^/]+$
Required: Yes
filter
Description: The standard list filter.
Type: string
Location: query
Scopes: https://www.googleapis.com/auth/cloud-platform
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
▼ ▲ aiplatform.projects.locations.featurestores.operations.wait
Path: v1beta1/{+name}:wait
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/operations/{operationsId}:wait
Parameter Order: name
Parameters:
name
Location: path
Required: Yes
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/operations/[^/]+$
Description: The name of the operation resource to wait on.
timeout
Description: The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
Type: string
Format: google-duration
Location: query
Description: Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
HTTP Method: POST
▼ ▲ aiplatform.projects.locations.featurestores.operations.delete
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/operations/[^/]+$
Description: The name of the operation resource to be deleted.
Required: Yes
Location: path
Type: string
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/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`.
Parameter Order: name
HTTP Method: DELETE
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1beta1/{+name}
▼ ▲ aiplatform.projects.locations.featurestores.operations.get
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
name
Description: The name of the operation resource.
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/operations/[^/]+$
Location: path
Required: Yes
HTTP Method: GET
Parameter Order: name
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/operations/{operationsId}
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.
Path: v1beta1/{+name}
▼ ▲ aiplatform.projects.locations.featurestores.operations.cancel
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/operations/{operationsId}:cancel
Parameters:
name
Required: Yes
Location: path
Description: The name of the operation resource to be cancelled.
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/operations/[^/]+$
Parameter Order: name
Path: v1beta1/{+name}:cancel
HTTP Method: POST
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`.
▼ ▲ aiplatform.projects.locations.featurestores.testIamPermissions
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}:testIamPermissions
Parameters:
resource
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/featurestores/[^/]+$
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
HTTP Method: POST
Path: v1beta1/{+resource}:testIamPermissions
Scopes: https://www.googleapis.com/auth/cloud-platform
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.
▼ ▲ aiplatform.projects.locations.featurestores.batchReadFeatureValues
Description: Batch reads Feature values from a Featurestore. This API enables batch reading Feature values, where each read instance in the batch may read Feature values of entities from one or more EntityTypes. Point-in-time correctness is guaranteed for Feature values of each read instance as of each instance's read timestamp.
Path: v1beta1/{+featurestore}:batchReadFeatureValues
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
featurestore
Description: Required. The resource name of the Featurestore from which to query Feature values. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}`
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/featurestores/[^/]+$
Required: Yes
Location: path
Parameter Order: featurestore
HTTP Method: POST
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}:batchReadFeatureValues
▼ ▲ aiplatform.projects.locations.featurestores.getIamPolicy
Parameter Order: resource
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}:getIamPolicy
Parameters:
resource
Location: path
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.
Pattern: ^projects/[^/]+/locations/[^/]+/featurestores/[^/]+$
HTTP Method: POST
Path: v1beta1/{+resource}:getIamPolicy
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
▼ ▲ aiplatform.projects.locations.featurestores.create
Description: Creates a new Featurestore in a given project and location.
HTTP Method: POST
Parameters:
featurestoreId
Location: query
Type: string
Description: Required. The ID to use for this Featurestore, which will become the final component of the Featurestore's resource name. This value may be up to 60 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within the project and location.
parent
Pattern: ^projects/[^/]+/locations/[^/]+$
Description: Required. The resource name of the Location to create Featurestores. Format: `projects/{project}/locations/{location}`
Location: path
Required: Yes
Type: string
Path: v1beta1/{+parent}/featurestores
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores
▼ ▲ aiplatform.projects.locations.featurestores.get
Description: Gets details of a single Featurestore.
HTTP Method: GET
Path: v1beta1/{+name}
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
name
Location: path
Description: Required. The name of the Featurestore resource.
Pattern: ^projects/[^/]+/locations/[^/]+/featurestores/[^/]+$
Type: string
Required: Yes
Parameter Order: name
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}
▼ ▲ aiplatform.projects.locations.featurestores.searchFeatures
Parameters:
pageToken
Location: query
Type: string
Description: A page token, received from a previous FeaturestoreService.SearchFeatures call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeaturestoreService.SearchFeatures, except `page_size`, must match the call that provided the page token.
pageSize
Location: query
Format: int32
Type: integer
Description: The maximum number of Features to return. The service may return fewer than this value. If unspecified, at most 100 Features will be returned. The maximum value is 100; any value greater than 100 will be coerced to 100.
location
Pattern: ^projects/[^/]+/locations/[^/]+$
Required: Yes
Location: path
Type: string
Description: Required. The resource name of the Location to search Features. Format: `projects/{project}/locations/{location}`
query
Description: Query string that is a conjunction of field-restricted queries and/or field-restricted filters. Field-restricted queries and filters can be combined using `AND` to form a conjunction. A field query is in the form FIELD:QUERY. This implicitly checks if QUERY exists as a substring within Feature's FIELD. The QUERY and the FIELD are converted to a sequence of words (i.e. tokens) for comparison. This is done by: * Removing leading/trailing whitespace and tokenizing the search value. Characters that are not one of alphanumeric `[a-zA-Z0-9]`, underscore `_`, or asterisk `*` are treated as delimiters for tokens. `*` is treated as a wildcard that matches characters within a token. * Ignoring case. * Prepending an asterisk to the first and appending an asterisk to the last token in QUERY. A QUERY must be either a singular token or a phrase. A phrase is one or multiple words enclosed in double quotation marks ("). With phrases, the order of the words is important. Words in the phrase must be matching in order and consecutively. Supported FIELDs for field-restricted queries: * `feature_id` * `description` * `entity_type_id` Examples: * `feature_id: foo` --> Matches a Feature with ID containing the substring `foo` (eg. `foo`, `foofeature`, `barfoo`). * `feature_id: foo*feature` --> Matches a Feature with ID containing the substring `foo*feature` (eg. `foobarfeature`). * `feature_id: foo AND description: bar` --> Matches a Feature with ID containing the substring `foo` and description containing the substring `bar`. Besides field queries, the following exact-match filters are supported. The exact-match filters do not support wildcards. Unlike field-restricted queries, exact-match filters are case-sensitive. * `feature_id`: Supports = comparisons. * `description`: Supports = comparisons. Multi-token filters should be enclosed in quotes. * `entity_type_id`: Supports = comparisons. * `value_type`: Supports = and != comparisons. * `labels`: Supports key-value equality as well as key presence. * `featurestore_id`: Supports = comparisons. Examples: * `description = "foo bar"` --> Any Feature with description exactly equal to `foo bar` * `value_type = DOUBLE` --> Features whose type is DOUBLE. * `labels.active = yes AND labels.env = prod` --> Features having both (active: yes) and (env: prod) labels. * `labels.env: *` --> Any Feature which has a label with `env` as the key.
Location: query
Type: string
Parameter Order: location
HTTP Method: GET
Description: Searches Features matching a query in a given project.
Path: v1beta1/{+location}/featurestores:searchFeatures
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores:searchFeatures
▼ ▲ aiplatform.projects.locations.featurestores.patch
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
updateMask
Format: google-fieldmask
Location: query
Type: string
Description: Field mask is used to specify the fields to be overwritten in the Featurestore 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 only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `labels` * `online_serving_config.fixed_node_count` * `online_serving_config.scaling` * `online_storage_ttl_days`
name
Location: path
Description: Output only. Name of the Featurestore. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}`
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/featurestores/[^/]+$
Required: Yes
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}
Path: v1beta1/{+name}
Description: Updates the parameters of a single Featurestore.
Parameter Order: name
HTTP Method: PATCH
▼ ▲ aiplatform.projects.locations.featurestores.delete
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Deletes a single Featurestore. The Featurestore must not contain any EntityTypes or `force` must be set to true for the request to succeed.
Parameters:
force
Location: query
Description: If set to true, any EntityTypes and Features for this Featurestore will also be deleted. (Otherwise, the request will only work if the Featurestore has no EntityTypes.)
Type: boolean
name
Pattern: ^projects/[^/]+/locations/[^/]+/featurestores/[^/]+$
Required: Yes
Description: Required. The name of the Featurestore to be deleted. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}`
Type: string
Location: path
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}
Path: v1beta1/{+name}
HTTP Method: DELETE
▼ ▲ aiplatform.projects.locations.featurestores.setIamPolicy
HTTP Method: POST
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
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}:setIamPolicy
Parameters:
resource
Pattern: ^projects/[^/]+/locations/[^/]+/featurestores/[^/]+$
Location: path
Type: string
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.
Path: v1beta1/{+resource}:setIamPolicy
▼ ▲ aiplatform.projects.locations.featurestores.list
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: GET
Path: v1beta1/{+parent}/featurestores
Parameters:
readMask
Type: string
Location: query
Format: google-fieldmask
Description: Mask specifying which fields to read.
pageToken
Location: query
Description: A page token, received from a previous FeaturestoreService.ListFeaturestores call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeaturestoreService.ListFeaturestores must match the call that provided the page token.
Type: string
filter
Description: Lists the featurestores that match the filter expression. The following fields are supported: * `create_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be in RFC 3339 format. * `update_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be in RFC 3339 format. * `online_serving_config.fixed_node_count`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. * `labels`: Supports key-value equality and key presence. Examples: * `create_time > "2020-01-01" OR update_time > "2020-01-01"` Featurestores created or updated after 2020-01-01. * `labels.env = "prod"` Featurestores with label "env" set to "prod".
Type: string
Location: query
orderBy
Description: A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported Fields: * `create_time` * `update_time` * `online_serving_config.fixed_node_count`
Location: query
Type: string
parent
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+$
Description: Required. The resource name of the Location to list Featurestores. Format: `projects/{project}/locations/{location}`
Required: Yes
Type: string
pageSize
Description: The maximum number of Featurestores to return. The service may return fewer than this value. If unspecified, at most 100 Featurestores will be returned. The maximum value is 100; any value greater than 100 will be coerced to 100.
Location: query
Type: integer
Format: int32
Parameter Order: parent
Description: Lists Featurestores in a given project and location.
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores
▼ ▲ aiplatform.projects.locations.tensorboards.experiments.operations.wait
Description: Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
HTTP Method: POST
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/operations/{operationsId}:wait
Parameters:
timeout
Location: query
Description: The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
Type: string
Format: google-duration
name
Description: The name of the operation resource to wait on.
Type: string
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/operations/[^/]+$
Location: path
Path: v1beta1/{+name}:wait
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
▼ ▲ aiplatform.projects.locations.tensorboards.experiments.operations.list
Path: v1beta1/{+name}/operations
HTTP Method: GET
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/operations
Parameters:
filter
Description: The standard list filter.
Type: string
Location: query
pageSize
Location: query
Description: The standard list page size.
Format: int32
Type: integer
pageToken
Location: query
Description: The standard list page token.
Type: string
name
Description: The name of the operation's parent resource.
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+$
Required: Yes
Type: string
Description: Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
▼ ▲ aiplatform.projects.locations.tensorboards.experiments.operations.get
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: GET
Path: v1beta1/{+name}
Parameters:
name
Location: path
Description: The name of the operation resource.
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/operations/[^/]+$
Required: Yes
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/operations/{operationsId}
Parameter Order: 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.
▼ ▲ aiplatform.projects.locations.tensorboards.experiments.operations.cancel
Parameter Order: name
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/operations/{operationsId}:cancel
Parameters:
name
Location: path
Description: The name of the operation resource to be cancelled.
Pattern: ^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/operations/[^/]+$
Required: Yes
Type: string
HTTP Method: POST
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`.
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1beta1/{+name}:cancel
▼ ▲ aiplatform.projects.locations.tensorboards.experiments.operations.delete
HTTP Method: DELETE
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/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`.
Path: v1beta1/{+name}
Parameter Order: name
Parameters:
name
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/operations/[^/]+$
Description: The name of the operation resource to be deleted.
Location: path
Required: Yes
▼ ▲ aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.batchCreate
HTTP Method: POST
Parameters:
runsId
Required: Yes
Location: path
Type: string
parent
Required: Yes
Type: string
Description: Required. The resource name of the TensorboardExperiment to create the TensorboardTimeSeries in. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}` The TensorboardRuns referenced by the parent fields in the CreateTensorboardTimeSeriesRequest messages must be sub resources of this TensorboardExperiment.
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+$
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order:
Path: v1beta1/{+parent}/runs/{runsId}/timeSeries:batchCreate
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries:batchCreate
Description: Batch create TensorboardTimeSeries that belong to a TensorboardExperiment.
▼ ▲ aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.list
Parameters:
orderBy
Description: Field to use to sort the list.
Type: string
Location: query
parent
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+$
Type: string
Description: Required. The resource name of the TensorboardRun to list TensorboardTimeSeries. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}`
Required: Yes
readMask
Location: query
Description: Mask specifying which fields to read.
Format: google-fieldmask
Type: string
filter
Description: Lists the TensorboardTimeSeries that match the filter expression.
Location: query
Type: string
pageSize
Location: query
Description: The maximum number of TensorboardTimeSeries to return. The service may return fewer than this value. If unspecified, at most 50 TensorboardTimeSeries are returned. The maximum value is 1000; values above 1000 are coerced to 1000.
Type: integer
Format: int32
pageToken
Type: string
Description: A page token, received from a previous TensorboardService.ListTensorboardTimeSeries call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to TensorboardService.ListTensorboardTimeSeries must match the call that provided the page token.
Location: query
Path: v1beta1/{+parent}/timeSeries
Description: Lists TensorboardTimeSeries in a Location.
HTTP Method: GET
Parameter Order: parent
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries
▼ ▲ aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.batchRead
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: GET
Parameters:
experimentsId
Location: path
Required: Yes
Type: string
tensorboard
Type: string
Location: path
Description: Required. The resource name of the Tensorboard containing TensorboardTimeSeries to read data from. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`. The TensorboardTimeSeries referenced by time_series must be sub resources of this Tensorboard.
Pattern: ^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+$
Required: Yes
runsId
Location: path
Type: string
Required: Yes
timeSeries
Description: Required. The resource names of the TensorboardTimeSeries to read data from. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}`
Repeated: Yes
Location: query
Type: string
Path: v1beta1/{+tensorboard}/experiments/{experimentsId}/runs/{runsId}/timeSeries:batchRead
Description: Reads multiple TensorboardTimeSeries' data. The data point number limit is 1000 for scalars, 100 for tensors and blob references. If the number of data points stored is less than the limit, all data is returned. Otherwise, the number limit of data points is randomly selected from this time series and returned.
Parameter Order:
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries:batchRead
▼ ▲ aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.patch
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}
Description: Updates a TensorboardTimeSeries.
Parameters:
updateMask
Format: google-fieldmask
Type: string
Location: query
Description: Required. Field mask is used to specify the fields to be overwritten in the TensorboardTimeSeries resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it's in the mask. If the user does not provide a mask then all fields are overwritten if new values are specified.
name
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+$
Location: path
Type: string
Description: Output only. Name of the TensorboardTimeSeries.
Path: v1beta1/{+name}
HTTP Method: PATCH
▼ ▲ aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.readBlobData
Path: v1beta1/{+timeSeries}:readBlobData
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: GET
Description: Gets bytes of TensorboardBlobs. This is to allow reading blob data stored in consumer project's Cloud Storage bucket without users having to obtain Cloud Storage access permission.
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}:readBlobData
Parameters:
timeSeries
Pattern: ^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+$
Type: string
Required: Yes
Location: path
Description: Required. The resource name of the TensorboardTimeSeries to list Blobs. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}`
blobIds
Type: string
Repeated: Yes
Location: query
Description: IDs of the blobs to read.
Parameter Order: timeSeries
▼ ▲ aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.create
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: POST
Description: Creates a TensorboardTimeSeries.
Parameter Order: parent
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries
Parameters:
tensorboardTimeSeriesId
Description: Optional. The user specified unique ID to use for the TensorboardTimeSeries, which becomes the final component of the TensorboardTimeSeries's resource name. This value should match "a-z0-9{0, 127}"
Type: string
Location: query
parent
Required: Yes
Location: path
Description: Required. The resource name of the TensorboardRun to create the TensorboardTimeSeries in. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}`
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+$
Path: v1beta1/{+parent}/timeSeries
▼ ▲ aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.delete
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: DELETE
Description: Deletes a TensorboardTimeSeries.
Parameter Order: name
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}
Path: v1beta1/{+name}
Parameters:
name
Location: path
Type: string
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+$
Description: Required. The name of the TensorboardTimeSeries to be deleted. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}`
▼ ▲ aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.exportTensorboardTimeSeries
Path: v1beta1/{+tensorboardTimeSeries}:exportTensorboardTimeSeries
Description: Exports a TensorboardTimeSeries' data. Data is returned in paginated responses.
Parameter Order: tensorboardTimeSeries
HTTP Method: POST
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}:exportTensorboardTimeSeries
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
tensorboardTimeSeries
Required: Yes
Location: path
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+$
Description: Required. The resource name of the TensorboardTimeSeries to export data from. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}`
▼ ▲ aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.get
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1beta1/{+name}
HTTP Method: GET
Parameters:
name
Description: Required. The name of the TensorboardTimeSeries resource. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}`
Required: Yes
Location: path
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+$
Description: Gets a TensorboardTimeSeries.
Parameter Order: name
▼ ▲ aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.read
Parameters:
maxDataPoints
Location: query
Type: integer
Description: The maximum number of TensorboardTimeSeries' data to return. This value should be a positive integer. This value can be set to -1 to return all data.
Format: int32
filter
Description: Reads the TensorboardTimeSeries' data that match the filter expression.
Type: string
Location: query
tensorboardTimeSeries
Pattern: ^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+$
Location: path
Type: string
Required: Yes
Description: Required. The resource name of the TensorboardTimeSeries to read data from. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}`
Path: v1beta1/{+tensorboardTimeSeries}:read
HTTP Method: GET
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}:read
Description: Reads a TensorboardTimeSeries' data. By default, if the number of data points stored is less than 1000, all data is returned. Otherwise, 1000 data points is randomly selected from this time series and returned. This value can be changed by changing max_data_points, which can't be greater than 10k.
Parameter Order: tensorboardTimeSeries
▼ ▲ aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.operations.delete
HTTP Method: DELETE
Parameters:
name
Type: string
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+/operations/[^/]+$
Location: path
Description: The name of the operation resource to be deleted.
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1beta1/{+name}
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}/operations/{operationsId}
Parameter Order: 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`.
▼ ▲ aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.operations.list
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}/operations
Parameters:
pageSize
Description: The standard list page size.
Type: integer
Location: query
Format: int32
pageToken
Description: The standard list page token.
Type: string
Location: query
name
Description: The name of the operation's parent resource.
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+$
Required: Yes
Location: path
filter
Description: The standard list filter.
Location: query
Type: string
Description: Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
HTTP Method: GET
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1beta1/{+name}/operations
Parameter Order: name
▼ ▲ aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.operations.cancel
Parameter Order: name
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`.
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}/operations/{operationsId}:cancel
HTTP Method: POST
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+/operations/[^/]+$
Location: path
Description: The name of the operation resource to be cancelled.
Type: string
Required: Yes
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1beta1/{+name}:cancel
▼ ▲ aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.operations.wait
HTTP Method: POST
Parameters:
timeout
Description: The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
Type: string
Format: google-duration
Location: query
name
Type: string
Description: The name of the operation resource to wait on.
Required: Yes
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+/operations/[^/]+$
Parameter Order: name
Description: Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}/operations/{operationsId}:wait
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1beta1/{+name}:wait
▼ ▲ aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.operations.get
HTTP Method: GET
Parameters:
name
Required: Yes
Description: The name of the operation resource.
Pattern: ^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+/operations/[^/]+$
Type: string
Location: path
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
Path: v1beta1/{+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.
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}/operations/{operationsId}
▼ ▲ aiplatform.projects.locations.tensorboards.experiments.runs.operations.cancel
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/operations/{operationsId}: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`.
Parameter Order: name
Path: v1beta1/{+name}:cancel
HTTP Method: POST
Parameters:
name
Location: path
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/operations/[^/]+$
Type: string
Description: The name of the operation resource to be cancelled.
▼ ▲ aiplatform.projects.locations.tensorboards.experiments.runs.operations.list
HTTP Method: GET
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/operations
Parameter Order: name
Parameters:
pageToken
Description: The standard list page token.
Type: string
Location: query
name
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+$
Required: Yes
Type: string
Description: The name of the operation's parent resource.
filter
Location: query
Description: The standard list filter.
Type: string
pageSize
Type: integer
Location: query
Format: int32
Description: The standard list page size.
Path: v1beta1/{+name}/operations
▼ ▲ aiplatform.projects.locations.tensorboards.experiments.runs.operations.get
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/operations/{operationsId}
Parameters:
name
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/operations/[^/]+$
Description: The name of the operation resource.
Type: string
Required: Yes
Path: v1beta1/{+name}
HTTP Method: GET
Parameter Order: 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.
▼ ▲ aiplatform.projects.locations.tensorboards.experiments.runs.operations.wait
HTTP Method: POST
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/operations/{operationsId}:wait
Parameters:
name
Required: Yes
Description: The name of the operation resource to wait on.
Pattern: ^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/operations/[^/]+$
Type: string
Location: path
timeout
Description: The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
Location: query
Format: google-duration
Type: string
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1beta1/{+name}:wait
Parameter Order: name
Description: Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
▼ ▲ aiplatform.projects.locations.tensorboards.experiments.runs.operations.delete
Path: v1beta1/{+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`.
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/operations/{operationsId}
Parameter Order: name
Parameters:
name
Type: string
Description: The name of the operation resource to be deleted.
Required: Yes
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/operations/[^/]+$
HTTP Method: DELETE
▼ ▲ aiplatform.projects.locations.tensorboards.experiments.runs.list
HTTP Method: GET
Path: v1beta1/{+parent}/runs
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs
Parameters:
pageSize
Location: query
Description: The maximum number of TensorboardRuns to return. The service may return fewer than this value. If unspecified, at most 50 TensorboardRuns are returned. The maximum value is 1000; values above 1000 are coerced to 1000.
Format: int32
Type: integer
orderBy
Description: Field to use to sort the list.
Type: string
Location: query
readMask
Location: query
Format: google-fieldmask
Type: string
Description: Mask specifying which fields to read.
parent
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+$
Location: path
Required: Yes
Description: Required. The resource name of the TensorboardExperiment to list TensorboardRuns. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}`
filter
Location: query
Type: string
Description: Lists the TensorboardRuns that match the filter expression.
pageToken
Type: string
Location: query
Description: A page token, received from a previous TensorboardService.ListTensorboardRuns call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to TensorboardService.ListTensorboardRuns must match the call that provided the page token.
Parameter Order: parent
Description: Lists TensorboardRuns in a Location.
▼ ▲ aiplatform.projects.locations.tensorboards.experiments.runs.patch
Description: Updates a TensorboardRun.
HTTP Method: PATCH
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
Path: v1beta1/{+name}
Parameters:
name
Location: path
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+$
Description: Output only. Name of the TensorboardRun. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}`
Type: string
updateMask
Type: string
Format: google-fieldmask
Description: Required. Field mask is used to specify the fields to be overwritten in the TensorboardRun resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it's in the mask. If the user does not provide a mask then all fields are overwritten if new values are specified.
Location: query
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}
▼ ▲ aiplatform.projects.locations.tensorboards.experiments.runs.write
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
tensorboardRun
Description: Required. The resource name of the TensorboardRun to write data to. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}`
Pattern: ^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+$
Required: Yes
Type: string
Location: path
Description: Write time series data points into multiple TensorboardTimeSeries under a TensorboardRun. If any data fail to be ingested, an error is returned.
HTTP Method: POST
Path: v1beta1/{+tensorboardRun}:write
Parameter Order: tensorboardRun
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}:write
▼ ▲ aiplatform.projects.locations.tensorboards.experiments.runs.get
HTTP Method: GET
Path: v1beta1/{+name}
Parameter Order: name
Description: Gets a TensorboardRun.
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}
Parameters:
name
Description: Required. The name of the TensorboardRun resource. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}`
Type: string
Required: Yes
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+$
▼ ▲ aiplatform.projects.locations.tensorboards.experiments.runs.create
Path: v1beta1/{+parent}/runs
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs
Description: Creates a TensorboardRun.
Parameters:
tensorboardRunId
Description: Required. The ID to use for the Tensorboard run, which becomes the final component of the Tensorboard run's resource name. This value should be 1-128 characters, and valid characters are /a-z-/.
Type: string
Location: query
parent
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+$
Type: string
Required: Yes
Description: Required. The resource name of the TensorboardExperiment to create the TensorboardRun in. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}`
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: parent
HTTP Method: POST
▼ ▲ aiplatform.projects.locations.tensorboards.experiments.runs.delete
Parameters:
name
Description: Required. The name of the TensorboardRun to be deleted. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}`
Required: Yes
Location: path
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+$
Path: v1beta1/{+name}
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}
Description: Deletes a TensorboardRun.
Parameter Order: name
HTTP Method: DELETE
▼ ▲ aiplatform.projects.locations.tensorboards.experiments.runs.batchCreate
Parameters:
parent
Location: path
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+$
Description: Required. The resource name of the TensorboardExperiment to create the TensorboardRuns in. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}` The parent field in the CreateTensorboardRunRequest messages must match this field.
Type: string
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: POST
Path: v1beta1/{+parent}/runs:batchCreate
Description: Batch create TensorboardRuns.
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs:batchCreate
Parameter Order: parent
▼ ▲ aiplatform.projects.locations.tensorboards.experiments.create
Parameter Order: parent
Description: Creates a TensorboardExperiment.
Path: v1beta1/{+parent}/experiments
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments
Parameters:
tensorboardExperimentId
Location: query
Type: string
Description: Required. The ID to use for the Tensorboard experiment, which becomes the final component of the Tensorboard experiment's resource name. This value should be 1-128 characters, and valid characters are /a-z-/.
parent
Location: path
Description: Required. The resource name of the Tensorboard to create the TensorboardExperiment in. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`
Pattern: ^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+$
Type: string
Required: Yes
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: POST
▼ ▲ aiplatform.projects.locations.tensorboards.experiments.list
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments
Parameter Order: parent
Description: Lists TensorboardExperiments in a Location.
Path: v1beta1/{+parent}/experiments
Parameters:
filter
Type: string
Description: Lists the TensorboardExperiments that match the filter expression.
Location: query
orderBy
Location: query
Type: string
Description: Field to use to sort the list.
readMask
Format: google-fieldmask
Type: string
Location: query
Description: Mask specifying which fields to read.
pageToken
Type: string
Location: query
Description: A page token, received from a previous TensorboardService.ListTensorboardExperiments call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to TensorboardService.ListTensorboardExperiments must match the call that provided the page token.
parent
Description: Required. The resource name of the Tensorboard to list TensorboardExperiments. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`
Pattern: ^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+$
Location: path
Required: Yes
Type: string
pageSize
Description: The maximum number of TensorboardExperiments to return. The service may return fewer than this value. If unspecified, at most 50 TensorboardExperiments are returned. The maximum value is 1000; values above 1000 are coerced to 1000.
Format: int32
Location: query
Type: integer
HTTP Method: GET
▼ ▲ aiplatform.projects.locations.tensorboards.experiments.patch
Parameter Order: name
Description: Updates a TensorboardExperiment.
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}
Parameters:
updateMask
Location: query
Description: Required. Field mask is used to specify the fields to be overwritten in the TensorboardExperiment resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it's in the mask. If the user does not provide a mask then all fields are overwritten if new values are specified.
Type: string
Format: google-fieldmask
name
Pattern: ^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+$
Description: Output only. Name of the TensorboardExperiment. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}`
Required: Yes
Location: path
Type: string
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1beta1/{+name}
HTTP Method: PATCH
▼ ▲ aiplatform.projects.locations.tensorboards.experiments.write
Path: v1beta1/{+tensorboardExperiment}:write
Description: Write time series data points of multiple TensorboardTimeSeries in multiple TensorboardRun's. If any data fail to be ingested, an error is returned.
HTTP Method: POST
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}:write
Parameters:
tensorboardExperiment
Location: path
Description: Required. The resource name of the TensorboardExperiment to write data to. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}`
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+$
Required: Yes
Parameter Order: tensorboardExperiment
▼ ▲ aiplatform.projects.locations.tensorboards.experiments.delete
Parameter Order: name
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}
Path: v1beta1/{+name}
Description: Deletes a TensorboardExperiment.
HTTP Method: DELETE
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
name
Description: Required. The name of the TensorboardExperiment to be deleted. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}`
Pattern: ^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+$
Type: string
Location: path
Required: Yes
▼ ▲ aiplatform.projects.locations.tensorboards.experiments.get
Parameter Order: name
Description: Gets a TensorboardExperiment.
Path: v1beta1/{+name}
Parameters:
name
Location: path
Required: Yes
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+$
Description: Required. The name of the TensorboardExperiment resource. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}`
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}
HTTP Method: GET
▼ ▲ aiplatform.projects.locations.tensorboards.operations.get
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/operations/{operationsId}
Parameters:
name
Location: path
Description: The name of the operation resource.
Pattern: ^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/operations/[^/]+$
Required: Yes
Type: string
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.
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1beta1/{+name}
Parameter Order: name
▼ ▲ aiplatform.projects.locations.tensorboards.operations.cancel
Path: v1beta1/{+name}:cancel
HTTP Method: POST
Parameters:
name
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/operations/[^/]+$
Description: The name of the operation resource to be cancelled.
Type: string
Location: path
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/operations/{operationsId}:cancel
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
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`.
▼ ▲ aiplatform.projects.locations.tensorboards.operations.wait
HTTP Method: POST
Path: v1beta1/{+name}:wait
Parameters:
timeout
Format: google-duration
Type: string
Location: query
Description: The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
name
Location: path
Type: string
Required: Yes
Description: The name of the operation resource to wait on.
Pattern: ^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/operations/[^/]+$
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/operations/{operationsId}:wait
Description: Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
Parameter Order: name
▼ ▲ aiplatform.projects.locations.tensorboards.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`.
Path: v1beta1/{+name}
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
name
Description: The name of the operation resource to be deleted.
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/operations/[^/]+$
Required: Yes
Location: path
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/operations/{operationsId}
HTTP Method: DELETE
▼ ▲ aiplatform.projects.locations.tensorboards.operations.list
Path: v1beta1/{+name}/operations
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: GET
Parameter Order: name
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/operations
Description: Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
Parameters:
pageSize
Type: integer
Format: int32
Description: The standard list page size.
Location: query
pageToken
Location: query
Type: string
Description: The standard list page token.
filter
Type: string
Location: query
Description: The standard list filter.
name
Pattern: ^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+$
Location: path
Required: Yes
Type: string
Description: The name of the operation's parent resource.
▼ ▲ aiplatform.projects.locations.tensorboards.delete
HTTP Method: DELETE
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Deletes a Tensorboard.
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}
Path: v1beta1/{+name}
Parameters:
name
Type: string
Required: Yes
Description: Required. The name of the Tensorboard to be deleted. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+$
▼ ▲ aiplatform.projects.locations.tensorboards.get
Description: Gets a Tensorboard.
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}
Path: v1beta1/{+name}
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
HTTP Method: GET
Parameters:
name
Description: Required. The name of the Tensorboard resource. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+$
Type: string
Required: Yes
▼ ▲ aiplatform.projects.locations.tensorboards.readSize
Description: Returns the storage size for a given TensorBoard instance.
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}:readSize
Path: v1beta1/{+tensorboard}:readSize
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: tensorboard
Parameters:
tensorboard
Type: string
Location: path
Required: Yes
Description: Required. The name of the Tensorboard resource. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`
Pattern: ^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+$
HTTP Method: GET
▼ ▲ aiplatform.projects.locations.tensorboards.patch
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: PATCH
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}
Parameters:
updateMask
Format: google-fieldmask
Description: Required. Field mask is used to specify the fields to be overwritten in the Tensorboard resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it's in the mask. If the user does not provide a mask then all fields are overwritten if new values are specified.
Location: query
Type: string
name
Location: path
Type: string
Required: Yes
Description: Output only. Name of the Tensorboard. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`
Pattern: ^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+$
Path: v1beta1/{+name}
Description: Updates a Tensorboard.
Parameter Order: name
▼ ▲ aiplatform.projects.locations.tensorboards.create
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards
Path: v1beta1/{+parent}/tensorboards
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: POST
Parameters:
parent
Description: Required. The resource name of the Location to create the Tensorboard in. Format: `projects/{project}/locations/{location}`
Required: Yes
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+$
Location: path
Parameter Order: parent
Description: Creates a Tensorboard.
▼ ▲ aiplatform.projects.locations.tensorboards.list
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards
HTTP Method: GET
Path: v1beta1/{+parent}/tensorboards
Parameters:
filter
Type: string
Location: query
Description: Lists the Tensorboards that match the filter expression.
readMask
Format: google-fieldmask
Type: string
Location: query
Description: Mask specifying which fields to read.
orderBy
Location: query
Description: Field to use to sort the list.
Type: string
pageToken
Location: query
Type: string
Description: A page token, received from a previous TensorboardService.ListTensorboards call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to TensorboardService.ListTensorboards must match the call that provided the page token.
pageSize
Format: int32
Type: integer
Description: The maximum number of Tensorboards to return. The service may return fewer than this value. If unspecified, at most 100 Tensorboards are returned. The maximum value is 100; values above 100 are coerced to 100.
Location: query
parent
Required: Yes
Description: Required. The resource name of the Location to list Tensorboards. Format: `projects/{project}/locations/{location}`
Location: path
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+$
Description: Lists Tensorboards in a Location.
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: parent
▼ ▲ aiplatform.projects.locations.tensorboards.readUsage
Parameters:
tensorboard
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+$
Description: Required. The name of the Tensorboard resource. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`
Location: path
Type: string
HTTP Method: GET
Path: v1beta1/{+tensorboard}:readUsage
Parameter Order: tensorboard
Description: Returns a list of monthly active users for a given TensorBoard instance.
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}:readUsage
▼ ▲ aiplatform.projects.locations.migratableResources.operations.cancel
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/migratableResources/{migratableResourcesId}/operations/{operationsId}: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`.
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+/migratableResources/[^/]+/operations/[^/]+$
Required: Yes
Type: string
Location: path
Description: The name of the operation resource to be cancelled.
Path: v1beta1/{+name}:cancel
HTTP Method: POST
▼ ▲ aiplatform.projects.locations.migratableResources.operations.delete
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/migratableResources/{migratableResourcesId}/operations/{operationsId}
Parameters:
name
Required: Yes
Type: string
Description: The name of the operation resource to be deleted.
Pattern: ^projects/[^/]+/locations/[^/]+/migratableResources/[^/]+/operations/[^/]+$
Location: path
Path: v1beta1/{+name}
Parameter Order: name
HTTP Method: 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`.
▼ ▲ aiplatform.projects.locations.migratableResources.operations.get
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1beta1/{+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.
Parameter Order: name
Parameters:
name
Required: Yes
Type: string
Location: path
Description: The name of the operation resource.
Pattern: ^projects/[^/]+/locations/[^/]+/migratableResources/[^/]+/operations/[^/]+$
HTTP Method: GET
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/migratableResources/{migratableResourcesId}/operations/{operationsId}
▼ ▲ aiplatform.projects.locations.migratableResources.operations.list
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/migratableResources/{migratableResourcesId}/operations
Parameters:
pageSize
Format: int32
Type: integer
Description: The standard list page size.
Location: query
name
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/migratableResources/[^/]+$
Required: Yes
Location: path
Description: The name of the operation's parent resource.
pageToken
Type: string
Location: query
Description: The standard list page token.
filter
Location: query
Description: The standard list filter.
Type: string
HTTP Method: GET
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1beta1/{+name}/operations
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
▼ ▲ aiplatform.projects.locations.migratableResources.operations.wait
Parameter Order: name
Parameters:
timeout
Type: string
Location: query
Description: The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
Format: google-duration
name
Pattern: ^projects/[^/]+/locations/[^/]+/migratableResources/[^/]+/operations/[^/]+$
Description: The name of the operation resource to wait on.
Location: path
Required: Yes
Type: string
Path: v1beta1/{+name}:wait
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/migratableResources/{migratableResourcesId}/operations/{operationsId}:wait
HTTP Method: POST
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
▼ ▲ aiplatform.projects.locations.migratableResources.batchMigrate
Parameters:
parent
Description: Required. The location of the migrated resource will live in. Format: `projects/{project}/locations/{location}`
Required: Yes
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+$
Type: string
Parameter Order: parent
Path: v1beta1/{+parent}/migratableResources:batchMigrate
HTTP Method: POST
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/migratableResources:batchMigrate
Description: Batch migrates resources from ml.googleapis.com, automl.googleapis.com, and datalabeling.googleapis.com to Vertex AI.
▼ ▲ aiplatform.projects.locations.migratableResources.search
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/migratableResources:search
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: POST
Description: Searches all of the resources in automl.googleapis.com, datalabeling.googleapis.com and ml.googleapis.com that can be migrated to Vertex AI's given location.
Parameters:
parent
Location: path
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+$
Description: Required. The location that the migratable resources should be searched from. It's the Vertex AI location that the resources can be migrated to, not the resources' original location. Format: `projects/{project}/locations/{location}`
Type: string
Path: v1beta1/{+parent}/migratableResources:search
▼ ▲ aiplatform.projects.locations.metadataStores.get
Path: v1beta1/{+name}
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}
HTTP Method: GET
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
name
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+$
Location: path
Description: Required. The resource name of the MetadataStore to retrieve. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}`
Type: string
Description: Retrieves a specific MetadataStore.
Parameter Order: name
▼ ▲ aiplatform.projects.locations.metadataStores.create
Parameters:
parent
Pattern: ^projects/[^/]+/locations/[^/]+$
Required: Yes
Description: Required. The resource name of the Location where the MetadataStore should be created. Format: `projects/{project}/locations/{location}/`
Location: path
Type: string
metadataStoreId
Description: The {metadatastore} portion of the resource name with the format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}` If not provided, the MetadataStore's ID will be a UUID generated by the service. Must be 4-128 characters in length. Valid characters are `/a-z-/`. Must be unique across all MetadataStores in the parent Location. (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED if the caller can't view the preexisting MetadataStore.)
Type: string
Location: query
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Initializes a MetadataStore, including allocation of resources.
Parameter Order: parent
HTTP Method: POST
Path: v1beta1/{+parent}/metadataStores
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores
▼ ▲ aiplatform.projects.locations.metadataStores.list
HTTP Method: GET
Parameter Order: parent
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores
Parameters:
parent
Required: Yes
Location: path
Description: Required. The Location whose MetadataStores should be listed. Format: `projects/{project}/locations/{location}`
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+$
pageSize
Format: int32
Location: query
Type: integer
Description: The maximum number of Metadata Stores to return. The service may return fewer. Must be in range 1-1000, inclusive. Defaults to 100.
pageToken
Location: query
Description: A page token, received from a previous MetadataService.ListMetadataStores call. Provide this to retrieve the subsequent page. When paginating, all other provided parameters must match the call that provided the page token. (Otherwise the request will fail with INVALID_ARGUMENT error.)
Type: string
Description: Lists MetadataStores for a Location.
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1beta1/{+parent}/metadataStores
▼ ▲ aiplatform.projects.locations.metadataStores.delete
Description: Deletes a single MetadataStore and all its child resources (Artifacts, Executions, and Contexts).
HTTP Method: DELETE
Parameters:
force
Description: Deprecated: Field is no longer supported.
Location: query
Type: boolean
Deprecated: Yes
name
Description: Required. The resource name of the MetadataStore to delete. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}`
Pattern: ^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+$
Required: Yes
Location: path
Type: string
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}
Path: v1beta1/{+name}
▼ ▲ aiplatform.projects.locations.metadataStores.executions.list
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions
Parameter Order: parent
Parameters:
filter
Description: Filter specifying the boolean condition for the Executions to satisfy in order to be part of the result set. The syntax to define filter query is based on https://google.aip.dev/160. Following are the supported set of filters: * **Attribute filtering**: For example: `display_name = "test"`. Supported fields include: `name`, `display_name`, `state`, `schema_title`, `create_time`, and `update_time`. Time fields, such as `create_time` and `update_time`, require values specified in RFC-3339 format. For example: `create_time = "2020-11-19T11:30:00-04:00"`. * **Metadata field**: To filter on metadata fields use traversal operation as follows: `metadata..` For example: `metadata.field_1.number_value = 10.0` In case the field name contains special characters (such as colon), one can embed it inside double quote. For example: `metadata."field:1".number_value = 10.0` * **Context based filtering**: To filter Executions based on the contexts to which they belong use the function operator with the full resource name: `in_context()`. For example: `in_context("projects//locations//metadataStores//contexts/")` Each of the above supported filters can be combined together using logical operators (`AND` & `OR`). Maximum nested expression depth allowed is 5. For example: `display_name = "test" AND metadata.field1.bool_value = true`.
Location: query
Type: string
orderBy
Description: How the list of messages is ordered. Specify the values to order by and an ordering operation. The default sorting order is ascending. To specify descending order for a field, users append a " desc" suffix; for example: "foo desc, bar". Subfields are specified with a `.` character, such as foo.bar. see https://google.aip.dev/132#ordering for more details.
Location: query
Type: string
pageToken
Location: query
Description: A page token, received from a previous MetadataService.ListExecutions call. Provide this to retrieve the subsequent page. When paginating, all other provided parameters must match the call that provided the page token. (Otherwise the request will fail with an INVALID_ARGUMENT error.)
Type: string
pageSize
Format: int32
Location: query
Type: integer
Description: The maximum number of Executions to return. The service may return fewer. Must be in range 1-1000, inclusive. Defaults to 100.
parent
Location: path
Description: Required. The MetadataStore whose Executions should be listed. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}`
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+$
Type: string
Description: Lists Executions in the MetadataStore.
Path: v1beta1/{+parent}/executions
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: GET
▼ ▲ aiplatform.projects.locations.metadataStores.executions.get
Description: Retrieves a specific Execution.
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions/{executionsId}
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
Parameters:
name
Location: path
Type: string
Description: Required. The resource name of the Execution to retrieve. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution}`
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/executions/[^/]+$
Path: v1beta1/{+name}
HTTP Method: GET
▼ ▲ aiplatform.projects.locations.metadataStores.executions.addExecutionEvents
HTTP Method: POST
Description: Adds Events to the specified Execution. An Event indicates whether an Artifact was used as an input or output for an Execution. If an Event already exists between the Execution and the Artifact, the Event is skipped.
Path: v1beta1/{+execution}:addExecutionEvents
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions/{executionsId}:addExecutionEvents
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: execution
Parameters:
execution
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/executions/[^/]+$
Required: Yes
Type: string
Description: Required. The resource name of the Execution that the Events connect Artifacts with. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution}`
▼ ▲ aiplatform.projects.locations.metadataStores.executions.purge
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions:purge
Description: Purges Executions.
Parameters:
parent
Required: Yes
Location: path
Description: Required. The metadata store to purge Executions from. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}`
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+$
Parameter Order: parent
Path: v1beta1/{+parent}/executions:purge
HTTP Method: POST
▼ ▲ aiplatform.projects.locations.metadataStores.executions.patch
HTTP Method: PATCH
Description: Updates a stored Execution.
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
Path: v1beta1/{+name}
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions/{executionsId}
Parameters:
name
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/executions/[^/]+$
Required: Yes
Location: path
Description: Output only. The resource name of the Execution.
allowMissing
Location: query
Type: boolean
Description: If set to true, and the Execution is not found, a new Execution is created.
updateMask
Type: string
Description: Optional. A FieldMask indicating which fields should be updated.
Location: query
Format: google-fieldmask
▼ ▲ aiplatform.projects.locations.metadataStores.executions.delete
Path: v1beta1/{+name}
HTTP Method: DELETE
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions/{executionsId}
Description: Deletes an Execution.
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/executions/[^/]+$
Required: Yes
Location: path
Type: string
Description: Required. The resource name of the Execution to delete. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution}`
etag
Description: Optional. The etag of the Execution to delete. If this is provided, it must match the server's etag. Otherwise, the request will fail with a FAILED_PRECONDITION.
Type: string
Location: query
Parameter Order: name
▼ ▲ aiplatform.projects.locations.metadataStores.executions.queryExecutionInputsAndOutputs
Parameter Order: execution
Path: v1beta1/{+execution}:queryExecutionInputsAndOutputs
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions/{executionsId}:queryExecutionInputsAndOutputs
HTTP Method: GET
Parameters:
execution
Pattern: ^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/executions/[^/]+$
Required: Yes
Description: Required. The resource name of the Execution whose input and output Artifacts should be retrieved as a LineageSubgraph. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution}`
Location: path
Type: string
Description: Obtains the set of input and output Artifacts for this Execution, in the form of LineageSubgraph that also contains the Execution and connecting Events.
▼ ▲ aiplatform.projects.locations.metadataStores.executions.create
Description: Creates an Execution associated with a MetadataStore.
HTTP Method: POST
Parameter Order: parent
Parameters:
executionId
Type: string
Description: The {execution} portion of the resource name with the format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution}` If not provided, the Execution's ID will be a UUID generated by the service. Must be 4-128 characters in length. Valid characters are `/a-z-/`. Must be unique across all Executions in the parent MetadataStore. (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED if the caller can't view the preexisting Execution.)
Location: query
parent
Type: string
Description: Required. The resource name of the MetadataStore where the Execution should be created. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}`
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+$
Location: path
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions
Path: v1beta1/{+parent}/executions
▼ ▲ aiplatform.projects.locations.metadataStores.metadataSchemas.list
Parameters:
parent
Pattern: ^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+$
Description: Required. The MetadataStore whose MetadataSchemas should be listed. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}`
Type: string
Location: path
Required: Yes
filter
Description: A query to filter available MetadataSchemas for matching results.
Location: query
Type: string
pageToken
Type: string
Location: query
Description: A page token, received from a previous MetadataService.ListMetadataSchemas call. Provide this to retrieve the next page. When paginating, all other provided parameters must match the call that provided the page token. (Otherwise the request will fail with INVALID_ARGUMENT error.)
pageSize
Description: The maximum number of MetadataSchemas to return. The service may return fewer. Must be in range 1-1000, inclusive. Defaults to 100.
Location: query
Type: integer
Format: int32
HTTP Method: GET
Parameter Order: parent
Description: Lists MetadataSchemas.
Path: v1beta1/{+parent}/metadataSchemas
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/metadataSchemas
▼ ▲ aiplatform.projects.locations.metadataStores.metadataSchemas.create
Path: v1beta1/{+parent}/metadataSchemas
Parameter Order: parent
Description: Creates a MetadataSchema.
HTTP Method: POST
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/metadataSchemas
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
parent
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+$
Description: Required. The resource name of the MetadataStore where the MetadataSchema should be created. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}`
Required: Yes
Location: path
metadataSchemaId
Description: The {metadata_schema} portion of the resource name with the format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/metadataSchemas/{metadataschema}` If not provided, the MetadataStore's ID will be a UUID generated by the service. Must be 4-128 characters in length. Valid characters are `/a-z-/`. Must be unique across all MetadataSchemas in the parent Location. (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED if the caller can't view the preexisting MetadataSchema.)
Location: query
Type: string
▼ ▲ aiplatform.projects.locations.metadataStores.metadataSchemas.get
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/metadataSchemas/{metadataSchemasId}
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
Parameters:
name
Required: Yes
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/metadataSchemas/[^/]+$
Description: Required. The resource name of the MetadataSchema to retrieve. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/metadataSchemas/{metadataschema}`
Location: path
Path: v1beta1/{+name}
HTTP Method: GET
Description: Retrieves a specific MetadataSchema.
▼ ▲ aiplatform.projects.locations.metadataStores.artifacts.purge
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts:purge
Path: v1beta1/{+parent}/artifacts:purge
Parameters:
parent
Location: path
Description: Required. The metadata store to purge Artifacts from. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}`
Pattern: ^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+$
Type: string
Required: Yes
Description: Purges Artifacts.
HTTP Method: POST
Parameter Order: parent
▼ ▲ aiplatform.projects.locations.metadataStores.artifacts.list
Path: v1beta1/{+parent}/artifacts
Description: Lists Artifacts in the MetadataStore.
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: parent
HTTP Method: GET
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts
Parameters:
parent
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+$
Required: Yes
Location: path
Description: Required. The MetadataStore whose Artifacts should be listed. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}`
orderBy
Type: string
Location: query
Description: How the list of messages is ordered. Specify the values to order by and an ordering operation. The default sorting order is ascending. To specify descending order for a field, users append a " desc" suffix; for example: "foo desc, bar". Subfields are specified with a `.` character, such as foo.bar. see https://google.aip.dev/132#ordering for more details.
filter
Location: query
Type: string
Description: Filter specifying the boolean condition for the Artifacts to satisfy in order to be part of the result set. The syntax to define filter query is based on https://google.aip.dev/160. The supported set of filters include the following: * **Attribute filtering**: For example: `display_name = "test"`. Supported fields include: `name`, `display_name`, `uri`, `state`, `schema_title`, `create_time`, and `update_time`. Time fields, such as `create_time` and `update_time`, require values specified in RFC-3339 format. For example: `create_time = "2020-11-19T11:30:00-04:00"` * **Metadata field**: To filter on metadata fields use traversal operation as follows: `metadata..`. For example: `metadata.field_1.number_value = 10.0` In case the field name contains special characters (such as colon), one can embed it inside double quote. For example: `metadata."field:1".number_value = 10.0` * **Context based filtering**: To filter Artifacts based on the contexts to which they belong, use the function operator with the full resource name `in_context()`. For example: `in_context("projects//locations//metadataStores//contexts/")` Each of the above supported filter types can be combined together using logical operators (`AND` & `OR`). Maximum nested expression depth allowed is 5. For example: `display_name = "test" AND metadata.field1.bool_value = true`.
pageToken
Description: A page token, received from a previous MetadataService.ListArtifacts call. Provide this to retrieve the subsequent page. When paginating, all other provided parameters must match the call that provided the page token. (Otherwise the request will fail with INVALID_ARGUMENT error.)
Type: string
Location: query
pageSize
Description: The maximum number of Artifacts to return. The service may return fewer. Must be in range 1-1000, inclusive. Defaults to 100.
Location: query
Type: integer
Format: int32
▼ ▲ aiplatform.projects.locations.metadataStores.artifacts.delete
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts/{artifactsId}
Description: Deletes an Artifact.
Path: v1beta1/{+name}
Parameters:
etag
Location: query
Type: string
Description: Optional. The etag of the Artifact to delete. If this is provided, it must match the server's etag. Otherwise, the request will fail with a FAILED_PRECONDITION.
name
Description: Required. The resource name of the Artifact to delete. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/artifacts/{artifact}`
Required: Yes
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/artifacts/[^/]+$
Location: path
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
HTTP Method: DELETE
▼ ▲ aiplatform.projects.locations.metadataStores.artifacts.get
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts/{artifactsId}
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: GET
Parameter Order: name
Parameters:
name
Description: Required. The resource name of the Artifact to retrieve. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/artifacts/{artifact}`
Required: Yes
Location: path
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/artifacts/[^/]+$
Path: v1beta1/{+name}
Description: Retrieves a specific Artifact.
▼ ▲ aiplatform.projects.locations.metadataStores.artifacts.patch
HTTP Method: PATCH
Parameters:
updateMask
Type: string
Location: query
Description: Optional. A FieldMask indicating which fields should be updated.
Format: google-fieldmask
allowMissing
Location: query
Type: boolean
Description: If set to true, and the Artifact is not found, a new Artifact is created.
name
Description: Output only. The resource name of the Artifact.
Required: Yes
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/artifacts/[^/]+$
Location: path
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts/{artifactsId}
Description: Updates a stored Artifact.
Path: v1beta1/{+name}
▼ ▲ aiplatform.projects.locations.metadataStores.artifacts.queryArtifactLineageSubgraph
HTTP Method: GET
Parameters:
filter
Description: Filter specifying the boolean condition for the Artifacts to satisfy in order to be part of the Lineage Subgraph. The syntax to define filter query is based on https://google.aip.dev/160. The supported set of filters include the following: * **Attribute filtering**: For example: `display_name = "test"` Supported fields include: `name`, `display_name`, `uri`, `state`, `schema_title`, `create_time`, and `update_time`. Time fields, such as `create_time` and `update_time`, require values specified in RFC-3339 format. For example: `create_time = "2020-11-19T11:30:00-04:00"` * **Metadata field**: To filter on metadata fields use traversal operation as follows: `metadata..`. For example: `metadata.field_1.number_value = 10.0` In case the field name contains special characters (such as colon), one can embed it inside double quote. For example: `metadata."field:1".number_value = 10.0` Each of the above supported filter types can be combined together using logical operators (`AND` & `OR`). Maximum nested expression depth allowed is 5. For example: `display_name = "test" AND metadata.field1.bool_value = true`.
Location: query
Type: string
artifact
Description: Required. The resource name of the Artifact whose Lineage needs to be retrieved as a LineageSubgraph. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/artifacts/{artifact}` The request may error with FAILED_PRECONDITION if the number of Artifacts, the number of Executions, or the number of Events that would be returned for the Context exceeds 1000.
Pattern: ^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/artifacts/[^/]+$
Required: Yes
Location: path
Type: string
maxHops
Location: query
Format: int32
Type: integer
Description: Specifies the size of the lineage graph in terms of number of hops from the specified artifact. Negative Value: INVALID_ARGUMENT error is returned 0: Only input artifact is returned. No value: Transitive closure is performed to return the complete graph.
Parameter Order: artifact
Path: v1beta1/{+artifact}:queryArtifactLineageSubgraph
Description: Retrieves lineage of an Artifact represented through Artifacts and Executions connected by Event edges and returned as a LineageSubgraph.
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts/{artifactsId}:queryArtifactLineageSubgraph
▼ ▲ aiplatform.projects.locations.metadataStores.artifacts.create
Path: v1beta1/{+parent}/artifacts
Parameters:
parent
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+$
Required: Yes
Location: path
Description: Required. The resource name of the MetadataStore where the Artifact should be created. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}`
artifactId
Location: query
Type: string
Description: The {artifact} portion of the resource name with the format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/artifacts/{artifact}` If not provided, the Artifact's ID will be a UUID generated by the service. Must be 4-128 characters in length. Valid characters are `/a-z-/`. Must be unique across all Artifacts in the parent MetadataStore. (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED if the caller can't view the preexisting Artifact.)
Parameter Order: parent
Description: Creates an Artifact associated with a MetadataStore.
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts
HTTP Method: POST
▼ ▲ aiplatform.projects.locations.metadataStores.contexts.create
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1beta1/{+parent}/contexts
Parameter Order: parent
HTTP Method: POST
Parameters:
parent
Description: Required. The resource name of the MetadataStore where the Context should be created. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}`
Type: string
Required: Yes
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+$
contextId
Location: query
Description: The {context} portion of the resource name with the format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}`. If not provided, the Context's ID will be a UUID generated by the service. Must be 4-128 characters in length. Valid characters are `/a-z-/`. Must be unique across all Contexts in the parent MetadataStore. (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED if the caller can't view the preexisting Context.)
Type: string
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts
Description: Creates a Context associated with a MetadataStore.
▼ ▲ aiplatform.projects.locations.metadataStores.contexts.purge
Description: Purges Contexts.
HTTP Method: POST
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts:purge
Parameter Order: parent
Path: v1beta1/{+parent}/contexts:purge
Parameters:
parent
Location: path
Description: Required. The metadata store to purge Contexts from. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}`
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+$
Type: string
▼ ▲ aiplatform.projects.locations.metadataStores.contexts.patch
HTTP Method: PATCH
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
updateMask
Format: google-fieldmask
Description: Optional. A FieldMask indicating which fields should be updated.
Type: string
Location: query
name
Location: path
Description: Output only. The resource name of the Context.
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/contexts/[^/]+$
Type: string
allowMissing
Location: query
Type: boolean
Description: If set to true, and the Context is not found, a new Context is created.
Parameter Order: name
Description: Updates a stored Context.
Path: v1beta1/{+name}
▼ ▲ aiplatform.projects.locations.metadataStores.contexts.addContextArtifactsAndExecutions
Description: Adds a set of Artifacts and Executions to a Context. If any of the Artifacts or Executions have already been added to a Context, they are simply skipped.
Path: v1beta1/{+context}:addContextArtifactsAndExecutions
HTTP Method: POST
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
context
Description: Required. The resource name of the Context that the Artifacts and Executions belong to. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}`
Required: Yes
Location: path
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/contexts/[^/]+$
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}:addContextArtifactsAndExecutions
Parameter Order: context
▼ ▲ aiplatform.projects.locations.metadataStores.contexts.delete
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}
Description: Deletes a stored Context.
Path: v1beta1/{+name}
Parameters:
name
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/contexts/[^/]+$
Required: Yes
Description: Required. The resource name of the Context to delete. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}`
Type: string
force
Description: The force deletion semantics is still undefined. Users should not use this field.
Location: query
Type: boolean
etag
Location: query
Description: Optional. The etag of the Context to delete. If this is provided, it must match the server's etag. Otherwise, the request will fail with a FAILED_PRECONDITION.
Type: string
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
HTTP Method: DELETE
▼ ▲ aiplatform.projects.locations.metadataStores.contexts.addContextChildren
HTTP Method: POST
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}:addContextChildren
Path: v1beta1/{+context}:addContextChildren
Description: Adds a set of Contexts as children to a parent Context. If any of the child Contexts have already been added to the parent Context, they are simply skipped. If this call would create a cycle or cause any Context to have more than 10 parents, the request will fail with an INVALID_ARGUMENT error.
Parameter Order: context
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
context
Description: Required. The resource name of the parent Context. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}`
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/contexts/[^/]+$
Location: path
Type: string
▼ ▲ aiplatform.projects.locations.metadataStores.contexts.list
HTTP Method: GET
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts
Description: Lists Contexts on the MetadataStore.
Path: v1beta1/{+parent}/contexts
Parameters:
filter
Description: Filter specifying the boolean condition for the Contexts to satisfy in order to be part of the result set. The syntax to define filter query is based on https://google.aip.dev/160. Following are the supported set of filters: * **Attribute filtering**: For example: `display_name = "test"`. Supported fields include: `name`, `display_name`, `schema_title`, `create_time`, and `update_time`. Time fields, such as `create_time` and `update_time`, require values specified in RFC-3339 format. For example: `create_time = "2020-11-19T11:30:00-04:00"`. * **Metadata field**: To filter on metadata fields use traversal operation as follows: `metadata..`. For example: `metadata.field_1.number_value = 10.0`. In case the field name contains special characters (such as colon), one can embed it inside double quote. For example: `metadata."field:1".number_value = 10.0` * **Parent Child filtering**: To filter Contexts based on parent-child relationship use the HAS operator as follows: ``` parent_contexts: "projects//locations//metadataStores//contexts/" child_contexts: "projects//locations//metadataStores//contexts/" ``` Each of the above supported filters can be combined together using logical operators (`AND` & `OR`). Maximum nested expression depth allowed is 5. For example: `display_name = "test" AND metadata.field1.bool_value = true`.
Type: string
Location: query
pageSize
Description: The maximum number of Contexts to return. The service may return fewer. Must be in range 1-1000, inclusive. Defaults to 100.
Format: int32
Location: query
Type: integer
parent
Description: Required. The MetadataStore whose Contexts should be listed. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}`
Required: Yes
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+$
Location: path
orderBy
Description: How the list of messages is ordered. Specify the values to order by and an ordering operation. The default sorting order is ascending. To specify descending order for a field, users append a " desc" suffix; for example: "foo desc, bar". Subfields are specified with a `.` character, such as foo.bar. see https://google.aip.dev/132#ordering for more details.
Type: string
Location: query
pageToken
Location: query
Description: A page token, received from a previous MetadataService.ListContexts call. Provide this to retrieve the subsequent page. When paginating, all other provided parameters must match the call that provided the page token. (Otherwise the request will fail with INVALID_ARGUMENT error.)
Type: string
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: parent
▼ ▲ aiplatform.projects.locations.metadataStores.contexts.removeContextChildren
Path: v1beta1/{+context}:removeContextChildren
Parameter Order: context
HTTP Method: POST
Parameters:
context
Type: string
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/contexts/[^/]+$
Description: Required. The resource name of the parent Context. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}`
Required: Yes
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}:removeContextChildren
Description: Remove a set of children contexts from a parent Context. If any of the child Contexts were NOT added to the parent Context, they are simply skipped.
▼ ▲ aiplatform.projects.locations.metadataStores.contexts.get
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
name
Description: Required. The resource name of the Context to retrieve. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}`
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/contexts/[^/]+$
Required: Yes
Type: string
Description: Retrieves a specific Context.
HTTP Method: GET
Path: v1beta1/{+name}
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}
▼ ▲ aiplatform.projects.locations.metadataStores.contexts.queryContextLineageSubgraph
Description: Retrieves Artifacts and Executions within the specified Context, connected by Event edges and returned as a LineageSubgraph.
Parameters:
context
Required: Yes
Location: path
Description: Required. The resource name of the Context whose Artifacts and Executions should be retrieved as a LineageSubgraph. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}` The request may error with FAILED_PRECONDITION if the number of Artifacts, the number of Executions, or the number of Events that would be returned for the Context exceeds 1000.
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/contexts/[^/]+$
HTTP Method: GET
Path: v1beta1/{+context}:queryContextLineageSubgraph
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}:queryContextLineageSubgraph
Parameter Order: context
▼ ▲ aiplatform.projects.locations.edgeDevices.operations.cancel
Path: v1beta1/{+name}:cancel
Parameter Order: name
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/edgeDevices/{edgeDevicesId}/operations/{operationsId}:cancel
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
name
Type: string
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/edgeDevices/[^/]+/operations/[^/]+$
Description: The name of the operation resource to be cancelled.
Required: Yes
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
▼ ▲ aiplatform.projects.locations.edgeDevices.operations.list
Path: v1beta1/{+name}/operations
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/edgeDevices/{edgeDevicesId}/operations
Parameters:
filter
Type: string
Location: query
Description: The standard list filter.
pageSize
Location: query
Type: integer
Description: The standard list page size.
Format: int32
name
Location: path
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/edgeDevices/[^/]+$
Type: string
Description: The name of the operation's parent resource.
pageToken
Type: string
Description: The standard list page token.
Location: query
Parameter Order: name
HTTP Method: GET
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
▼ ▲ aiplatform.projects.locations.edgeDevices.operations.delete
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
Path: v1beta1/{+name}
HTTP Method: 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`.
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/edgeDevices/{edgeDevicesId}/operations/{operationsId}
Parameters:
name
Description: The name of the operation resource to be deleted.
Required: Yes
Type: string
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/edgeDevices/[^/]+/operations/[^/]+$
▼ ▲ aiplatform.projects.locations.edgeDevices.operations.get
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/edgeDevices/{edgeDevicesId}/operations/{operationsId}
Parameter Order: name
HTTP Method: GET
Path: v1beta1/{+name}
Parameters:
name
Description: The name of the operation resource.
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/edgeDevices/[^/]+/operations/[^/]+$
Required: Yes
Type: string
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.
▼ ▲ aiplatform.projects.locations.edgeDevices.operations.wait
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/edgeDevices/{edgeDevicesId}/operations/{operationsId}:wait
HTTP Method: POST
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
name
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/edgeDevices/[^/]+/operations/[^/]+$
Description: The name of the operation resource to wait on.
Type: string
Required: Yes
timeout
Format: google-duration
Location: query
Description: The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
Type: string
Description: Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
Path: v1beta1/{+name}:wait
Parameter Order: name
▼ ▲ aiplatform.projects.locations.deploymentResourcePools.create
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools
HTTP Method: POST
Parameters:
parent
Description: Required. The parent location resource where this DeploymentResourcePool will be created. Format: `projects/{project}/locations/{location}`
Required: Yes
Type: string
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+$
Description: Create a DeploymentResourcePool.
Path: v1beta1/{+parent}/deploymentResourcePools
Parameter Order: parent
▼ ▲ aiplatform.projects.locations.deploymentResourcePools.list
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools
Parameter Order: parent
Description: List DeploymentResourcePools in a location.
Path: v1beta1/{+parent}/deploymentResourcePools
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: GET
Parameters:
pageSize
Type: integer
Description: The maximum number of DeploymentResourcePools to return. The service may return fewer than this value.
Format: int32
Location: query
parent
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+$
Description: Required. The parent Location which owns this collection of DeploymentResourcePools. Format: `projects/{project}/locations/{location}`
Type: string
Location: path
pageToken
Location: query
Description: A page token, received from a previous `ListDeploymentResourcePools` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListDeploymentResourcePools` must match the call that provided the page token.
Type: string
▼ ▲ aiplatform.projects.locations.deploymentResourcePools.delete
Parameters:
name
Type: string
Description: Required. The name of the DeploymentResourcePool to delete. Format: `projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}`
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/deploymentResourcePools/[^/]+$
Required: Yes
Path: v1beta1/{+name}
Description: Delete a DeploymentResourcePool.
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}
HTTP Method: DELETE
▼ ▲ aiplatform.projects.locations.deploymentResourcePools.get
Parameter Order: name
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Get a DeploymentResourcePool.
Parameters:
name
Type: string
Location: path
Description: Required. The name of the DeploymentResourcePool to retrieve. Format: `projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}`
Pattern: ^projects/[^/]+/locations/[^/]+/deploymentResourcePools/[^/]+$
Required: Yes
Path: v1beta1/{+name}
HTTP Method: GET
▼ ▲ aiplatform.projects.locations.deploymentResourcePools.queryDeployedModels
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}:queryDeployedModels
HTTP Method: GET
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: deploymentResourcePool
Path: v1beta1/{+deploymentResourcePool}:queryDeployedModels
Description: List DeployedModels that have been deployed on this DeploymentResourcePool.
Parameters:
pageToken
Type: string
Location: query
Description: A page token, received from a previous `QueryDeployedModels` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `QueryDeployedModels` must match the call that provided the page token.
deploymentResourcePool
Description: Required. The name of the target DeploymentResourcePool to query. Format: `projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}`
Pattern: ^projects/[^/]+/locations/[^/]+/deploymentResourcePools/[^/]+$
Required: Yes
Location: path
Type: string
pageSize
Location: query
Type: integer
Format: int32
Description: The maximum number of DeployedModels to return. The service may return fewer than this value.
▼ ▲ aiplatform.projects.locations.deploymentResourcePools.operations.get
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}/operations/{operationsId}
Scopes: https://www.googleapis.com/auth/cloud-platform
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.
Path: v1beta1/{+name}
Parameters:
name
Type: string
Location: path
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/deploymentResourcePools/[^/]+/operations/[^/]+$
Description: The name of the operation resource.
Parameter Order: name
▼ ▲ aiplatform.projects.locations.deploymentResourcePools.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
Path: v1beta1/{+name}
Parameter Order: name
Parameters:
name
Type: string
Description: The name of the operation resource to be deleted.
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/deploymentResourcePools/[^/]+/operations/[^/]+$
Location: path
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}/operations/{operationsId}
HTTP Method: DELETE
▼ ▲ aiplatform.projects.locations.deploymentResourcePools.operations.list
Path: v1beta1/{+name}/operations
Parameters:
pageToken
Description: The standard list page token.
Location: query
Type: string
name
Description: The name of the operation's parent resource.
Required: Yes
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/deploymentResourcePools/[^/]+$
Type: string
filter
Type: string
Description: The standard list filter.
Location: query
pageSize
Type: integer
Format: int32
Location: query
Description: The standard list page size.
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: GET
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}/operations
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
▼ ▲ aiplatform.projects.locations.deploymentResourcePools.operations.wait
Parameter Order: name
Description: Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
HTTP Method: POST
Parameters:
name
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/deploymentResourcePools/[^/]+/operations/[^/]+$
Required: Yes
Description: The name of the operation resource to wait on.
Type: string
timeout
Type: string
Location: query
Format: google-duration
Description: The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}/operations/{operationsId}:wait
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1beta1/{+name}:wait
▼ ▲ aiplatform.projects.locations.deploymentResourcePools.operations.cancel
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: POST
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}/operations/{operationsId}:cancel
Path: v1beta1/{+name}: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`.
Parameter Order: name
Parameters:
name
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/deploymentResourcePools/[^/]+/operations/[^/]+$
Description: The name of the operation resource to be cancelled.
Location: path
Type: string
▼ ▲ aiplatform.projects.locations.modelDeploymentMonitoringJobs.operations.cancel
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}/operations/{operationsId}:cancel
Path: v1beta1/{+name}: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`.
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: POST
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+/modelDeploymentMonitoringJobs/[^/]+/operations/[^/]+$
Description: The name of the operation resource to be cancelled.
Type: string
Location: path
Required: Yes
Parameter Order: name
▼ ▲ aiplatform.projects.locations.modelDeploymentMonitoringJobs.operations.wait
Parameter Order: name
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}/operations/{operationsId}:wait
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: POST
Parameters:
name
Type: string
Description: The name of the operation resource to wait on.
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/modelDeploymentMonitoringJobs/[^/]+/operations/[^/]+$
Location: path
timeout
Location: query
Format: google-duration
Description: The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
Type: string
Path: v1beta1/{+name}:wait
Description: Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
▼ ▲ aiplatform.projects.locations.modelDeploymentMonitoringJobs.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
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}/operations
Parameters:
pageSize
Format: int32
Type: integer
Location: query
Description: The standard list page size.
pageToken
Description: The standard list page token.
Type: string
Location: query
name
Description: The name of the operation's parent resource.
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/modelDeploymentMonitoringJobs/[^/]+$
Type: string
Required: Yes
filter
Location: query
Description: The standard list filter.
Type: string
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1beta1/{+name}/operations
HTTP Method: GET
▼ ▲ aiplatform.projects.locations.modelDeploymentMonitoringJobs.operations.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.
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1beta1/{+name}
Parameters:
name
Required: Yes
Location: path
Type: string
Description: The name of the operation resource.
Pattern: ^projects/[^/]+/locations/[^/]+/modelDeploymentMonitoringJobs/[^/]+/operations/[^/]+$
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}/operations/{operationsId}
HTTP Method: GET
▼ ▲ aiplatform.projects.locations.modelDeploymentMonitoringJobs.operations.delete
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}/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`.
Parameters:
name
Required: Yes
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/modelDeploymentMonitoringJobs/[^/]+/operations/[^/]+$
Location: path
Description: The name of the operation resource to be deleted.
HTTP Method: DELETE
Path: v1beta1/{+name}
▼ ▲ aiplatform.projects.locations.modelDeploymentMonitoringJobs.create
Path: v1beta1/{+parent}/modelDeploymentMonitoringJobs
Parameters:
parent
Pattern: ^projects/[^/]+/locations/[^/]+$
Location: path
Type: string
Description: Required. The parent of the ModelDeploymentMonitoringJob. Format: `projects/{project}/locations/{location}`
Required: Yes
Description: Creates a ModelDeploymentMonitoringJob. It will run periodically on a configured interval.
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: parent
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs
HTTP Method: POST
▼ ▲ aiplatform.projects.locations.modelDeploymentMonitoringJobs.searchModelDeploymentMonitoringStatsAnomalies
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}:searchModelDeploymentMonitoringStatsAnomalies
Path: v1beta1/{+modelDeploymentMonitoringJob}:searchModelDeploymentMonitoringStatsAnomalies
Parameters:
modelDeploymentMonitoringJob
Type: string
Location: path
Description: Required. ModelDeploymentMonitoring Job resource name. Format: `projects/{project}/locations/{location}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job}`
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/modelDeploymentMonitoringJobs/[^/]+$
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: modelDeploymentMonitoringJob
HTTP Method: POST
Description: Searches Model Monitoring Statistics generated within a given time window.
▼ ▲ aiplatform.projects.locations.modelDeploymentMonitoringJobs.resume
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}:resume
Parameters:
name
Description: Required. The resource name of the ModelDeploymentMonitoringJob to resume. Format: `projects/{project}/locations/{location}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job}`
Required: Yes
Type: string
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/modelDeploymentMonitoringJobs/[^/]+$
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Resumes a paused ModelDeploymentMonitoringJob. It will start to run from next scheduled time. A deleted ModelDeploymentMonitoringJob can't be resumed.
HTTP Method: POST
Path: v1beta1/{+name}:resume
▼ ▲ aiplatform.projects.locations.modelDeploymentMonitoringJobs.get
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}
Description: Gets a ModelDeploymentMonitoringJob.
Parameter Order: name
Path: v1beta1/{+name}
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+/modelDeploymentMonitoringJobs/[^/]+$
Location: path
Required: Yes
Description: Required. The resource name of the ModelDeploymentMonitoringJob. Format: `projects/{project}/locations/{location}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job}`
Type: string
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: GET
▼ ▲ aiplatform.projects.locations.modelDeploymentMonitoringJobs.pause
HTTP Method: POST
Path: v1beta1/{+name}:pause
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
name
Type: string
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/modelDeploymentMonitoringJobs/[^/]+$
Required: Yes
Description: Required. The resource name of the ModelDeploymentMonitoringJob to pause. Format: `projects/{project}/locations/{location}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job}`
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}:pause
Parameter Order: name
Description: Pauses a ModelDeploymentMonitoringJob. If the job is running, the server makes a best effort to cancel the job. Will mark ModelDeploymentMonitoringJob.state to 'PAUSED'.
▼ ▲ aiplatform.projects.locations.modelDeploymentMonitoringJobs.list
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs
Path: v1beta1/{+parent}/modelDeploymentMonitoringJobs
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: GET
Parameter Order: parent
Parameters:
pageToken
Description: The standard list page token.
Type: string
Location: query
filter
Description: The standard list filter. Supported fields: * `display_name` supports `=`, `!=` comparisons, and `:` wildcard. * `state` supports `=`, `!=` comparisons. * `create_time` supports `=`, `!=`,`<`, `<=`,`>`, `>=` comparisons. `create_time` must be in RFC 3339 format. * `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* - key existence Some examples of using the filter are: * `state="JOB_STATE_SUCCEEDED" AND display_name:"my_job_*"` * `state!="JOB_STATE_FAILED" OR display_name="my_job"` * `NOT display_name="my_job"` * `create_time>"2021-05-18T00:00:00Z"` * `labels.keyA=valueA` * `labels.keyB:*`
Location: query
Type: string
pageSize
Description: The standard list page size.
Location: query
Type: integer
Format: int32
parent
Pattern: ^projects/[^/]+/locations/[^/]+$
Required: Yes
Type: string
Description: Required. The parent of the ModelDeploymentMonitoringJob. Format: `projects/{project}/locations/{location}`
Location: path
readMask
Format: google-fieldmask
Type: string
Location: query
Description: Mask specifying which fields to read
Description: Lists ModelDeploymentMonitoringJobs in a Location.
▼ ▲ aiplatform.projects.locations.modelDeploymentMonitoringJobs.delete
Path: v1beta1/{+name}
Parameters:
name
Location: path
Required: Yes
Description: Required. The resource name of the model monitoring job to delete. Format: `projects/{project}/locations/{location}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job}`
Pattern: ^projects/[^/]+/locations/[^/]+/modelDeploymentMonitoringJobs/[^/]+$
Type: string
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}
Parameter Order: name
HTTP Method: DELETE
Description: Deletes a ModelDeploymentMonitoringJob.
▼ ▲ aiplatform.projects.locations.modelDeploymentMonitoringJobs.patch
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1beta1/{+name}
HTTP Method: PATCH
Parameters:
updateMask
Type: string
Description: Required. The update mask is used to specify the fields to be overwritten in the ModelDeploymentMonitoringJob 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 only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. For the objective config, the user can either provide the update mask for model_deployment_monitoring_objective_configs or any combination of its nested fields, such as: model_deployment_monitoring_objective_configs.objective_config.training_dataset. Updatable fields: * `display_name` * `model_deployment_monitoring_schedule_config` * `model_monitoring_alert_config` * `logging_sampling_strategy` * `labels` * `log_ttl` * `enable_monitoring_pipeline_logs` . and * `model_deployment_monitoring_objective_configs` . or * `model_deployment_monitoring_objective_configs.objective_config.training_dataset` * `model_deployment_monitoring_objective_configs.objective_config.training_prediction_skew_detection_config` * `model_deployment_monitoring_objective_configs.objective_config.prediction_drift_detection_config`
Location: query
Format: google-fieldmask
name
Required: Yes
Location: path
Type: string
Description: Output only. Resource name of a ModelDeploymentMonitoringJob.
Pattern: ^projects/[^/]+/locations/[^/]+/modelDeploymentMonitoringJobs/[^/]+$
Description: Updates a ModelDeploymentMonitoringJob.
Parameter Order: name
▼ ▲ aiplatform.projects.locations.models.deleteVersion
Parameters:
name
Type: string
Description: Required. The name of the model version to be deleted, with a version ID explicitly included. Example: `projects/{project}/locations/{location}/models/{model}@1234`
Pattern: ^projects/[^/]+/locations/[^/]+/models/[^/]+$
Required: Yes
Location: path
Path: v1beta1/{+name}:deleteVersion
HTTP Method: DELETE
Parameter Order: name
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:deleteVersion
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Deletes a Model version. Model version can only be deleted if there are no DeployedModels created from it. Deleting the only version in the Model is not allowed. Use DeleteModel for deleting the Model instead.
▼ ▲ aiplatform.projects.locations.models.testIamPermissions
Path: v1beta1/{+resource}:testIamPermissions
Parameters:
permissions
Type: string
Location: query
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
resource
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.
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/models/[^/]+$
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.
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:testIamPermissions
HTTP Method: POST
▼ ▲ aiplatform.projects.locations.models.copy
Parameter Order: parent
Parameters:
parent
Pattern: ^projects/[^/]+/locations/[^/]+$
Description: Required. The resource name of the Location into which to copy the Model. Format: `projects/{project}/locations/{location}`
Required: Yes
Type: string
Location: path
Path: v1beta1/{+parent}/models:copy
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/models:copy
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: POST
Description: Copies an already existing Vertex AI Model into the specified Location. The source Model must exist in the same Project. When copying custom Models, the users themselves are responsible for Model.metadata content to be region-agnostic, as well as making sure that any resources (e.g. files) it depends on remain accessible.
▼ ▲ aiplatform.projects.locations.models.upload
HTTP Method: POST
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/models:upload
Path: v1beta1/{+parent}/models:upload
Parameters:
parent
Required: Yes
Type: string
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+$
Description: Required. The resource name of the Location into which to upload the Model. Format: `projects/{project}/locations/{location}`
Description: Uploads a Model artifact into Vertex AI.
▼ ▲ aiplatform.projects.locations.models.list
Description: Lists Models in a Location.
Parameter Order: parent
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/models
Parameters:
readMask
Format: google-fieldmask
Description: Mask specifying which fields to read.
Location: query
Type: string
pageSize
Format: int32
Type: integer
Description: The standard list page size.
Location: query
filter
Description: An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `model` supports = and !=. `model` represents the Model ID, i.e. the last segment of the Model'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: * `model=1234` * `displayName="myDisplayName"` * `labels.myKey="myValue"`
Type: string
Location: query
pageToken
Type: string
Location: query
Description: The standard list page token. Typically obtained via ListModelsResponse.next_page_token of the previous ModelService.ListModels call.
parent
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+$
Required: Yes
Description: Required. The resource name of the Location to list the Models from. Format: `projects/{project}/locations/{location}`
Type: string
Path: v1beta1/{+parent}/models
HTTP Method: GET
▼ ▲ aiplatform.projects.locations.models.updateExplanationDataset
Parameters:
model
Description: Required. The resource name of the Model to update. Format: `projects/{project}/locations/{location}/models/{model}`
Required: Yes
Type: string
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/models/[^/]+$
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:updateExplanationDataset
HTTP Method: POST
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Incrementally update the dataset used for an examples model.
Path: v1beta1/{+model}:updateExplanationDataset
Parameter Order: model
▼ ▲ aiplatform.projects.locations.models.listVersions
Parameters:
readMask
Type: string
Location: query
Format: google-fieldmask
Description: Mask specifying which fields to read.
pageToken
Location: query
Description: The standard list page token. Typically obtained via next_page_token of the previous ListModelVersions call.
Type: string
pageSize
Format: int32
Type: integer
Description: The standard list page size.
Location: query
filter
Type: string
Location: query
Description: An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `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: * `labels.myKey="myValue"`
name
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/models/[^/]+$
Description: Required. The name of the model to list versions for.
Required: Yes
Type: string
orderBy
Type: string
Location: query
Description: A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `create_time` * `update_time` Example: `update_time asc, create_time desc`.
Parameter Order: name
Path: v1beta1/{+name}:listVersions
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: GET
Description: Lists versions of the specified model.
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:listVersions
▼ ▲ aiplatform.projects.locations.models.delete
Description: Deletes a Model. A model cannot be deleted if any Endpoint resource has a DeployedModel based on the model in its deployed_models field.
Parameters:
name
Type: string
Required: Yes
Description: Required. The name of the Model resource to be deleted. Format: `projects/{project}/locations/{location}/models/{model}`
Pattern: ^projects/[^/]+/locations/[^/]+/models/[^/]+$
Location: path
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}
Path: v1beta1/{+name}
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: DELETE
▼ ▲ aiplatform.projects.locations.models.setIamPolicy
Parameter Order: resource
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1beta1/{+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.
Parameters:
resource
Type: string
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/models/[^/]+$
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.
Required: Yes
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:setIamPolicy
HTTP Method: POST
▼ ▲ aiplatform.projects.locations.models.export
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:export
Parameter Order: name
Parameters:
name
Required: Yes
Type: string
Description: Required. The resource name of the Model to export. The resource name may contain version id or version alias to specify the version, if no version is specified, the default version will be exported.
Pattern: ^projects/[^/]+/locations/[^/]+/models/[^/]+$
Location: path
HTTP Method: POST
Path: v1beta1/{+name}:export
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Exports a trained, exportable Model to a location specified by the user. A Model is considered to be exportable if it has at least one supported export format.
▼ ▲ aiplatform.projects.locations.models.getIamPolicy
Scopes: https://www.googleapis.com/auth/cloud-platform
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.
Parameters:
options.requestedPolicyVersion
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
Format: int32
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.
Pattern: ^projects/[^/]+/locations/[^/]+/models/[^/]+$
Location: path
Type: string
Required: Yes
Path: v1beta1/{+resource}:getIamPolicy
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:getIamPolicy
Parameter Order: resource
▼ ▲ aiplatform.projects.locations.models.mergeVersionAliases
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Merges a set of aliases for a Model version.
HTTP Method: POST
Path: v1beta1/{+name}:mergeVersionAliases
Parameter Order: name
Parameters:
name
Required: Yes
Type: string
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/models/[^/]+$
Description: Required. The name of the model version to merge aliases, with a version ID explicitly included. Example: `projects/{project}/locations/{location}/models/{model}@1234`
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:mergeVersionAliases
▼ ▲ aiplatform.projects.locations.models.get
Parameter Order: name
Path: v1beta1/{+name}
HTTP Method: GET
Parameters:
name
Type: string
Required: Yes
Description: Required. The name of the Model resource. Format: `projects/{project}/locations/{location}/models/{model}` In order to retrieve a specific version of the model, also provide the version ID or version alias. Example: `projects/{project}/locations/{location}/models/{model}@2` or `projects/{project}/locations/{location}/models/{model}@golden` If no version ID or alias is specified, the "default" version will be returned. The "default" version alias is created for the first version of the model, and can be moved to other versions later on. There will be exactly one default version.
Pattern: ^projects/[^/]+/locations/[^/]+/models/[^/]+$
Location: path
Description: Gets a Model.
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}
▼ ▲ aiplatform.projects.locations.models.patch
Path: v1beta1/{+name}
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}
Description: Updates a Model.
HTTP Method: PATCH
Parameters:
name
Location: path
Required: Yes
Type: string
Description: The resource name of the Model.
Pattern: ^projects/[^/]+/locations/[^/]+/models/[^/]+$
updateMask
Location: query
Format: google-fieldmask
Type: string
Description: Required. The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask.
Parameter Order: name
▼ ▲ aiplatform.projects.locations.models.operations.cancel
Path: v1beta1/{+name}:cancel
Parameters:
name
Type: string
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/models/[^/]+/operations/[^/]+$
Required: Yes
Description: The name of the operation resource to be cancelled.
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`.
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: POST
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/operations/{operationsId}:cancel
Parameter Order: name
▼ ▲ aiplatform.projects.locations.models.operations.get
Path: v1beta1/{+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.
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/operations/{operationsId}
HTTP Method: GET
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+/models/[^/]+/operations/[^/]+$
Location: path
Required: Yes
Type: string
Description: The name of the operation resource.
▼ ▲ aiplatform.projects.locations.models.operations.wait
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/operations/{operationsId}:wait
Path: v1beta1/{+name}:wait
Parameter Order: name
Parameters:
name
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/models/[^/]+/operations/[^/]+$
Required: Yes
Description: The name of the operation resource to wait on.
Type: string
timeout
Format: google-duration
Location: query
Description: The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
Type: string
HTTP Method: POST
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
▼ ▲ aiplatform.projects.locations.models.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`.
Path: v1beta1/{+name}
Parameters:
name
Required: Yes
Description: The name of the operation resource to be deleted.
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/models/[^/]+/operations/[^/]+$
Location: path
Parameter Order: name
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/operations/{operationsId}
HTTP Method: DELETE
▼ ▲ aiplatform.projects.locations.models.operations.list
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: GET
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/operations
Description: Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
Path: v1beta1/{+name}/operations
Parameter Order: name
Parameters:
pageToken
Description: The standard list page token.
Type: string
Location: query
name
Pattern: ^projects/[^/]+/locations/[^/]+/models/[^/]+$
Required: Yes
Location: path
Type: string
Description: The name of the operation's parent resource.
pageSize
Type: integer
Format: int32
Description: The standard list page size.
Location: query
filter
Location: query
Description: The standard list filter.
Type: string
▼ ▲ aiplatform.projects.locations.models.evaluations.slices.list
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1beta1/{+parent}/slices
Parameter Order: parent
HTTP Method: GET
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}/slices
Parameters:
readMask
Description: Mask specifying which fields to read.
Format: google-fieldmask
Type: string
Location: query
filter
Location: query
Description: The standard list filter. * `slice.dimension` - for =.
Type: string
pageToken
Description: The standard list page token. Typically obtained via ListModelEvaluationSlicesResponse.next_page_token of the previous ModelService.ListModelEvaluationSlices call.
Type: string
Location: query
pageSize
Location: query
Description: The standard list page size.
Format: int32
Type: integer
parent
Location: path
Description: Required. The resource name of the ModelEvaluation to list the ModelEvaluationSlices from. Format: `projects/{project}/locations/{location}/models/{model}/evaluations/{evaluation}`
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/models/[^/]+/evaluations/[^/]+$
Required: Yes
Description: Lists ModelEvaluationSlices in a ModelEvaluation.
▼ ▲ aiplatform.projects.locations.models.evaluations.slices.get
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}/slices/{slicesId}
HTTP Method: GET
Path: v1beta1/{+name}
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
Parameters:
name
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/models/[^/]+/evaluations/[^/]+/slices/[^/]+$
Required: Yes
Type: string
Description: Required. The name of the ModelEvaluationSlice resource. Format: `projects/{project}/locations/{location}/models/{model}/evaluations/{evaluation}/slices/{slice}`
Description: Gets a ModelEvaluationSlice.
▼ ▲ aiplatform.projects.locations.models.evaluations.slices.batchImport
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: POST
Path: v1beta1/{+parent}:batchImport
Description: Imports a list of externally generated EvaluatedAnnotations.
Parameter Order: parent
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}/slices/{slicesId}:batchImport
Parameters:
parent
Description: Required. The name of the parent ModelEvaluationSlice resource. Format: `projects/{project}/locations/{location}/models/{model}/evaluations/{evaluation}/slices/{slice}`
Required: Yes
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/models/[^/]+/evaluations/[^/]+/slices/[^/]+$
Type: string
▼ ▲ aiplatform.projects.locations.models.evaluations.operations.wait
Description: Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
Parameters:
timeout
Type: string
Description: The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
Location: query
Format: google-duration
name
Required: Yes
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/models/[^/]+/evaluations/[^/]+/operations/[^/]+$
Description: The name of the operation resource to wait on.
Type: string
Path: v1beta1/{+name}:wait
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}/operations/{operationsId}:wait
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: POST
▼ ▲ aiplatform.projects.locations.models.evaluations.operations.cancel
Parameters:
name
Required: Yes
Location: path
Description: The name of the operation resource to be cancelled.
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/models/[^/]+/evaluations/[^/]+/operations/[^/]+$
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}/operations/{operationsId}:cancel
Parameter Order: name
Path: v1beta1/{+name}:cancel
HTTP Method: POST
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`.
▼ ▲ aiplatform.projects.locations.models.evaluations.operations.delete
Path: v1beta1/{+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
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}/operations/{operationsId}
Parameters:
name
Type: string
Description: The name of the operation resource to be deleted.
Pattern: ^projects/[^/]+/locations/[^/]+/models/[^/]+/evaluations/[^/]+/operations/[^/]+$
Required: Yes
Location: path
Parameter Order: name
▼ ▲ aiplatform.projects.locations.models.evaluations.operations.get
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}/operations/{operationsId}
Path: v1beta1/{+name}
HTTP Method: GET
Parameter Order: 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.
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
name
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/models/[^/]+/evaluations/[^/]+/operations/[^/]+$
Description: The name of the operation resource.
Type: string
Required: Yes
▼ ▲ aiplatform.projects.locations.models.evaluations.operations.list
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}/operations
Path: v1beta1/{+name}/operations
HTTP Method: GET
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
Description: Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
Parameters:
pageSize
Location: query
Type: integer
Format: int32
Description: The standard list page size.
pageToken
Location: query
Type: string
Description: The standard list page token.
filter
Type: string
Location: query
Description: The standard list filter.
name
Pattern: ^projects/[^/]+/locations/[^/]+/models/[^/]+/evaluations/[^/]+$
Location: path
Required: Yes
Type: string
Description: The name of the operation's parent resource.
▼ ▲ aiplatform.projects.locations.models.evaluations.list
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations
Path: v1beta1/{+parent}/evaluations
HTTP Method: GET
Description: Lists ModelEvaluations in a Model.
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: parent
Parameters:
filter
Location: query
Type: string
Description: The standard list filter.
pageToken
Type: string
Description: The standard list page token. Typically obtained via ListModelEvaluationsResponse.next_page_token of the previous ModelService.ListModelEvaluations call.
Location: query
parent
Description: Required. The resource name of the Model to list the ModelEvaluations from. Format: `projects/{project}/locations/{location}/models/{model}`
Type: string
Required: Yes
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/models/[^/]+$
pageSize
Location: query
Format: int32
Type: integer
Description: The standard list page size.
readMask
Location: query
Description: Mask specifying which fields to read.
Format: google-fieldmask
Type: string
▼ ▲ aiplatform.projects.locations.models.evaluations.get
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}
Parameters:
name
Location: path
Description: Required. The name of the ModelEvaluation resource. Format: `projects/{project}/locations/{location}/models/{model}/evaluations/{evaluation}`
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/models/[^/]+/evaluations/[^/]+$
Required: Yes
Path: v1beta1/{+name}
Description: Gets a ModelEvaluation.
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
HTTP Method: GET
▼ ▲ aiplatform.projects.locations.models.evaluations.import
Parameter Order: parent
Path: v1beta1/{+parent}/evaluations:import
Description: Imports an externally generated ModelEvaluation.
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations:import
HTTP Method: POST
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
parent
Pattern: ^projects/[^/]+/locations/[^/]+/models/[^/]+$
Description: Required. The name of the parent model resource. Format: `projects/{project}/locations/{location}/models/{model}`
Location: path
Type: string
Required: Yes
▼ ▲ aiplatform.projects.locations.list
Parameters:
pageSize
Location: query
Type: integer
Format: int32
Description: The maximum number of results to return. If not set, the service selects a default.
filter
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
Type: string
pageToken
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
Type: string
name
Pattern: ^projects/[^/]+$
Location: path
Description: The resource that owns the locations collection, if applicable.
Required: Yes
Type: string
Flat Path: v1beta1/projects/{projectsId}/locations
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1beta1/{+name}/locations
HTTP Method: GET
Description: Lists information about the supported locations for this service.
▼ ▲ aiplatform.projects.locations.get
Parameter Order: name
HTTP Method: GET
Parameters:
name
Location: path
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+$
Type: string
Description: Resource name for the location.
Path: v1beta1/{+name}
Description: Gets information about a location.
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}