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 :