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