2025-01-28
▼ ▲ aiplatform.projects.updateCacheConfig
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/cacheConfig
HTTP Method : PATCH
Parameters :
name
Description : Identifier. Name of the cache config. Format: - `projects/{project}/cacheConfig`.
Pattern : ^projects/[^/]+/cacheConfig$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Updates a cache config.
▼ ▲ aiplatform.projects.getCacheConfig
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/cacheConfig
HTTP Method : GET
Parameters :
name
Description : Required. Name of the cache config. Format: - `projects/{project}/cacheConfig`.
Pattern : ^projects/[^/]+/cacheConfig$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets a GenAI cache config.
▼ ▲ aiplatform.projects.locations.list
Path : v1beta1/{+name}/locations
Flat Path : v1beta1/projects/{projectsId}/locations
HTTP Method : GET
Parameters :
name
Description : The resource that owns the locations collection, if applicable.
Pattern : ^projects/[^/]+$
Location : path
Required : Yes
Type : string
filter
Description : A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).
Location : query
Type : string
pageSize
Description : The maximum number of results to return. If not set, the service selects a default.
Location : query
Type : integer
Format : int32
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
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists information about the supported locations for this service.
▼ ▲ aiplatform.projects.locations.get
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}
HTTP Method : GET
Parameters :
name
Description : Resource name for the location.
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets information about a location.
▼ ▲ aiplatform.projects.locations.evaluateInstances
Path : v1beta1/{+location}:evaluateInstances
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}:evaluateInstances
HTTP Method : POST
Parameters :
location
Description : Required. The resource name of the Location to evaluate the instances. Format: `projects/{project}/locations/{location}`
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : location
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Evaluates instances based on a given metric.
▼ ▲ aiplatform.projects.locations.deploy
Path : v1beta1/{+destination}:deploy
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}:deploy
HTTP Method : POST
Parameters :
destination
Description : Required. The resource name of the Location to deploy the model in. Format: `projects/{project}/locations/{location}`
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : destination
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Deploys publisher models.
▼ ▲ aiplatform.projects.locations.retrieveContexts
Path : v1beta1/{+parent}:retrieveContexts
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}:retrieveContexts
HTTP Method : POST
Parameters :
parent
Description : Required. The resource name of the Location from which to retrieve RagContexts. The users must have permission to make a call in the project. Format: `projects/{project}/locations/{location}`.
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Retrieves relevant contexts for a query.
▼ ▲ aiplatform.projects.locations.augmentPrompt
Path : v1beta1/{+parent}:augmentPrompt
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}:augmentPrompt
HTTP Method : POST
Parameters :
parent
Description : Required. The resource name of the Location from which to augment prompt. The users must have permission to make a call in the project. Format: `projects/{project}/locations/{location}`.
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Given an input prompt, it returns augmented prompt from vertex rag store to guide LLM towards generating grounded responses.
▼ ▲ aiplatform.projects.locations.corroborateContent
Path : v1beta1/{+parent}:corroborateContent
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}:corroborateContent
HTTP Method : POST
Parameters :
parent
Description : Required. The resource name of the Location from which to corroborate text. The users must have permission to make a call in the project. Format: `projects/{project}/locations/{location}`.
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Given an input text, it returns a score that evaluates the factuality of the text. It also extracts and returns claims from the text and provides supporting facts.
▼ ▲ aiplatform.projects.locations.featurestores.setIamPolicy
Path : v1beta1/{+resource}:setIamPolicy
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}:setIamPolicy
HTTP Method : POST
Parameters :
resource
Description : REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Pattern : ^projects/[^/]+/locations/[^/]+/featurestores/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : resource
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
▼ ▲ aiplatform.projects.locations.featurestores.getIamPolicy
Path : v1beta1/{+resource}:getIamPolicy
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}:getIamPolicy
HTTP Method : POST
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.
Pattern : ^projects/[^/]+/locations/[^/]+/featurestores/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : resource
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
▼ ▲ aiplatform.projects.locations.featurestores.testIamPermissions
Path : v1beta1/{+resource}:testIamPermissions
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}:testIamPermissions
HTTP Method : POST
Parameters :
resource
Description : REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Pattern : ^projects/[^/]+/locations/[^/]+/featurestores/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : resource
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
▼ ▲ aiplatform.projects.locations.featurestores.create
Path : v1beta1/{+parent}/featurestores
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores
HTTP Method : POST
Parameters :
parent
Description : Required. The resource name of the Location to create Featurestores. Format: `projects/{project}/locations/{location}`
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
featurestoreId
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
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Creates a new Featurestore in a given project and location.
▼ ▲ aiplatform.projects.locations.featurestores.get
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}
HTTP Method : GET
Parameters :
name
Description : Required. The name of the Featurestore resource.
Pattern : ^projects/[^/]+/locations/[^/]+/featurestores/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets details of a single Featurestore.
▼ ▲ aiplatform.projects.locations.featurestores.list
Path : v1beta1/{+parent}/featurestores
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores
HTTP Method : GET
Parameters :
parent
Description : Required. The resource name of the Location to list Featurestores. Format: `projects/{project}/locations/{location}`
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
filter
Description : Lists the featurestores that match the filter expression. The following fields are supported: * `create_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be in RFC 3339 format. * `update_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be in RFC 3339 format. * `online_serving_config.fixed_node_count`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. * `labels`: Supports key-value equality and key presence. Examples: * `create_time > "2020-01-01" OR update_time > "2020-01-01"` Featurestores created or updated after 2020-01-01. * `labels.env = "prod"` Featurestores with label "env" set to "prod".
Location : query
Type : string
pageSize
Description : The maximum number of Featurestores to return. The service may return fewer than this value. If unspecified, at most 100 Featurestores will be returned. The maximum value is 100; any value greater than 100 will be coerced to 100.
Location : query
Type : integer
Format : int32
pageToken
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
Type : string
orderBy
Description : A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported Fields: * `create_time` * `update_time` * `online_serving_config.fixed_node_count`
Location : query
Type : string
readMask
Description : Mask specifying which fields to read.
Location : query
Type : string
Format : google-fieldmask
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists Featurestores in a given project and location.
▼ ▲ aiplatform.projects.locations.featurestores.patch
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}
HTTP Method : PATCH
Parameters :
name
Description : Output only. Name of the Featurestore. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}`
Pattern : ^projects/[^/]+/locations/[^/]+/featurestores/[^/]+$
Location : path
Required : Yes
Type : string
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`
Location : query
Type : string
Format : google-fieldmask
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Updates the parameters of a single Featurestore.
▼ ▲ aiplatform.projects.locations.featurestores.delete
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}
HTTP Method : DELETE
Parameters :
name
Description : Required. The name of the Featurestore to be deleted. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}`
Pattern : ^projects/[^/]+/locations/[^/]+/featurestores/[^/]+$
Location : path
Required : Yes
Type : string
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.)
Location : query
Type : boolean
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Deletes a single Featurestore. The Featurestore must not contain any EntityTypes or `force` must be set to true for the request to succeed.
▼ ▲ aiplatform.projects.locations.featurestores.batchReadFeatureValues
Path : v1beta1/{+featurestore}:batchReadFeatureValues
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}:batchReadFeatureValues
HTTP Method : POST
Parameters :
featurestore
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/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : featurestore
Scopes : https://www.googleapis.com/auth/cloud-platform
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.
▼ ▲ aiplatform.projects.locations.featurestores.searchFeatures
Path : v1beta1/{+location}/featurestores:searchFeatures
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores:searchFeatures
HTTP Method : GET
Parameters :
location
Description : Required. The resource name of the Location to search Features. Format: `projects/{project}/locations/{location}`
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
query
Description : Query string that is a conjunction of field-restricted queries and/or field-restricted filters. Field-restricted queries and filters can be combined using `AND` to form a conjunction. A field query is in the form FIELD:QUERY. This implicitly checks if QUERY exists as a substring within Feature's FIELD. The QUERY and the FIELD are converted to a sequence of words (i.e. tokens) for comparison. This is done by: * Removing leading/trailing whitespace and tokenizing the search value. Characters that are not one of alphanumeric `[a-zA-Z0-9]`, underscore `_`, or asterisk `*` are treated as delimiters for tokens. `*` is treated as a wildcard that matches characters within a token. * Ignoring case. * Prepending an asterisk to the first and appending an asterisk to the last token in QUERY. A QUERY must be either a singular token or a phrase. A phrase is one or multiple words enclosed in double quotation marks ("). With phrases, the order of the words is important. Words in the phrase must be matching in order and consecutively. Supported FIELDs for field-restricted queries: * `feature_id` * `description` * `entity_type_id` Examples: * `feature_id: foo` --> Matches a Feature with ID containing the substring `foo` (eg. `foo`, `foofeature`, `barfoo`). * `feature_id: foo*feature` --> Matches a Feature with ID containing the substring `foo*feature` (eg. `foobarfeature`). * `feature_id: foo AND description: bar` --> Matches a Feature with ID containing the substring `foo` and description containing the substring `bar`. Besides field queries, the following exact-match filters are supported. The exact-match filters do not support wildcards. Unlike field-restricted queries, exact-match filters are case-sensitive. * `feature_id`: Supports = comparisons. * `description`: Supports = comparisons. Multi-token filters should be enclosed in quotes. * `entity_type_id`: Supports = comparisons. * `value_type`: Supports = and != comparisons. * `labels`: Supports key-value equality as well as key presence. * `featurestore_id`: Supports = comparisons. Examples: * `description = "foo bar"` --> Any Feature with description exactly equal to `foo bar` * `value_type = DOUBLE` --> Features whose type is DOUBLE. * `labels.active = yes AND labels.env = prod` --> Features having both (active: yes) and (env: prod) labels. * `labels.env: *` --> Any Feature which has a label with `env` as the key.
Location : query
Type : string
pageSize
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
Type : integer
Format : int32
pageToken
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.
Location : query
Type : string
Parameter Order : location
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Searches Features matching a query in a given project.
▼ ▲ aiplatform.projects.locations.featurestores.entityTypes.setIamPolicy
Path : v1beta1/{+resource}:setIamPolicy
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:setIamPolicy
HTTP Method : POST
Parameters :
resource
Description : REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Pattern : ^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : resource
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
▼ ▲ aiplatform.projects.locations.featurestores.entityTypes.getIamPolicy
Path : v1beta1/{+resource}:getIamPolicy
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:getIamPolicy
HTTP Method : POST
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.
Pattern : ^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$
Location : path
Required : Yes
Type : string
options.requestedPolicyVersion
Description : Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
Location : query
Type : integer
Format : int32
Parameter Order : resource
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
▼ ▲ aiplatform.projects.locations.featurestores.entityTypes.testIamPermissions
Path : v1beta1/{+resource}:testIamPermissions
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:testIamPermissions
HTTP Method : POST
Parameters :
resource
Description : REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Pattern : ^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$
Location : path
Required : Yes
Type : string
permissions
Description : The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
Location : query
Repeated : Yes
Type : string
Parameter Order : resource
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
▼ ▲ aiplatform.projects.locations.featurestores.entityTypes.readFeatureValues
Path : v1beta1/{+entityType}:readFeatureValues
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:readFeatureValues
HTTP Method : POST
Parameters :
entityType
Description : Required. The resource name of the EntityType for the entity being read. Value format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entityType}`. For example, for a machine learning model predicting user clicks on a website, an EntityType ID could be `user`.
Pattern : ^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : entityType
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Reads Feature values of a specific entity of an EntityType. For reading feature values of multiple entities of an EntityType, please use StreamingReadFeatureValues.
▼ ▲ aiplatform.projects.locations.featurestores.entityTypes.streamingReadFeatureValues
Path : v1beta1/{+entityType}:streamingReadFeatureValues
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:streamingReadFeatureValues
HTTP Method : POST
Parameters :
entityType
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`.
Pattern : ^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : entityType
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Reads Feature values for multiple entities. Depending on their size, data for different entities may be broken up across multiple responses.
▼ ▲ aiplatform.projects.locations.featurestores.entityTypes.writeFeatureValues
Path : v1beta1/{+entityType}:writeFeatureValues
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:writeFeatureValues
HTTP Method : POST
Parameters :
entityType
Description : Required. The resource name of the EntityType for the entities being written. Value format: `projects/{project}/locations/{location}/featurestores/ {featurestore}/entityTypes/{entityType}`. For example, for a machine learning model predicting user clicks on a website, an EntityType ID could be `user`.
Pattern : ^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : entityType
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.entityTypes.create
Path : v1beta1/{+parent}/entityTypes
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes
HTTP Method : POST
Parameters :
parent
Description : Required. The resource name of the Featurestore to create EntityTypes. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}`
Pattern : ^projects/[^/]+/locations/[^/]+/featurestores/[^/]+$
Location : path
Required : Yes
Type : string
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.
Location : query
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Creates a new EntityType in a given Featurestore.
▼ ▲ aiplatform.projects.locations.featurestores.entityTypes.get
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}
HTTP Method : GET
Parameters :
name
Description : Required. The name of the EntityType resource. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}`
Pattern : ^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets details of a single EntityType.
▼ ▲ aiplatform.projects.locations.featurestores.entityTypes.list
Path : v1beta1/{+parent}/entityTypes
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes
HTTP Method : GET
Parameters :
parent
Description : Required. The resource name of the Featurestore to list EntityTypes. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}`
Pattern : ^projects/[^/]+/locations/[^/]+/featurestores/[^/]+$
Location : path
Required : Yes
Type : string
filter
Description : Lists the EntityTypes that match the filter expression. The following filters are supported: * `create_time`: Supports `=`, `!=`, `<`, `>`, `>=`, and `<=` comparisons. Values must be in RFC 3339 format. * `update_time`: Supports `=`, `!=`, `<`, `>`, `>=`, and `<=` comparisons. Values must be in RFC 3339 format. * `labels`: Supports key-value equality as well as key presence. Examples: * `create_time > \"2020-01-31T15:30:00.000000Z\" OR update_time > \"2020-01-31T15:30:00.000000Z\"` --> EntityTypes created or updated after 2020-01-31T15:30:00.000000Z. * `labels.active = yes AND labels.env = prod` --> EntityTypes having both (active: yes) and (env: prod) labels. * `labels.env: *` --> Any EntityType which has a label with 'env' as the key.
Location : query
Type : string
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.
Location : query
Type : integer
Format : int32
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
orderBy
Description : A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `entity_type_id` * `create_time` * `update_time`
Location : query
Type : string
readMask
Description : Mask specifying which fields to read.
Location : query
Type : string
Format : google-fieldmask
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists EntityTypes in a given Featurestore.
▼ ▲ aiplatform.projects.locations.featurestores.entityTypes.patch
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}
HTTP Method : PATCH
Parameters :
name
Description : Immutable. Name of the EntityType. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` The last part entity_type is assigned by the client. The entity_type can be up to 64 characters long and can consist only of ASCII Latin letters A-Z and a-z and underscore(_), and ASCII digits 0-9 starting with a letter. The value will be unique given a featurestore.
Pattern : ^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$
Location : path
Required : Yes
Type : string
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`
Location : query
Type : string
Format : google-fieldmask
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Updates the parameters of a single EntityType.
▼ ▲ aiplatform.projects.locations.featurestores.entityTypes.delete
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}
HTTP Method : DELETE
Parameters :
name
Description : Required. The name of the EntityType to be deleted. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}`
Pattern : ^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$
Location : path
Required : Yes
Type : string
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.)
Location : query
Type : boolean
Parameter Order : name
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.
▼ ▲ aiplatform.projects.locations.featurestores.entityTypes.importFeatureValues
Path : v1beta1/{+entityType}:importFeatureValues
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:importFeatureValues
HTTP Method : POST
Parameters :
entityType
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}`
Pattern : ^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : entityType
Scopes : https://www.googleapis.com/auth/cloud-platform
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.
▼ ▲ aiplatform.projects.locations.featurestores.entityTypes.exportFeatureValues
Path : v1beta1/{+entityType}:exportFeatureValues
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:exportFeatureValues
HTTP Method : POST
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/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : entityType
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Exports Feature values from all the entities of a target EntityType.
▼ ▲ aiplatform.projects.locations.featurestores.entityTypes.deleteFeatureValues
Path : v1beta1/{+entityType}:deleteFeatureValues
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:deleteFeatureValues
HTTP Method : POST
Parameters :
entityType
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/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : entityType
Scopes : https://www.googleapis.com/auth/cloud-platform
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.
▼ ▲ aiplatform.projects.locations.featurestores.entityTypes.operations.list
Path : v1beta1/{+name}/operations
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/operations
HTTP Method : GET
Parameters :
name
Description : The name of the operation's parent resource.
Pattern : ^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$
Location : path
Required : Yes
Type : string
filter
Description : The standard list filter.
Location : query
Type : string
pageSize
Description : The standard list page size.
Location : query
Type : integer
Format : int32
pageToken
Description : The standard list page token.
Location : query
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
▼ ▲ aiplatform.projects.locations.featurestores.entityTypes.operations.get
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/operations/{operationsId}
HTTP Method : GET
Parameters :
name
Description : The name of the operation resource.
Pattern : ^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
▼ ▲ aiplatform.projects.locations.featurestores.entityTypes.operations.delete
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/operations/{operationsId}
HTTP Method : DELETE
Parameters :
name
Description : The name of the operation resource to be deleted.
Pattern : ^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
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`.
▼ ▲ aiplatform.projects.locations.featurestores.entityTypes.operations.cancel
Path : v1beta1/{+name}:cancel
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/operations/{operationsId}:cancel
HTTP Method : POST
Parameters :
name
Description : The name of the operation resource to be cancelled.
Pattern : ^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
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`.
▼ ▲ aiplatform.projects.locations.featurestores.entityTypes.operations.wait
Path : v1beta1/{+name}:wait
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/operations/{operationsId}:wait
HTTP Method : POST
Parameters :
name
Description : The name of the operation resource to wait on.
Pattern : ^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+/operations/[^/]+$
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.
Location : query
Type : string
Format : google-duration
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.
▼ ▲ aiplatform.projects.locations.featurestores.entityTypes.features.create
Path : v1beta1/{+parent}/features
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features
HTTP Method : POST
Parameters :
parent
Description : Required. The resource name of the EntityType or FeatureGroup to create a Feature. Format for entity_type as parent: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` Format for feature_group as parent: `projects/{project}/locations/{location}/featureGroups/{feature_group}`
Pattern : ^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$
Location : path
Required : Yes
Type : string
featureId
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.
Location : query
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Creates a new Feature in a given EntityType.
▼ ▲ aiplatform.projects.locations.featurestores.entityTypes.features.batchCreate
Path : v1beta1/{+parent}/features:batchCreate
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features:batchCreate
HTTP Method : POST
Parameters :
parent
Description : Required. The resource name of the EntityType/FeatureGroup to create the batch of Features under. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` `projects/{project}/locations/{location}/featureGroups/{feature_group}`
Pattern : ^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Creates a batch of Features in a given EntityType.
▼ ▲ aiplatform.projects.locations.featurestores.entityTypes.features.get
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}
HTTP Method : GET
Parameters :
name
Description : Required. The name of the Feature resource. Format for entity_type as parent: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` Format for feature_group as parent: `projects/{project}/locations/{location}/featureGroups/{feature_group}`
Pattern : ^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+/features/[^/]+$
Location : path
Required : Yes
Type : string
featureStatsAndAnomalySpec.latestStatsCount
Description : Optional. If set, returns the most recent count of stats. Valid value is [0, 100]. If stats_time_range is set, return most recent count of stats within the stats_time_range.
Location : query
Type : integer
Format : int32
featureStatsAndAnomalySpec.statsTimeRange.startTime
Description : Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.
Location : query
Type : string
Format : google-datetime
featureStatsAndAnomalySpec.statsTimeRange.endTime
Description : Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.
Location : query
Type : string
Format : google-datetime
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets details of a single Feature.
▼ ▲ aiplatform.projects.locations.featurestores.entityTypes.features.list
Path : v1beta1/{+parent}/features
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features
HTTP Method : GET
Parameters :
parent
Description : Required. The resource name of the Location to list Features. Format for entity_type as parent: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` Format for feature_group as parent: `projects/{project}/locations/{location}/featureGroups/{feature_group}`
Pattern : ^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$
Location : path
Required : Yes
Type : string
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
pageSize
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.
Location : query
Type : integer
Format : int32
pageToken
Description : A page token, received from a previous FeaturestoreService.ListFeatures call or FeatureRegistryService.ListFeatures call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeaturestoreService.ListFeatures or FeatureRegistryService.ListFeatures must match the call that provided the page token.
Location : query
Type : string
orderBy
Description : A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `feature_id` * `value_type` (Not supported for FeatureRegistry Feature) * `create_time` * `update_time`
Location : query
Type : string
readMask
Description : Mask specifying which fields to read.
Location : query
Type : string
Format : google-fieldmask
latestStatsCount
Description : Only applicable for Vertex AI Feature Store (Legacy). If set, return the most recent ListFeaturesRequest.latest_stats_count of stats for each Feature in response. Valid value is [0, 10]. If number of stats exists < ListFeaturesRequest.latest_stats_count, return all existing stats.
Location : query
Type : integer
Format : int32
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists Features in a given EntityType.
▼ ▲ aiplatform.projects.locations.featurestores.entityTypes.features.patch
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}
HTTP Method : PATCH
Parameters :
name
Description : Immutable. Name of the Feature. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}/features/{feature}` `projects/{project}/locations/{location}/featureGroups/{feature_group}/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.
Pattern : ^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+/features/[^/]+$
Location : path
Required : Yes
Type : string
updateMask
Description : Field mask is used to specify the fields to be overwritten in the Features resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `description` * `labels` * `disable_monitoring` (Not supported for FeatureRegistryService Feature) * `point_of_contact` (Not supported for FeaturestoreService FeatureStore)
Location : query
Type : string
Format : google-fieldmask
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Updates the parameters of a single Feature.
▼ ▲ aiplatform.projects.locations.featurestores.entityTypes.features.delete
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}
HTTP Method : DELETE
Parameters :
name
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}`
Pattern : ^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+/features/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Deletes a single Feature.
▼ ▲ aiplatform.projects.locations.featurestores.entityTypes.features.operations.list
Path : v1beta1/{+name}/operations
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}/operations
HTTP Method : GET
Parameters :
name
Description : The name of the operation's parent resource.
Pattern : ^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+/features/[^/]+$
Location : path
Required : Yes
Type : string
filter
Description : The standard list filter.
Location : query
Type : string
pageSize
Description : The standard list page size.
Location : query
Type : integer
Format : int32
pageToken
Description : The standard list page token.
Location : query
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
▼ ▲ aiplatform.projects.locations.featurestores.entityTypes.features.operations.get
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}/operations/{operationsId}
HTTP Method : GET
Parameters :
name
Description : The name of the operation resource.
Pattern : ^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+/features/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
▼ ▲ aiplatform.projects.locations.featurestores.entityTypes.features.operations.delete
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}/operations/{operationsId}
HTTP Method : DELETE
Parameters :
name
Description : The name of the operation resource to be deleted.
Pattern : ^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+/features/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
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`.
▼ ▲ aiplatform.projects.locations.featurestores.entityTypes.features.operations.cancel
Path : v1beta1/{+name}:cancel
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}/operations/{operationsId}:cancel
HTTP Method : POST
Parameters :
name
Description : The name of the operation resource to be cancelled.
Pattern : ^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+/features/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
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`.
▼ ▲ aiplatform.projects.locations.featurestores.entityTypes.features.operations.wait
Path : v1beta1/{+name}:wait
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}/operations/{operationsId}:wait
HTTP Method : POST
Parameters :
name
Description : The name of the operation resource to wait on.
Pattern : ^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+/features/[^/]+/operations/[^/]+$
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.
Location : query
Type : string
Format : google-duration
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.
▼ ▲ aiplatform.projects.locations.featurestores.operations.list
Path : v1beta1/{+name}/operations
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/operations
HTTP Method : GET
Parameters :
name
Description : The name of the operation's parent resource.
Pattern : ^projects/[^/]+/locations/[^/]+/featurestores/[^/]+$
Location : path
Required : Yes
Type : string
filter
Description : The standard list filter.
Location : query
Type : string
pageSize
Description : The standard list page size.
Location : query
Type : integer
Format : int32
pageToken
Description : The standard list page token.
Location : query
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
▼ ▲ aiplatform.projects.locations.featurestores.operations.get
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/operations/{operationsId}
HTTP Method : GET
Parameters :
name
Description : The name of the operation resource.
Pattern : ^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
▼ ▲ aiplatform.projects.locations.featurestores.operations.delete
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/operations/{operationsId}
HTTP Method : DELETE
Parameters :
name
Description : The name of the operation resource to be deleted.
Pattern : ^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
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`.
▼ ▲ aiplatform.projects.locations.featurestores.operations.cancel
Path : v1beta1/{+name}:cancel
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/operations/{operationsId}:cancel
HTTP Method : POST
Parameters :
name
Description : The name of the operation resource to be cancelled.
Pattern : ^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
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`.
▼ ▲ aiplatform.projects.locations.featurestores.operations.wait
Path : v1beta1/{+name}:wait
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/operations/{operationsId}:wait
HTTP Method : POST
Parameters :
name
Description : The name of the operation resource to wait on.
Pattern : ^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/operations/[^/]+$
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.
Location : query
Type : string
Format : google-duration
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.
▼ ▲ aiplatform.projects.locations.models.setIamPolicy
Path : v1beta1/{+resource}:setIamPolicy
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:setIamPolicy
HTTP Method : POST
Parameters :
resource
Description : REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Pattern : ^projects/[^/]+/locations/[^/]+/models/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : resource
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
▼ ▲ aiplatform.projects.locations.models.getIamPolicy
Path : v1beta1/{+resource}:getIamPolicy
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:getIamPolicy
HTTP Method : POST
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.
Pattern : ^projects/[^/]+/locations/[^/]+/models/[^/]+$
Location : path
Required : Yes
Type : string
options.requestedPolicyVersion
Description : Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
Location : query
Type : integer
Format : int32
Parameter Order : resource
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
▼ ▲ aiplatform.projects.locations.models.testIamPermissions
Path : v1beta1/{+resource}:testIamPermissions
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:testIamPermissions
HTTP Method : POST
Parameters :
resource
Description : REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Pattern : ^projects/[^/]+/locations/[^/]+/models/[^/]+$
Location : path
Required : Yes
Type : string
permissions
Description : The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
Location : query
Repeated : Yes
Type : string
Parameter Order : resource
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
▼ ▲ aiplatform.projects.locations.models.upload
Path : v1beta1/{+parent}/models:upload
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/models:upload
HTTP Method : POST
Parameters :
parent
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
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Uploads a Model artifact into Vertex AI.
▼ ▲ aiplatform.projects.locations.models.get
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}
HTTP Method : GET
Parameters :
name
Description : Required. The name of the Model resource. Format: `projects/{project}/locations/{location}/models/{model}` In order to retrieve a specific version of the model, also provide the version ID or version alias. Example: `projects/{project}/locations/{location}/models/{model}@2` or `projects/{project}/locations/{location}/models/{model}@golden` If no version ID or alias is specified, the "default" version will be returned. The "default" version alias is created for the first version of the model, and can be moved to other versions later on. There will be exactly one default version.
Pattern : ^projects/[^/]+/locations/[^/]+/models/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets a Model.
▼ ▲ aiplatform.projects.locations.models.list
Path : v1beta1/{+parent}/models
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/models
HTTP Method : GET
Parameters :
parent
Description : Required. The resource name of the Location to list the Models from. Format: `projects/{project}/locations/{location}`
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
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"`. * `base_model_name` only supports = Some examples: * `model=1234` * `displayName="myDisplayName"` * `labels.myKey="myValue"` * `baseModelName="text-bison"`
Location : query
Type : string
pageSize
Description : The standard list page size.
Location : query
Type : integer
Format : int32
pageToken
Description : The standard list page token. Typically obtained via ListModelsResponse.next_page_token of the previous ModelService.ListModels call.
Location : query
Type : string
readMask
Description : Mask specifying which fields to read.
Location : query
Type : string
Format : google-fieldmask
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists Models in a Location.
▼ ▲ aiplatform.projects.locations.models.listVersions
Path : v1beta1/{+name}:listVersions
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:listVersions
HTTP Method : GET
Parameters :
name
Description : Required. The name of the model to list versions for.
Pattern : ^projects/[^/]+/locations/[^/]+/models/[^/]+$
Location : path
Required : Yes
Type : string
pageSize
Description : The standard list page size.
Location : query
Type : integer
Format : int32
pageToken
Description : The standard list page token. Typically obtained via next_page_token of the previous ListModelVersions call.
Location : query
Type : string
filter
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
Type : string
readMask
Description : Mask specifying which fields to read.
Location : query
Type : string
Format : google-fieldmask
orderBy
Description : A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `create_time` * `update_time` Example: `update_time asc, create_time desc`.
Location : query
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists versions of the specified model.
▼ ▲ aiplatform.projects.locations.models.patch
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}
HTTP Method : PATCH
Parameters :
name
Description : The resource name of the Model.
Pattern : ^projects/[^/]+/locations/[^/]+/models/[^/]+$
Location : path
Required : Yes
Type : string
updateMask
Description : Required. The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask.
Location : query
Type : string
Format : google-fieldmask
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Updates a Model.
▼ ▲ aiplatform.projects.locations.models.updateExplanationDataset
Path : v1beta1/{+model}:updateExplanationDataset
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:updateExplanationDataset
HTTP Method : POST
Parameters :
model
Description : Required. The resource name of the Model to update. Format: `projects/{project}/locations/{location}/models/{model}`
Pattern : ^projects/[^/]+/locations/[^/]+/models/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : model
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Incrementally update the dataset used for an examples model.
▼ ▲ aiplatform.projects.locations.models.delete
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}
HTTP Method : DELETE
Parameters :
name
Description : Required. The name of the Model resource to be deleted. Format: `projects/{project}/locations/{location}/models/{model}`
Pattern : ^projects/[^/]+/locations/[^/]+/models/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
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.
▼ ▲ aiplatform.projects.locations.models.deleteVersion
Path : v1beta1/{+name}:deleteVersion
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:deleteVersion
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`
Pattern : ^projects/[^/]+/locations/[^/]+/models/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Deletes a Model version. Model version can only be deleted if there are no DeployedModels created from it. Deleting the only version in the Model is not allowed. Use DeleteModel for deleting the Model instead.
▼ ▲ aiplatform.projects.locations.models.mergeVersionAliases
Path : v1beta1/{+name}:mergeVersionAliases
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:mergeVersionAliases
HTTP Method : POST
Parameters :
name
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`
Pattern : ^projects/[^/]+/locations/[^/]+/models/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Merges a set of aliases for a Model version.
▼ ▲ aiplatform.projects.locations.models.export
Path : v1beta1/{+name}:export
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:export
HTTP Method : POST
Parameters :
name
Description : Required. The resource name of the Model to export. The resource name may contain version id or version alias to specify the version, if no version is specified, the default version will be exported.
Pattern : ^projects/[^/]+/locations/[^/]+/models/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Exports a trained, exportable Model to a location specified by the user. A Model is considered to be exportable if it has at least one supported export format.
▼ ▲ aiplatform.projects.locations.models.copy
Path : v1beta1/{+parent}/models:copy
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/models:copy
HTTP Method : POST
Parameters :
parent
Description : Required. The resource name of the Location into which to copy the Model. Format: `projects/{project}/locations/{location}`
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Copies an already existing Vertex AI Model into the specified Location. The source Model must exist in the same Project. When copying custom Models, the users themselves are responsible for Model.metadata content to be region-agnostic, as well as making sure that any resources (e.g. files) it depends on remain accessible.
▼ ▲ aiplatform.projects.locations.models.operations.list
Path : v1beta1/{+name}/operations
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/operations
HTTP Method : GET
Parameters :
name
Description : The name of the operation's parent resource.
Pattern : ^projects/[^/]+/locations/[^/]+/models/[^/]+$
Location : path
Required : Yes
Type : string
filter
Description : The standard list filter.
Location : query
Type : string
pageSize
Description : The standard list page size.
Location : query
Type : integer
Format : int32
pageToken
Description : The standard list page token.
Location : query
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
▼ ▲ aiplatform.projects.locations.models.operations.get
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/operations/{operationsId}
HTTP Method : GET
Parameters :
name
Description : The name of the operation resource.
Pattern : ^projects/[^/]+/locations/[^/]+/models/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
▼ ▲ aiplatform.projects.locations.models.operations.delete
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/operations/{operationsId}
HTTP Method : DELETE
Parameters :
name
Description : The name of the operation resource to be deleted.
Pattern : ^projects/[^/]+/locations/[^/]+/models/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
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`.
▼ ▲ aiplatform.projects.locations.models.operations.cancel
Path : v1beta1/{+name}:cancel
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/operations/{operationsId}:cancel
HTTP Method : POST
Parameters :
name
Description : The name of the operation resource to be cancelled.
Pattern : ^projects/[^/]+/locations/[^/]+/models/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
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`.
▼ ▲ aiplatform.projects.locations.models.operations.wait
Path : v1beta1/{+name}:wait
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/operations/{operationsId}:wait
HTTP Method : POST
Parameters :
name
Description : The name of the operation resource to wait on.
Pattern : ^projects/[^/]+/locations/[^/]+/models/[^/]+/operations/[^/]+$
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.
Location : query
Type : string
Format : google-duration
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.
▼ ▲ aiplatform.projects.locations.models.evaluations.import
Path : v1beta1/{+parent}/evaluations:import
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations:import
HTTP Method : POST
Parameters :
parent
Description : Required. The name of the parent model resource. Format: `projects/{project}/locations/{location}/models/{model}`
Pattern : ^projects/[^/]+/locations/[^/]+/models/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Imports an externally generated ModelEvaluation.
▼ ▲ aiplatform.projects.locations.models.evaluations.get
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}
HTTP Method : GET
Parameters :
name
Description : Required. The name of the ModelEvaluation resource. Format: `projects/{project}/locations/{location}/models/{model}/evaluations/{evaluation}`
Pattern : ^projects/[^/]+/locations/[^/]+/models/[^/]+/evaluations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets a ModelEvaluation.
▼ ▲ aiplatform.projects.locations.models.evaluations.list
Path : v1beta1/{+parent}/evaluations
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations
HTTP Method : GET
Parameters :
parent
Description : Required. The resource name of the Model to list the ModelEvaluations from. Format: `projects/{project}/locations/{location}/models/{model}`
Pattern : ^projects/[^/]+/locations/[^/]+/models/[^/]+$
Location : path
Required : Yes
Type : string
filter
Description : The standard list filter.
Location : query
Type : string
pageSize
Description : The standard list page size.
Location : query
Type : integer
Format : int32
pageToken
Description : The standard list page token. Typically obtained via ListModelEvaluationsResponse.next_page_token of the previous ModelService.ListModelEvaluations call.
Location : query
Type : string
readMask
Description : Mask specifying which fields to read.
Location : query
Type : string
Format : google-fieldmask
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists ModelEvaluations in a Model.
▼ ▲ aiplatform.projects.locations.models.evaluations.operations.list
Path : v1beta1/{+name}/operations
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}/operations
HTTP Method : GET
Parameters :
name
Description : The name of the operation's parent resource.
Pattern : ^projects/[^/]+/locations/[^/]+/models/[^/]+/evaluations/[^/]+$
Location : path
Required : Yes
Type : string
filter
Description : The standard list filter.
Location : query
Type : string
pageSize
Description : The standard list page size.
Location : query
Type : integer
Format : int32
pageToken
Description : The standard list page token.
Location : query
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
▼ ▲ aiplatform.projects.locations.models.evaluations.operations.get
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}/operations/{operationsId}
HTTP Method : GET
Parameters :
name
Description : The name of the operation resource.
Pattern : ^projects/[^/]+/locations/[^/]+/models/[^/]+/evaluations/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
▼ ▲ aiplatform.projects.locations.models.evaluations.operations.delete
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}/operations/{operationsId}
HTTP Method : DELETE
Parameters :
name
Description : The name of the operation resource to be deleted.
Pattern : ^projects/[^/]+/locations/[^/]+/models/[^/]+/evaluations/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
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`.
▼ ▲ aiplatform.projects.locations.models.evaluations.operations.cancel
Path : v1beta1/{+name}:cancel
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}/operations/{operationsId}:cancel
HTTP Method : POST
Parameters :
name
Description : The name of the operation resource to be cancelled.
Pattern : ^projects/[^/]+/locations/[^/]+/models/[^/]+/evaluations/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
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`.
▼ ▲ aiplatform.projects.locations.models.evaluations.operations.wait
Path : v1beta1/{+name}:wait
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}/operations/{operationsId}:wait
HTTP Method : POST
Parameters :
name
Description : The name of the operation resource to wait on.
Pattern : ^projects/[^/]+/locations/[^/]+/models/[^/]+/evaluations/[^/]+/operations/[^/]+$
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.
Location : query
Type : string
Format : google-duration
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.
▼ ▲ aiplatform.projects.locations.models.evaluations.slices.batchImport
Path : v1beta1/{+parent}:batchImport
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}/slices/{slicesId}:batchImport
HTTP Method : POST
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/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Imports a list of externally generated EvaluatedAnnotations.
▼ ▲ aiplatform.projects.locations.models.evaluations.slices.get
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}/slices/{slicesId}
HTTP Method : GET
Parameters :
name
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/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets a ModelEvaluationSlice.
▼ ▲ aiplatform.projects.locations.models.evaluations.slices.list
Path : v1beta1/{+parent}/slices
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}/slices
HTTP Method : GET
Parameters :
parent
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/[^/]+$
Location : path
Required : Yes
Type : string
filter
Description : The standard list filter. * `slice.dimension` - for =.
Location : query
Type : string
pageSize
Description : The standard list page size.
Location : query
Type : integer
Format : int32
pageToken
Description : The standard list page token. Typically obtained via ListModelEvaluationSlicesResponse.next_page_token of the previous ModelService.ListModelEvaluationSlices call.
Location : query
Type : string
readMask
Description : Mask specifying which fields to read.
Location : query
Type : string
Format : google-fieldmask
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists ModelEvaluationSlices in a ModelEvaluation.
▼ ▲ aiplatform.projects.locations.endpoints.setIamPolicy
Path : v1beta1/{+resource}:setIamPolicy
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:setIamPolicy
HTTP Method : POST
Parameters :
resource
Description : REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Pattern : ^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : resource
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
▼ ▲ aiplatform.projects.locations.endpoints.getIamPolicy
Path : v1beta1/{+resource}:getIamPolicy
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:getIamPolicy
HTTP Method : POST
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.
Pattern : ^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$
Location : path
Required : Yes
Type : string
options.requestedPolicyVersion
Description : Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
Location : query
Type : integer
Format : int32
Parameter Order : resource
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
▼ ▲ aiplatform.projects.locations.endpoints.testIamPermissions
Path : v1beta1/{+resource}:testIamPermissions
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:testIamPermissions
HTTP Method : POST
Parameters :
resource
Description : REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Pattern : ^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$
Location : path
Required : Yes
Type : string
permissions
Description : The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
Location : query
Repeated : Yes
Type : string
Parameter Order : resource
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
▼ ▲ aiplatform.projects.locations.endpoints.create
Path : v1beta1/{+parent}/endpoints
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints
HTTP Method : POST
Parameters :
parent
Description : Required. The resource name of the Location to create the Endpoint in. Format: `projects/{project}/locations/{location}`
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
endpointId
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.
Location : query
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Creates an Endpoint.
▼ ▲ aiplatform.projects.locations.endpoints.get
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}
HTTP Method : GET
Parameters :
name
Description : Required. The name of the Endpoint resource. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`
Pattern : ^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets an Endpoint.
▼ ▲ aiplatform.projects.locations.endpoints.list
Path : v1beta1/{+parent}/endpoints
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints
HTTP Method : GET
Parameters :
parent
Description : Required. The resource name of the Location from which to list the Endpoints. Format: `projects/{project}/locations/{location}`
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
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"`. * `base_model_name` only supports `=`. Some examples: * `endpoint=1` * `displayName="myDisplayName"` * `labels.myKey="myValue"` * `baseModelName="text-bison"`
Location : query
Type : string
pageSize
Description : Optional. The standard list page size.
Location : query
Type : integer
Format : int32
pageToken
Description : Optional. The standard list page token. Typically obtained via ListEndpointsResponse.next_page_token of the previous EndpointService.ListEndpoints call.
Location : query
Type : string
readMask
Description : Optional. Mask specifying which fields to read.
Location : query
Type : string
Format : google-fieldmask
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists Endpoints in a Location.
▼ ▲ aiplatform.projects.locations.endpoints.patch
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}
HTTP Method : PATCH
Parameters :
name
Description : Output only. The resource name of the Endpoint.
Pattern : ^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$
Location : path
Required : Yes
Type : string
updateMask
Description : Required. The update mask applies to the resource. See google.protobuf.FieldMask.
Location : query
Type : string
Format : google-fieldmask
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Updates an Endpoint.
▼ ▲ aiplatform.projects.locations.endpoints.update
Path : v1beta1/{+name}:update
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:update
HTTP Method : POST
Parameters :
name
Description : Output only. The resource name of the Endpoint.
Pattern : ^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Updates an Endpoint with a long running operation.
▼ ▲ aiplatform.projects.locations.endpoints.delete
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}
HTTP Method : DELETE
Parameters :
name
Description : Required. The name of the Endpoint resource to be deleted. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`
Pattern : ^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Deletes an Endpoint.
▼ ▲ aiplatform.projects.locations.endpoints.deployModel
Path : v1beta1/{+endpoint}:deployModel
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:deployModel
HTTP Method : POST
Parameters :
endpoint
Description : Required. The name of the Endpoint resource into which to deploy a Model. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`
Pattern : ^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : endpoint
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Deploys a Model into this Endpoint, creating a DeployedModel within it.
▼ ▲ aiplatform.projects.locations.endpoints.undeployModel
Path : v1beta1/{+endpoint}:undeployModel
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:undeployModel
HTTP Method : POST
Parameters :
endpoint
Description : Required. The name of the Endpoint resource from which to undeploy a Model. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`
Pattern : ^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : endpoint
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Undeploys a Model from an Endpoint, removing a DeployedModel from it, and freeing all resources it's using.
▼ ▲ aiplatform.projects.locations.endpoints.mutateDeployedModel
Path : v1beta1/{+endpoint}:mutateDeployedModel
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:mutateDeployedModel
HTTP Method : POST
Parameters :
endpoint
Description : Required. The name of the Endpoint resource into which to mutate a DeployedModel. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`
Pattern : ^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : endpoint
Scopes : https://www.googleapis.com/auth/cloud-platform
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).
▼ ▲ aiplatform.projects.locations.endpoints.predict
Path : v1beta1/{+endpoint}:predict
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:predict
HTTP Method : POST
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/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : endpoint
Scopes :
Description : Perform an online prediction.
▼ ▲ aiplatform.projects.locations.endpoints.rawPredict
Path : v1beta1/{+endpoint}:rawPredict
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}: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}`
Pattern : ^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : endpoint
Scopes :
Description : Perform an online prediction with an arbitrary HTTP payload. The response includes the following HTTP headers: * `X-Vertex-AI-Endpoint-Id`: ID of the Endpoint that served this prediction. * `X-Vertex-AI-Deployed-Model-Id`: ID of the Endpoint's DeployedModel that served this prediction.
▼ ▲ aiplatform.projects.locations.endpoints.streamRawPredict
Path : v1beta1/{+endpoint}:streamRawPredict
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:streamRawPredict
HTTP Method : POST
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/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : endpoint
Scopes :
Description : Perform a streaming online prediction with an arbitrary HTTP payload.
▼ ▲ aiplatform.projects.locations.endpoints.directPredict
Path : v1beta1/{+endpoint}:directPredict
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:directPredict
HTTP Method : POST
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/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : endpoint
Scopes :
Description : Perform an unary online prediction request to a gRPC model server for Vertex first-party products and frameworks.
▼ ▲ aiplatform.projects.locations.endpoints.directRawPredict
Path : v1beta1/{+endpoint}:directRawPredict
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:directRawPredict
HTTP Method : POST
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/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : endpoint
Scopes :
Description : Perform an unary online prediction request to a gRPC model server for custom containers.
▼ ▲ aiplatform.projects.locations.endpoints.serverStreamingPredict
Path : v1beta1/{+endpoint}:serverStreamingPredict
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:serverStreamingPredict
HTTP Method : POST
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/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : endpoint
Scopes :
Description : Perform a server-side streaming online prediction request for Vertex LLM streaming.
▼ ▲ aiplatform.projects.locations.endpoints.predictLongRunning
Path : v1beta1/{+endpoint}:predictLongRunning
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:predictLongRunning
HTTP Method : POST
Parameters :
endpoint
Description : Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}` or `projects/{project}/locations/{location}/publishers/{publisher}/models/{model}`
Pattern : ^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : endpoint
Scopes :
▼ ▲ aiplatform.projects.locations.endpoints.fetchPredictOperation
Path : v1beta1/{+endpoint}:fetchPredictOperation
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:fetchPredictOperation
HTTP Method : POST
Parameters :
endpoint
Description : Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}` or `projects/{project}/locations/{location}/publishers/{publisher}/models/{model}`
Pattern : ^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : endpoint
Scopes :
Description : Fetch an asynchronous online prediction operation.
▼ ▲ aiplatform.projects.locations.endpoints.explain
Path : v1beta1/{+endpoint}:explain
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:explain
HTTP Method : POST
Parameters :
endpoint
Description : Required. The name of the Endpoint requested to serve the explanation. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`
Pattern : ^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : endpoint
Scopes :
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.
▼ ▲ aiplatform.projects.locations.endpoints.countTokens
Path : v1beta1/{+endpoint}:countTokens
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:countTokens
HTTP Method : POST
Parameters :
endpoint
Description : Required. The name of the Endpoint requested to perform token counting. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`
Pattern : ^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : endpoint
Scopes :
Description : Perform a token counting.
▼ ▲ aiplatform.projects.locations.endpoints.generateContent
Path : v1beta1/{+model}:generateContent
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:generateContent
HTTP Method : POST
Parameters :
model
Description : Required. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`
Pattern : ^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : model
Scopes :
Description : Generate content with multimodal inputs.
▼ ▲ aiplatform.projects.locations.endpoints.streamGenerateContent
Path : v1beta1/{+model}:streamGenerateContent
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:streamGenerateContent
HTTP Method : POST
Parameters :
model
Description : Required. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`
Pattern : ^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : model
Scopes :
Description : Generate content with multimodal inputs with streaming support.
▼ ▲ aiplatform.projects.locations.endpoints.computeTokens
Path : v1beta1/{+endpoint}:computeTokens
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:computeTokens
HTTP Method : POST
Parameters :
endpoint
Description : Required. The name of the Endpoint requested to get lists of tokens and token ids.
Pattern : ^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : endpoint
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Return a list of tokens based on the input text.
▼ ▲ aiplatform.projects.locations.endpoints.operations.list
Path : v1beta1/{+name}/operations
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}/operations
HTTP Method : GET
Parameters :
name
Description : The name of the operation's parent resource.
Pattern : ^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$
Location : path
Required : Yes
Type : string
filter
Description : The standard list filter.
Location : query
Type : string
pageSize
Description : The standard list page size.
Location : query
Type : integer
Format : int32
pageToken
Description : The standard list page token.
Location : query
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
▼ ▲ aiplatform.projects.locations.endpoints.operations.get
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}/operations/{operationsId}
HTTP Method : GET
Parameters :
name
Description : The name of the operation resource.
Pattern : ^projects/[^/]+/locations/[^/]+/endpoints/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
▼ ▲ aiplatform.projects.locations.endpoints.operations.delete
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}/operations/{operationsId}
HTTP Method : DELETE
Parameters :
name
Description : The name of the operation resource to be deleted.
Pattern : ^projects/[^/]+/locations/[^/]+/endpoints/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
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`.
▼ ▲ aiplatform.projects.locations.endpoints.operations.cancel
Path : v1beta1/{+name}:cancel
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}/operations/{operationsId}:cancel
HTTP Method : POST
Parameters :
name
Description : The name of the operation resource to be cancelled.
Pattern : ^projects/[^/]+/locations/[^/]+/endpoints/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
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`.
▼ ▲ aiplatform.projects.locations.endpoints.operations.wait
Path : v1beta1/{+name}:wait
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}/operations/{operationsId}:wait
HTTP Method : POST
Parameters :
name
Description : The name of the operation resource to wait on.
Pattern : ^projects/[^/]+/locations/[^/]+/endpoints/[^/]+/operations/[^/]+$
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.
Location : query
Type : string
Format : google-duration
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.
▼ ▲ aiplatform.projects.locations.endpoints.chat.completions
Path : v1beta1/{+endpoint}/chat/completions
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}/chat/completions
HTTP Method : POST
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/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : endpoint
Scopes :
Description : Exposes an OpenAI-compatible endpoint for chat completions.
▼ ▲ aiplatform.projects.locations.notebookRuntimeTemplates.setIamPolicy
Path : v1beta1/{+resource}:setIamPolicy
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}:setIamPolicy
HTTP Method : POST
Parameters :
resource
Description : REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Pattern : ^projects/[^/]+/locations/[^/]+/notebookRuntimeTemplates/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : resource
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
▼ ▲ aiplatform.projects.locations.notebookRuntimeTemplates.getIamPolicy
Path : v1beta1/{+resource}:getIamPolicy
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}:getIamPolicy
HTTP Method : POST
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.
Pattern : ^projects/[^/]+/locations/[^/]+/notebookRuntimeTemplates/[^/]+$
Location : path
Required : Yes
Type : string
options.requestedPolicyVersion
Description : Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
Location : query
Type : integer
Format : int32
Parameter Order : resource
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
▼ ▲ aiplatform.projects.locations.notebookRuntimeTemplates.testIamPermissions
Path : v1beta1/{+resource}:testIamPermissions
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}:testIamPermissions
HTTP Method : POST
Parameters :
resource
Description : REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Pattern : ^projects/[^/]+/locations/[^/]+/notebookRuntimeTemplates/[^/]+$
Location : path
Required : Yes
Type : string
permissions
Description : The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
Location : query
Repeated : Yes
Type : string
Parameter Order : resource
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
▼ ▲ aiplatform.projects.locations.notebookRuntimeTemplates.create
Path : v1beta1/{+parent}/notebookRuntimeTemplates
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates
HTTP Method : POST
Parameters :
parent
Description : Required. The resource name of the Location to create the NotebookRuntimeTemplate. Format: `projects/{project}/locations/{location}`
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
notebookRuntimeTemplateId
Description : Optional. User specified ID for the notebook runtime template.
Location : query
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Creates a NotebookRuntimeTemplate.
▼ ▲ aiplatform.projects.locations.notebookRuntimeTemplates.get
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}
HTTP Method : GET
Parameters :
name
Description : Required. The name of the NotebookRuntimeTemplate resource. Format: `projects/{project}/locations/{location}/notebookRuntimeTemplates/{notebook_runtime_template}`
Pattern : ^projects/[^/]+/locations/[^/]+/notebookRuntimeTemplates/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets a NotebookRuntimeTemplate.
▼ ▲ aiplatform.projects.locations.notebookRuntimeTemplates.list
Path : v1beta1/{+parent}/notebookRuntimeTemplates
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates
HTTP Method : GET
Parameters :
parent
Description : Required. The resource name of the Location from which to list the NotebookRuntimeTemplates. Format: `projects/{project}/locations/{location}`
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
filter
Description : Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `notebookRuntimeTemplate` supports = and !=. `notebookRuntimeTemplate` represents the NotebookRuntimeTemplate ID, i.e. the last segment of the NotebookRuntimeTemplate's resource name. * `display_name` supports = and != * `labels` supports general map functions that is: * `labels.key=value` - key:value equality * `labels.key:* or labels:key - key existence * A key including a space must be quoted. `labels."a key"`. * `notebookRuntimeType` supports = and !=. notebookRuntimeType enum: [USER_DEFINED, ONE_CLICK]. * `machineType` supports = and !=. * `acceleratorType` supports = and !=. Some examples: * `notebookRuntimeTemplate=notebookRuntimeTemplate123` * `displayName="myDisplayName"` * `labels.myKey="myValue"` * `notebookRuntimeType=USER_DEFINED` * `machineType=e2-standard-4` * `acceleratorType=NVIDIA_TESLA_T4`
Location : query
Type : string
pageSize
Description : Optional. The standard list page size.
Location : query
Type : integer
Format : int32
pageToken
Description : Optional. The standard list page token. Typically obtained via ListNotebookRuntimeTemplatesResponse.next_page_token of the previous NotebookService.ListNotebookRuntimeTemplates call.
Location : query
Type : string
readMask
Description : Optional. Mask specifying which fields to read.
Location : query
Type : string
Format : google-fieldmask
orderBy
Description : Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `display_name` * `create_time` * `update_time` Example: `display_name, create_time desc`.
Location : query
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists NotebookRuntimeTemplates in a Location.
▼ ▲ aiplatform.projects.locations.notebookRuntimeTemplates.delete
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}
HTTP Method : DELETE
Parameters :
name
Description : Required. The name of the NotebookRuntimeTemplate resource to be deleted. Format: `projects/{project}/locations/{location}/notebookRuntimeTemplates/{notebook_runtime_template}`
Pattern : ^projects/[^/]+/locations/[^/]+/notebookRuntimeTemplates/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Deletes a NotebookRuntimeTemplate.
▼ ▲ aiplatform.projects.locations.notebookRuntimeTemplates.patch
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}
HTTP Method : PATCH
Parameters :
name
Description : The resource name of the NotebookRuntimeTemplate.
Pattern : ^projects/[^/]+/locations/[^/]+/notebookRuntimeTemplates/[^/]+$
Location : path
Required : Yes
Type : string
updateMask
Description : Required. The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask. Input format: `{paths: "${updated_filed}"}` Updatable fields: * `encryption_spec.kms_key_name`
Location : query
Type : string
Format : google-fieldmask
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Updates a NotebookRuntimeTemplate.
▼ ▲ aiplatform.projects.locations.notebookRuntimeTemplates.operations.list
Path : v1beta1/{+name}/operations
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}/operations
HTTP Method : GET
Parameters :
name
Description : The name of the operation's parent resource.
Pattern : ^projects/[^/]+/locations/[^/]+/notebookRuntimeTemplates/[^/]+$
Location : path
Required : Yes
Type : string
filter
Description : The standard list filter.
Location : query
Type : string
pageSize
Description : The standard list page size.
Location : query
Type : integer
Format : int32
pageToken
Description : The standard list page token.
Location : query
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
▼ ▲ aiplatform.projects.locations.notebookRuntimeTemplates.operations.get
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}/operations/{operationsId}
HTTP Method : GET
Parameters :
name
Description : The name of the operation resource.
Pattern : ^projects/[^/]+/locations/[^/]+/notebookRuntimeTemplates/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
▼ ▲ aiplatform.projects.locations.notebookRuntimeTemplates.operations.delete
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}/operations/{operationsId}
HTTP Method : DELETE
Parameters :
name
Description : The name of the operation resource to be deleted.
Pattern : ^projects/[^/]+/locations/[^/]+/notebookRuntimeTemplates/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
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`.
▼ ▲ aiplatform.projects.locations.notebookRuntimeTemplates.operations.cancel
Path : v1beta1/{+name}:cancel
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}/operations/{operationsId}:cancel
HTTP Method : POST
Parameters :
name
Description : The name of the operation resource to be cancelled.
Pattern : ^projects/[^/]+/locations/[^/]+/notebookRuntimeTemplates/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
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`.
▼ ▲ aiplatform.projects.locations.notebookRuntimeTemplates.operations.wait
Path : v1beta1/{+name}:wait
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}/operations/{operationsId}:wait
HTTP Method : POST
Parameters :
name
Description : The name of the operation resource to wait on.
Pattern : ^projects/[^/]+/locations/[^/]+/notebookRuntimeTemplates/[^/]+/operations/[^/]+$
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.
Location : query
Type : string
Format : google-duration
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.
▼ ▲ aiplatform.projects.locations.featureOnlineStores.setIamPolicy
Path : v1beta1/{+resource}:setIamPolicy
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}:setIamPolicy
HTTP Method : POST
Parameters :
resource
Description : REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Pattern : ^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : resource
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
▼ ▲ aiplatform.projects.locations.featureOnlineStores.getIamPolicy
Path : v1beta1/{+resource}:getIamPolicy
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}:getIamPolicy
HTTP Method : POST
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.
Pattern : ^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+$
Location : path
Required : Yes
Type : string
options.requestedPolicyVersion
Description : Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
Location : query
Type : integer
Format : int32
Parameter Order : resource
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
▼ ▲ aiplatform.projects.locations.featureOnlineStores.testIamPermissions
Path : v1beta1/{+resource}:testIamPermissions
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}:testIamPermissions
HTTP Method : POST
Parameters :
resource
Description : REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Pattern : ^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+$
Location : path
Required : Yes
Type : string
permissions
Description : The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
Location : query
Repeated : Yes
Type : string
Parameter Order : resource
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
▼ ▲ aiplatform.projects.locations.featureOnlineStores.create
Path : v1beta1/{+parent}/featureOnlineStores
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores
HTTP Method : POST
Parameters :
parent
Description : Required. The resource name of the Location to create FeatureOnlineStores. Format: `projects/{project}/locations/{location}`
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
featureOnlineStoreId
Description : Required. The ID to use for this FeatureOnlineStore, which will become the final component of the FeatureOnlineStore'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
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Creates a new FeatureOnlineStore in a given project and location.
▼ ▲ aiplatform.projects.locations.featureOnlineStores.get
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}
HTTP Method : GET
Parameters :
name
Description : Required. The name of the FeatureOnlineStore resource.
Pattern : ^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets details of a single FeatureOnlineStore.
▼ ▲ aiplatform.projects.locations.featureOnlineStores.list
Path : v1beta1/{+parent}/featureOnlineStores
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores
HTTP Method : GET
Parameters :
parent
Description : Required. The resource name of the Location to list FeatureOnlineStores. Format: `projects/{project}/locations/{location}`
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
filter
Description : Lists the FeatureOnlineStores 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. * `labels`: Supports key-value equality and key presence. Examples: * `create_time > "2020-01-01" OR update_time > "2020-01-01"` FeatureOnlineStores created or updated after 2020-01-01. * `labels.env = "prod"` FeatureOnlineStores with label "env" set to "prod".
Location : query
Type : string
pageSize
Description : The maximum number of FeatureOnlineStores to return. The service may return fewer than this value. If unspecified, at most 100 FeatureOnlineStores will be returned. The maximum value is 100; any value greater than 100 will be coerced to 100.
Location : query
Type : integer
Format : int32
pageToken
Description : A page token, received from a previous FeatureOnlineStoreAdminService.ListFeatureOnlineStores call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeatureOnlineStoreAdminService.ListFeatureOnlineStores must match the call that provided the page token.
Location : query
Type : string
orderBy
Description : A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported Fields: * `create_time` * `update_time`
Location : query
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists FeatureOnlineStores in a given project and location.
▼ ▲ aiplatform.projects.locations.featureOnlineStores.patch
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}
HTTP Method : PATCH
Parameters :
name
Description : Identifier. Name of the FeatureOnlineStore. Format: `projects/{project}/locations/{location}/featureOnlineStores/{featureOnlineStore}`
Pattern : ^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+$
Location : path
Required : Yes
Type : string
updateMask
Description : Field mask is used to specify the fields to be overwritten in the FeatureOnlineStore 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` * `description` * `bigtable` * `bigtable.auto_scaling` * `bigtable.enable_multi_region_replica`
Location : query
Type : string
Format : google-fieldmask
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Updates the parameters of a single FeatureOnlineStore.
▼ ▲ aiplatform.projects.locations.featureOnlineStores.delete
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}
HTTP Method : DELETE
Parameters :
name
Description : Required. The name of the FeatureOnlineStore to be deleted. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}`
Pattern : ^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+$
Location : path
Required : Yes
Type : string
force
Description : If set to true, any FeatureViews and Features for this FeatureOnlineStore will also be deleted. (Otherwise, the request will only work if the FeatureOnlineStore has no FeatureViews.)
Location : query
Type : boolean
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Deletes a single FeatureOnlineStore. The FeatureOnlineStore must not contain any FeatureViews.
▼ ▲ aiplatform.projects.locations.featureOnlineStores.featureViews.setIamPolicy
Path : v1beta1/{+resource}:setIamPolicy
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:setIamPolicy
HTTP Method : POST
Parameters :
resource
Description : REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Pattern : ^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : resource
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
▼ ▲ aiplatform.projects.locations.featureOnlineStores.featureViews.getIamPolicy
Path : v1beta1/{+resource}:getIamPolicy
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:getIamPolicy
HTTP Method : POST
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.
Pattern : ^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$
Location : path
Required : Yes
Type : string
options.requestedPolicyVersion
Description : Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
Location : query
Type : integer
Format : int32
Parameter Order : resource
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
▼ ▲ aiplatform.projects.locations.featureOnlineStores.featureViews.testIamPermissions
Path : v1beta1/{+resource}:testIamPermissions
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:testIamPermissions
HTTP Method : POST
Parameters :
resource
Description : REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Pattern : ^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$
Location : path
Required : Yes
Type : string
permissions
Description : The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
Location : query
Repeated : Yes
Type : string
Parameter Order : resource
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
▼ ▲ aiplatform.projects.locations.featureOnlineStores.featureViews.fetchFeatureValues
Path : v1beta1/{+featureView}:fetchFeatureValues
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:fetchFeatureValues
HTTP Method : POST
Parameters :
featureView
Description : Required. FeatureView resource format `projects/{project}/locations/{location}/featureOnlineStores/{featureOnlineStore}/featureViews/{featureView}`
Pattern : ^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : featureView
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Fetch feature values under a FeatureView.
▼ ▲ aiplatform.projects.locations.featureOnlineStores.featureViews.streamingFetchFeatureValues
Path : v1beta1/{+featureView}:streamingFetchFeatureValues
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:streamingFetchFeatureValues
HTTP Method : POST
Parameters :
featureView
Description : Required. FeatureView resource format `projects/{project}/locations/{location}/featureOnlineStores/{featureOnlineStore}/featureViews/{featureView}`
Pattern : ^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : featureView
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Bidirectional streaming RPC to fetch feature values under a FeatureView. Requests may not have a one-to-one mapping to responses and responses may be returned out-of-order to reduce latency.
▼ ▲ aiplatform.projects.locations.featureOnlineStores.featureViews.searchNearestEntities
Path : v1beta1/{+featureView}:searchNearestEntities
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:searchNearestEntities
HTTP Method : POST
Parameters :
featureView
Description : Required. FeatureView resource format `projects/{project}/locations/{location}/featureOnlineStores/{featureOnlineStore}/featureViews/{featureView}`
Pattern : ^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : featureView
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Search the nearest entities under a FeatureView. Search only works for indexable feature view; if a feature view isn't indexable, returns Invalid argument response.
▼ ▲ aiplatform.projects.locations.featureOnlineStores.featureViews.create
Path : v1beta1/{+parent}/featureViews
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews
HTTP Method : POST
Parameters :
parent
Description : Required. The resource name of the FeatureOnlineStore to create FeatureViews. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}`
Pattern : ^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+$
Location : path
Required : Yes
Type : string
featureViewId
Description : Required. The ID to use for the FeatureView, which will become the final component of the FeatureView'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 FeatureOnlineStore.
Location : query
Type : string
runSyncImmediately
Description : Immutable. If set to true, one on demand sync will be run immediately, regardless whether the FeatureView.sync_config is configured or not.
Location : query
Type : boolean
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Creates a new FeatureView in a given FeatureOnlineStore.
▼ ▲ aiplatform.projects.locations.featureOnlineStores.featureViews.get
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}
HTTP Method : GET
Parameters :
name
Description : Required. The name of the FeatureView resource. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}`
Pattern : ^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets details of a single FeatureView.
▼ ▲ aiplatform.projects.locations.featureOnlineStores.featureViews.list
Path : v1beta1/{+parent}/featureViews
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews
HTTP Method : GET
Parameters :
parent
Description : Required. The resource name of the FeatureOnlineStore to list FeatureViews. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}`
Pattern : ^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+$
Location : path
Required : Yes
Type : string
filter
Description : Lists the FeatureViews 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\"` --> FeatureViews created or updated after 2020-01-31T15:30:00.000000Z. * `labels.active = yes AND labels.env = prod` --> FeatureViews having both (active: yes) and (env: prod) labels. * `labels.env: *` --> Any FeatureView which has a label with 'env' as the key.
Location : query
Type : string
pageSize
Description : The maximum number of FeatureViews to return. The service may return fewer than this value. If unspecified, at most 1000 FeatureViews will be returned. The maximum value is 1000; any value greater than 1000 will be coerced to 1000.
Location : query
Type : integer
Format : int32
pageToken
Description : A page token, received from a previous FeatureOnlineStoreAdminService.ListFeatureViews call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeatureOnlineStoreAdminService.ListFeatureViews must match the call that provided the page token.
Location : query
Type : string
orderBy
Description : A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `feature_view_id` * `create_time` * `update_time`
Location : query
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists FeatureViews in a given FeatureOnlineStore.
▼ ▲ aiplatform.projects.locations.featureOnlineStores.featureViews.patch
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}
HTTP Method : PATCH
Parameters :
name
Description : Identifier. Name of the FeatureView. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}`
Pattern : ^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$
Location : path
Required : Yes
Type : string
updateMask
Description : Field mask is used to specify the fields to be overwritten in the FeatureView 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` * `service_agent_type` * `big_query_source` * `big_query_source.uri` * `big_query_source.entity_id_columns` * `feature_registry_source` * `feature_registry_source.feature_groups` * `sync_config` * `sync_config.cron` * `optimized_config.automatic_resources`
Location : query
Type : string
Format : google-fieldmask
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Updates the parameters of a single FeatureView.
▼ ▲ aiplatform.projects.locations.featureOnlineStores.featureViews.delete
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}
HTTP Method : DELETE
Parameters :
name
Description : Required. The name of the FeatureView to be deleted. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}`
Pattern : ^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Deletes a single FeatureView.
▼ ▲ aiplatform.projects.locations.featureOnlineStores.featureViews.sync
Path : v1beta1/{+featureView}:sync
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:sync
HTTP Method : POST
Parameters :
featureView
Description : Required. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}`
Pattern : ^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : featureView
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Triggers on-demand sync for the FeatureView.
▼ ▲ aiplatform.projects.locations.featureOnlineStores.featureViews.operations.list
Path : v1beta1/{+name}/operations
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}/operations
HTTP Method : GET
Parameters :
name
Description : The name of the operation's parent resource.
Pattern : ^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$
Location : path
Required : Yes
Type : string
filter
Description : The standard list filter.
Location : query
Type : string
pageSize
Description : The standard list page size.
Location : query
Type : integer
Format : int32
pageToken
Description : The standard list page token.
Location : query
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
▼ ▲ aiplatform.projects.locations.featureOnlineStores.featureViews.operations.get
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}/operations/{operationsId}
HTTP Method : GET
Parameters :
name
Description : The name of the operation resource.
Pattern : ^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
▼ ▲ aiplatform.projects.locations.featureOnlineStores.featureViews.operations.delete
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}/operations/{operationsId}
HTTP Method : DELETE
Parameters :
name
Description : The name of the operation resource to be deleted.
Pattern : ^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
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`.
▼ ▲ aiplatform.projects.locations.featureOnlineStores.featureViews.operations.wait
Path : v1beta1/{+name}:wait
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}/operations/{operationsId}:wait
HTTP Method : POST
Parameters :
name
Description : The name of the operation resource to wait on.
Pattern : ^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+/operations/[^/]+$
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.
Location : query
Type : string
Format : google-duration
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.
▼ ▲ aiplatform.projects.locations.featureOnlineStores.featureViews.featureViewSyncs.get
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}/featureViewSyncs/{featureViewSyncsId}
HTTP Method : GET
Parameters :
name
Description : Required. The name of the FeatureViewSync resource. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}/featureViewSyncs/{feature_view_sync}`
Pattern : ^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+/featureViewSyncs/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets details of a single FeatureViewSync.
▼ ▲ aiplatform.projects.locations.featureOnlineStores.featureViews.featureViewSyncs.list
Path : v1beta1/{+parent}/featureViewSyncs
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}/featureViewSyncs
HTTP Method : GET
Parameters :
parent
Description : Required. The resource name of the FeatureView to list FeatureViewSyncs. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}`
Pattern : ^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$
Location : path
Required : Yes
Type : string
filter
Description : Lists the FeatureViewSyncs that match the filter expression. The following filters are supported: * `create_time`: Supports `=`, `!=`, `<`, `>`, `>=`, and `<=` comparisons. Values must be in RFC 3339 format. Examples: * `create_time > \"2020-01-31T15:30:00.000000Z\"` --> FeatureViewSyncs created after 2020-01-31T15:30:00.000000Z.
Location : query
Type : string
pageSize
Description : The maximum number of FeatureViewSyncs to return. The service may return fewer than this value. If unspecified, at most 1000 FeatureViewSyncs will be returned. The maximum value is 1000; any value greater than 1000 will be coerced to 1000.
Location : query
Type : integer
Format : int32
pageToken
Description : A page token, received from a previous FeatureOnlineStoreAdminService.ListFeatureViewSyncs call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeatureOnlineStoreAdminService.ListFeatureViewSyncs must match the call that provided the page token.
Location : query
Type : string
orderBy
Description : A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `create_time`
Location : query
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists FeatureViewSyncs in a given FeatureView.
▼ ▲ aiplatform.projects.locations.featureOnlineStores.operations.list
Path : v1beta1/{+name}/operations
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/operations
HTTP Method : GET
Parameters :
name
Description : The name of the operation's parent resource.
Pattern : ^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+$
Location : path
Required : Yes
Type : string
filter
Description : The standard list filter.
Location : query
Type : string
pageSize
Description : The standard list page size.
Location : query
Type : integer
Format : int32
pageToken
Description : The standard list page token.
Location : query
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
▼ ▲ aiplatform.projects.locations.featureOnlineStores.operations.get
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/operations/{operationsId}
HTTP Method : GET
Parameters :
name
Description : The name of the operation resource.
Pattern : ^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
▼ ▲ aiplatform.projects.locations.featureOnlineStores.operations.delete
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/operations/{operationsId}
HTTP Method : DELETE
Parameters :
name
Description : The name of the operation resource to be deleted.
Pattern : ^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
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`.
▼ ▲ aiplatform.projects.locations.featureOnlineStores.operations.wait
Path : v1beta1/{+name}:wait
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/operations/{operationsId}:wait
HTTP Method : POST
Parameters :
name
Description : The name of the operation resource to wait on.
Pattern : ^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/operations/[^/]+$
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.
Location : query
Type : string
Format : google-duration
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.
▼ ▲ aiplatform.projects.locations.featureGroups.setIamPolicy
Path : v1beta1/{+resource}:setIamPolicy
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}:setIamPolicy
HTTP Method : POST
Parameters :
resource
Description : REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Pattern : ^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : resource
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
▼ ▲ aiplatform.projects.locations.featureGroups.getIamPolicy
Path : v1beta1/{+resource}:getIamPolicy
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}:getIamPolicy
HTTP Method : POST
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.
Pattern : ^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+$
Location : path
Required : Yes
Type : string
options.requestedPolicyVersion
Description : Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
Location : query
Type : integer
Format : int32
Parameter Order : resource
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
▼ ▲ aiplatform.projects.locations.featureGroups.testIamPermissions
Path : v1beta1/{+resource}:testIamPermissions
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}:testIamPermissions
HTTP Method : POST
Parameters :
resource
Description : REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Pattern : ^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+$
Location : path
Required : Yes
Type : string
permissions
Description : The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
Location : query
Repeated : Yes
Type : string
Parameter Order : resource
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
▼ ▲ aiplatform.projects.locations.featureGroups.create
Path : v1beta1/{+parent}/featureGroups
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups
HTTP Method : POST
Parameters :
parent
Description : Required. The resource name of the Location to create FeatureGroups. Format: `projects/{project}/locations/{location}`
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
featureGroupId
Description : Required. The ID to use for this FeatureGroup, which will become the final component of the FeatureGroup'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 the project and location.
Location : query
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Creates a new FeatureGroup in a given project and location.
▼ ▲ aiplatform.projects.locations.featureGroups.get
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}
HTTP Method : GET
Parameters :
name
Description : Required. The name of the FeatureGroup resource.
Pattern : ^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets details of a single FeatureGroup.
▼ ▲ aiplatform.projects.locations.featureGroups.list
Path : v1beta1/{+parent}/featureGroups
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups
HTTP Method : GET
Parameters :
parent
Description : Required. The resource name of the Location to list FeatureGroups. Format: `projects/{project}/locations/{location}`
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
filter
Description : Lists the FeatureGroups 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. * `labels`: Supports key-value equality and key presence. Examples: * `create_time > "2020-01-01" OR update_time > "2020-01-01"` FeatureGroups created or updated after 2020-01-01. * `labels.env = "prod"` FeatureGroups with label "env" set to "prod".
Location : query
Type : string
pageSize
Description : The maximum number of FeatureGroups to return. The service may return fewer than this value. If unspecified, at most 100 FeatureGroups will be returned. The maximum value is 100; any value greater than 100 will be coerced to 100.
Location : query
Type : integer
Format : int32
pageToken
Description : A page token, received from a previous FeatureRegistryService.ListFeatureGroups call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeatureRegistryService.ListFeatureGroups must match the call that provided the page token.
Location : query
Type : string
orderBy
Description : A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported Fields: * `create_time` * `update_time`
Location : query
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists FeatureGroups in a given project and location.
▼ ▲ aiplatform.projects.locations.featureGroups.patch
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}
HTTP Method : PATCH
Parameters :
name
Description : Identifier. Name of the FeatureGroup. Format: `projects/{project}/locations/{location}/featureGroups/{featureGroup}`
Pattern : ^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+$
Location : path
Required : Yes
Type : string
updateMask
Description : Field mask is used to specify the fields to be overwritten in the FeatureGroup 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` * `description` * `big_query` * `big_query.entity_id_columns`
Location : query
Type : string
Format : google-fieldmask
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Updates the parameters of a single FeatureGroup.
▼ ▲ aiplatform.projects.locations.featureGroups.delete
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}
HTTP Method : DELETE
Parameters :
name
Description : Required. The name of the FeatureGroup to be deleted. Format: `projects/{project}/locations/{location}/featureGroups/{feature_group}`
Pattern : ^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+$
Location : path
Required : Yes
Type : string
force
Description : If set to true, any Features under this FeatureGroup will also be deleted. (Otherwise, the request will only work if the FeatureGroup has no Features.)
Location : query
Type : boolean
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Deletes a single FeatureGroup.
▼ ▲ aiplatform.projects.locations.featureGroups.operations.list
Path : v1beta1/{+name}/operations
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/operations
HTTP Method : GET
Parameters :
name
Description : The name of the operation's parent resource.
Pattern : ^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+$
Location : path
Required : Yes
Type : string
filter
Description : The standard list filter.
Location : query
Type : string
pageSize
Description : The standard list page size.
Location : query
Type : integer
Format : int32
pageToken
Description : The standard list page token.
Location : query
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
▼ ▲ aiplatform.projects.locations.featureGroups.operations.get
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/operations/{operationsId}
HTTP Method : GET
Parameters :
name
Description : The name of the operation resource.
Pattern : ^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
▼ ▲ aiplatform.projects.locations.featureGroups.operations.delete
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/operations/{operationsId}
HTTP Method : DELETE
Parameters :
name
Description : The name of the operation resource to be deleted.
Pattern : ^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
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`.
▼ ▲ aiplatform.projects.locations.featureGroups.operations.wait
Path : v1beta1/{+name}:wait
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/operations/{operationsId}:wait
HTTP Method : POST
Parameters :
name
Description : The name of the operation resource to wait on.
Pattern : ^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/operations/[^/]+$
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.
Location : query
Type : string
Format : google-duration
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.
▼ ▲ aiplatform.projects.locations.featureGroups.features.create
Path : v1beta1/{+parent}/features
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features
HTTP Method : POST
Parameters :
parent
Description : Required. The resource name of the EntityType or FeatureGroup to create a Feature. Format for entity_type as parent: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` Format for feature_group as parent: `projects/{project}/locations/{location}/featureGroups/{feature_group}`
Pattern : ^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+$
Location : path
Required : Yes
Type : string
featureId
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.
Location : query
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Creates a new Feature in a given FeatureGroup.
▼ ▲ aiplatform.projects.locations.featureGroups.features.batchCreate
Path : v1beta1/{+parent}/features:batchCreate
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features:batchCreate
HTTP Method : POST
Parameters :
parent
Description : Required. The resource name of the EntityType/FeatureGroup to create the batch of Features under. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` `projects/{project}/locations/{location}/featureGroups/{feature_group}`
Pattern : ^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Creates a batch of Features in a given FeatureGroup.
▼ ▲ aiplatform.projects.locations.featureGroups.features.get
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features/{featuresId}
HTTP Method : GET
Parameters :
name
Description : Required. The name of the Feature resource. Format for entity_type as parent: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` Format for feature_group as parent: `projects/{project}/locations/{location}/featureGroups/{feature_group}`
Pattern : ^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/features/[^/]+$
Location : path
Required : Yes
Type : string
featureStatsAndAnomalySpec.latestStatsCount
Description : Optional. If set, returns the most recent count of stats. Valid value is [0, 100]. If stats_time_range is set, return most recent count of stats within the stats_time_range.
Location : query
Type : integer
Format : int32
featureStatsAndAnomalySpec.statsTimeRange.startTime
Description : Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.
Location : query
Type : string
Format : google-datetime
featureStatsAndAnomalySpec.statsTimeRange.endTime
Description : Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.
Location : query
Type : string
Format : google-datetime
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets details of a single Feature.
▼ ▲ aiplatform.projects.locations.featureGroups.features.list
Path : v1beta1/{+parent}/features
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features
HTTP Method : GET
Parameters :
parent
Description : Required. The resource name of the Location to list Features. Format for entity_type as parent: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` Format for feature_group as parent: `projects/{project}/locations/{location}/featureGroups/{feature_group}`
Pattern : ^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+$
Location : path
Required : Yes
Type : string
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
pageSize
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.
Location : query
Type : integer
Format : int32
pageToken
Description : A page token, received from a previous FeaturestoreService.ListFeatures call or FeatureRegistryService.ListFeatures call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeaturestoreService.ListFeatures or FeatureRegistryService.ListFeatures must match the call that provided the page token.
Location : query
Type : string
orderBy
Description : A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `feature_id` * `value_type` (Not supported for FeatureRegistry Feature) * `create_time` * `update_time`
Location : query
Type : string
readMask
Description : Mask specifying which fields to read.
Location : query
Type : string
Format : google-fieldmask
latestStatsCount
Description : Only applicable for Vertex AI Feature Store (Legacy). If set, return the most recent ListFeaturesRequest.latest_stats_count of stats for each Feature in response. Valid value is [0, 10]. If number of stats exists < ListFeaturesRequest.latest_stats_count, return all existing stats.
Location : query
Type : integer
Format : int32
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists Features in a given FeatureGroup.
▼ ▲ aiplatform.projects.locations.featureGroups.features.patch
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features/{featuresId}
HTTP Method : PATCH
Parameters :
name
Description : Immutable. Name of the Feature. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}/features/{feature}` `projects/{project}/locations/{location}/featureGroups/{feature_group}/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.
Pattern : ^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/features/[^/]+$
Location : path
Required : Yes
Type : string
updateMask
Description : Field mask is used to specify the fields to be overwritten in the Features resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `description` * `labels` * `disable_monitoring` (Not supported for FeatureRegistryService Feature) * `point_of_contact` (Not supported for FeaturestoreService FeatureStore)
Location : query
Type : string
Format : google-fieldmask
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Updates the parameters of a single Feature.
▼ ▲ aiplatform.projects.locations.featureGroups.features.delete
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features/{featuresId}
HTTP Method : DELETE
Parameters :
name
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}`
Pattern : ^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/features/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Deletes a single Feature.
▼ ▲ aiplatform.projects.locations.featureGroups.features.operations.list
Path : v1beta1/{+name}/operations
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features/{featuresId}/operations
HTTP Method : GET
Parameters :
name
Description : The name of the operation's parent resource.
Pattern : ^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/features/[^/]+$
Location : path
Required : Yes
Type : string
filter
Description : The standard list filter.
Location : query
Type : string
pageSize
Description : The standard list page size.
Location : query
Type : integer
Format : int32
pageToken
Description : The standard list page token.
Location : query
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
▼ ▲ aiplatform.projects.locations.featureGroups.features.operations.get
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features/{featuresId}/operations/{operationsId}
HTTP Method : GET
Parameters :
name
Description : The name of the operation resource.
Pattern : ^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/features/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
▼ ▲ aiplatform.projects.locations.featureGroups.features.operations.delete
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features/{featuresId}/operations/{operationsId}
HTTP Method : DELETE
Parameters :
name
Description : The name of the operation resource to be deleted.
Pattern : ^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/features/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
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`.
▼ ▲ aiplatform.projects.locations.featureGroups.features.operations.wait
Path : v1beta1/{+name}:wait
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features/{featuresId}/operations/{operationsId}:wait
HTTP Method : POST
Parameters :
name
Description : The name of the operation resource to wait on.
Pattern : ^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/features/[^/]+/operations/[^/]+$
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.
Location : query
Type : string
Format : google-duration
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.
▼ ▲ aiplatform.projects.locations.featureGroups.featureMonitors.create
Path : v1beta1/{+parent}/featureMonitors
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/featureMonitors
HTTP Method : POST
Parameters :
parent
Description : Required. The resource name of FeatureGroup to create FeatureMonitor. Format: `projects/{project}/locations/{location}/featureGroups/{featuregroup}`
Pattern : ^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+$
Location : path
Required : Yes
Type : string
featureMonitorId
Description : Required. The ID to use for this FeatureMonitor, which will become the final component of the FeatureGroup'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 FeatureGroup.
Location : query
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Creates a new FeatureMonitor in a given project, location and FeatureGroup.
▼ ▲ aiplatform.projects.locations.featureGroups.featureMonitors.get
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/featureMonitors/{featureMonitorsId}
HTTP Method : GET
Parameters :
name
Description : Required. The name of the FeatureMonitor resource.
Pattern : ^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/featureMonitors/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets details of a single FeatureMonitor.
▼ ▲ aiplatform.projects.locations.featureGroups.featureMonitors.list
Path : v1beta1/{+parent}/featureMonitors
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/featureMonitors
HTTP Method : GET
Parameters :
parent
Description : Required. The resource name of the FeatureGroup to list FeatureMonitors. Format: `projects/{project}/locations/{location}/featureGroups/{featureGroup}`
Pattern : ^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+$
Location : path
Required : Yes
Type : string
filter
Description : Optional. Lists the FeatureMonitors 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. * `labels`: Supports key-value equality and key presence. Examples: * `create_time > "2020-01-01" OR update_time > "2020-01-01"` FeatureMonitors created or updated after 2020-01-01. * `labels.env = "prod"` FeatureGroups with label "env" set to "prod".
Location : query
Type : string
pageSize
Description : Optional. The maximum number of FeatureGroups to return. The service may return fewer than this value. If unspecified, at most 100 FeatureMonitors will be returned. The maximum value is 100; any value greater than 100 will be coerced to 100.
Location : query
Type : integer
Format : int32
pageToken
Description : Optional. A page token, received from a previous FeatureRegistryService.ListFeatureMonitors call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeatureRegistryService.ListFeatureMonitors must match the call that provided the page token.
Location : query
Type : string
orderBy
Description : Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported Fields: * `create_time` * `update_time`
Location : query
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists FeatureGroups in a given project and location.
▼ ▲ aiplatform.projects.locations.featureGroups.featureMonitors.delete
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/featureMonitors/{featureMonitorsId}
HTTP Method : DELETE
Parameters :
name
Description : Required. The name of the FeatureMonitor to be deleted. Format: `projects/{project}/locations/{location}/featureGroups/{feature_group}/featureMonitors/{feature_monitor}`
Pattern : ^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/featureMonitors/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Deletes a single FeatureMonitor.
▼ ▲ aiplatform.projects.locations.featureGroups.featureMonitors.operations.list
Path : v1beta1/{+name}/operations
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/featureMonitors/{featureMonitorsId}/operations
HTTP Method : GET
Parameters :
name
Description : The name of the operation's parent resource.
Pattern : ^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/featureMonitors/[^/]+$
Location : path
Required : Yes
Type : string
filter
Description : The standard list filter.
Location : query
Type : string
pageSize
Description : The standard list page size.
Location : query
Type : integer
Format : int32
pageToken
Description : The standard list page token.
Location : query
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
▼ ▲ aiplatform.projects.locations.featureGroups.featureMonitors.operations.get
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/featureMonitors/{featureMonitorsId}/operations/{operationsId}
HTTP Method : GET
Parameters :
name
Description : The name of the operation resource.
Pattern : ^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/featureMonitors/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
▼ ▲ aiplatform.projects.locations.featureGroups.featureMonitors.operations.delete
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/featureMonitors/{featureMonitorsId}/operations/{operationsId}
HTTP Method : DELETE
Parameters :
name
Description : The name of the operation resource to be deleted.
Pattern : ^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/featureMonitors/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
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`.
▼ ▲ aiplatform.projects.locations.featureGroups.featureMonitors.operations.wait
Path : v1beta1/{+name}:wait
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/featureMonitors/{featureMonitorsId}/operations/{operationsId}:wait
HTTP Method : POST
Parameters :
name
Description : The name of the operation resource to wait on.
Pattern : ^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/featureMonitors/[^/]+/operations/[^/]+$
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.
Location : query
Type : string
Format : google-duration
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.
▼ ▲ aiplatform.projects.locations.featureGroups.featureMonitors.featureMonitorJobs.create
Path : v1beta1/{+parent}/featureMonitorJobs
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/featureMonitors/{featureMonitorsId}/featureMonitorJobs
HTTP Method : POST
Parameters :
parent
Description : Required. The resource name of FeatureMonitor to create FeatureMonitorJob. Format: `projects/{project}/locations/{location}/featureGroups/{feature_group}/featureMonitors/{feature_monitor}`
Pattern : ^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/featureMonitors/[^/]+$
Location : path
Required : Yes
Type : string
featureMonitorJobId
Description : Optional. Output only. System-generated ID for feature monitor job.
Location : query
Type : string
Format : int64
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Creates a new feature monitor job.
▼ ▲ aiplatform.projects.locations.featureGroups.featureMonitors.featureMonitorJobs.get
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/featureMonitors/{featureMonitorsId}/featureMonitorJobs/{featureMonitorJobsId}
HTTP Method : GET
Parameters :
name
Description : Required. The name of the FeatureMonitorJob resource. Format: `projects/{project}/locations/{location}/featureGroups/{feature_group}/featureMonitors/{feature_monitor}/featureMonitorJobs/{feature_monitor_job}`
Pattern : ^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/featureMonitors/[^/]+/featureMonitorJobs/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Get a feature monitor job.
▼ ▲ aiplatform.projects.locations.featureGroups.featureMonitors.featureMonitorJobs.list
Path : v1beta1/{+parent}/featureMonitorJobs
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/featureMonitors/{featureMonitorsId}/featureMonitorJobs
HTTP Method : GET
Parameters :
parent
Description : Required. The resource name of the FeatureMonitor to list FeatureMonitorJobs. Format: `projects/{project}/locations/{location}/featureGroups/{feature_group}/featureMonitors/{feature_monitor}`
Pattern : ^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/featureMonitors/[^/]+$
Location : path
Required : Yes
Type : string
filter
Description : Optional. Lists the FeatureMonitorJobs that match the filter expression. The following fields are supported: * `create_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be Examples: * `create_time > "2020-01-01"` FeatureMonitorJobs created after 2020-01-01.
Location : query
Type : string
pageSize
Description : Optional. The maximum number of FeatureMonitorJobs to return. The service may return fewer than this value. If unspecified, at most 100 FeatureMonitorJobs will be returned. The maximum value is 100; any value greater than 100 will be coerced to 100.
Location : query
Type : integer
Format : int32
pageToken
Description : Optional. A page token, received from a previous FeatureRegistryService.ListFeatureMonitorJobs call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeatureRegistryService.ListFeatureMonitorJobs must match the call that provided the page token.
Location : query
Type : string
orderBy
Description : Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported Fields: * `create_time`
Location : query
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : List feature monitor jobs.
▼ ▲ aiplatform.projects.locations.publishers.models.getIamPolicy
Path : v1beta1/{+resource}:getIamPolicy
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:getIamPolicy
HTTP Method : POST
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.
Pattern : ^projects/[^/]+/locations/[^/]+/publishers/[^/]+/models/[^/]+$
Location : path
Required : Yes
Type : string
options.requestedPolicyVersion
Description : Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
Location : query
Type : integer
Format : int32
Parameter Order : resource
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
▼ ▲ aiplatform.projects.locations.publishers.models.predict
Path : v1beta1/{+endpoint}:predict
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:predict
HTTP Method : POST
Parameters :
endpoint
Description : Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`
Pattern : ^projects/[^/]+/locations/[^/]+/publishers/[^/]+/models/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : endpoint
Scopes :
Description : Perform an online prediction.
▼ ▲ aiplatform.projects.locations.publishers.models.rawPredict
Path : v1beta1/{+endpoint}:rawPredict
Flat Path : v1beta1/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}`
Pattern : ^projects/[^/]+/locations/[^/]+/publishers/[^/]+/models/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : endpoint
Scopes :
Description : Perform an online prediction with an arbitrary HTTP payload. The response includes the following HTTP headers: * `X-Vertex-AI-Endpoint-Id`: ID of the Endpoint that served this prediction. * `X-Vertex-AI-Deployed-Model-Id`: ID of the Endpoint's DeployedModel that served this prediction.
▼ ▲ aiplatform.projects.locations.publishers.models.streamRawPredict
Path : v1beta1/{+endpoint}:streamRawPredict
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:streamRawPredict
HTTP Method : POST
Parameters :
endpoint
Description : Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`
Pattern : ^projects/[^/]+/locations/[^/]+/publishers/[^/]+/models/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : endpoint
Scopes :
Description : Perform a streaming online prediction with an arbitrary HTTP payload.
▼ ▲ aiplatform.projects.locations.publishers.models.serverStreamingPredict
Path : v1beta1/{+endpoint}:serverStreamingPredict
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:serverStreamingPredict
HTTP Method : POST
Parameters :
endpoint
Description : Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`
Pattern : ^projects/[^/]+/locations/[^/]+/publishers/[^/]+/models/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : endpoint
Scopes :
Description : Perform a server-side streaming online prediction request for Vertex LLM streaming.
▼ ▲ aiplatform.projects.locations.publishers.models.predictLongRunning
Path : v1beta1/{+endpoint}:predictLongRunning
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:predictLongRunning
HTTP Method : POST
Parameters :
endpoint
Description : Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}` or `projects/{project}/locations/{location}/publishers/{publisher}/models/{model}`
Pattern : ^projects/[^/]+/locations/[^/]+/publishers/[^/]+/models/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : endpoint
Scopes :
▼ ▲ aiplatform.projects.locations.publishers.models.fetchPredictOperation
Path : v1beta1/{+endpoint}:fetchPredictOperation
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:fetchPredictOperation
HTTP Method : POST
Parameters :
endpoint
Description : Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}` or `projects/{project}/locations/{location}/publishers/{publisher}/models/{model}`
Pattern : ^projects/[^/]+/locations/[^/]+/publishers/[^/]+/models/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : endpoint
Scopes :
Description : Fetch an asynchronous online prediction operation.
▼ ▲ aiplatform.projects.locations.publishers.models.countTokens
Path : v1beta1/{+endpoint}:countTokens
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:countTokens
HTTP Method : POST
Parameters :
endpoint
Description : Required. The name of the Endpoint requested to perform token counting. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`
Pattern : ^projects/[^/]+/locations/[^/]+/publishers/[^/]+/models/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : endpoint
Scopes :
Description : Perform a token counting.
▼ ▲ aiplatform.projects.locations.publishers.models.generateContent
Path : v1beta1/{+model}:generateContent
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:generateContent
HTTP Method : POST
Parameters :
model
Description : Required. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`
Pattern : ^projects/[^/]+/locations/[^/]+/publishers/[^/]+/models/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : model
Scopes :
Description : Generate content with multimodal inputs.
▼ ▲ aiplatform.projects.locations.publishers.models.streamGenerateContent
Path : v1beta1/{+model}:streamGenerateContent
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:streamGenerateContent
HTTP Method : POST
Parameters :
model
Description : Required. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`
Pattern : ^projects/[^/]+/locations/[^/]+/publishers/[^/]+/models/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : model
Scopes :
Description : Generate content with multimodal inputs with streaming support.
▼ ▲ aiplatform.projects.locations.publishers.models.computeTokens
Path : v1beta1/{+endpoint}:computeTokens
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:computeTokens
HTTP Method : POST
Parameters :
endpoint
Description : Required. The name of the Endpoint requested to get lists of tokens and token ids.
Pattern : ^projects/[^/]+/locations/[^/]+/publishers/[^/]+/models/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : endpoint
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Return a list of tokens based on the input text.
▼ ▲ aiplatform.projects.locations.operations.list
Path : v1beta1/{+name}/operations
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/operations
HTTP Method : GET
Parameters :
name
Description : The name of the operation's parent resource.
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
filter
Description : The standard list filter.
Location : query
Type : string
pageSize
Description : The standard list page size.
Location : query
Type : integer
Format : int32
pageToken
Description : The standard list page token.
Location : query
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
▼ ▲ aiplatform.projects.locations.operations.get
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}
HTTP Method : GET
Parameters :
name
Description : The name of the operation resource.
Pattern : ^projects/[^/]+/locations/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
▼ ▲ aiplatform.projects.locations.operations.delete
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}
HTTP Method : DELETE
Parameters :
name
Description : The name of the operation resource to be deleted.
Pattern : ^projects/[^/]+/locations/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
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`.
▼ ▲ aiplatform.projects.locations.operations.cancel
Path : v1beta1/{+name}:cancel
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel
HTTP Method : POST
Parameters :
name
Description : The name of the operation resource to be cancelled.
Pattern : ^projects/[^/]+/locations/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
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`.
▼ ▲ aiplatform.projects.locations.operations.wait
Path : v1beta1/{+name}:wait
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:wait
HTTP Method : POST
Parameters :
name
Description : The name of the operation resource to wait on.
Pattern : ^projects/[^/]+/locations/[^/]+/operations/[^/]+$
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.
Location : query
Type : string
Format : google-duration
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.
▼ ▲ aiplatform.projects.locations.agents.operations.list
Path : v1beta1/{+name}/operations
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/operations
HTTP Method : GET
Parameters :
name
Description : The name of the operation's parent resource.
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+$
Location : path
Required : Yes
Type : string
filter
Description : The standard list filter.
Location : query
Type : string
pageSize
Description : The standard list page size.
Location : query
Type : integer
Format : int32
pageToken
Description : The standard list page token.
Location : query
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
▼ ▲ aiplatform.projects.locations.agents.operations.get
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/operations/{operationsId}
HTTP Method : GET
Parameters :
name
Description : The name of the operation resource.
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
▼ ▲ aiplatform.projects.locations.agents.operations.delete
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/operations/{operationsId}
HTTP Method : DELETE
Parameters :
name
Description : The name of the operation resource to be deleted.
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
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`.
▼ ▲ aiplatform.projects.locations.agents.operations.cancel
Path : v1beta1/{+name}:cancel
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/operations/{operationsId}:cancel
HTTP Method : POST
Parameters :
name
Description : The name of the operation resource to be cancelled.
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
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`.
▼ ▲ aiplatform.projects.locations.agents.operations.wait
Path : v1beta1/{+name}:wait
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/operations/{operationsId}:wait
HTTP Method : POST
Parameters :
name
Description : The name of the operation resource to wait on.
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+/operations/[^/]+$
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.
Location : query
Type : string
Format : google-duration
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.
▼ ▲ aiplatform.projects.locations.apps.operations.list
Path : v1beta1/{+name}/operations
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/operations
HTTP Method : GET
Parameters :
name
Description : The name of the operation's parent resource.
Pattern : ^projects/[^/]+/locations/[^/]+/apps/[^/]+$
Location : path
Required : Yes
Type : string
filter
Description : The standard list filter.
Location : query
Type : string
pageSize
Description : The standard list page size.
Location : query
Type : integer
Format : int32
pageToken
Description : The standard list page token.
Location : query
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
▼ ▲ aiplatform.projects.locations.apps.operations.get
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/operations/{operationsId}
HTTP Method : GET
Parameters :
name
Description : The name of the operation resource.
Pattern : ^projects/[^/]+/locations/[^/]+/apps/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
▼ ▲ aiplatform.projects.locations.apps.operations.delete
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/operations/{operationsId}
HTTP Method : DELETE
Parameters :
name
Description : The name of the operation resource to be deleted.
Pattern : ^projects/[^/]+/locations/[^/]+/apps/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
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`.
▼ ▲ aiplatform.projects.locations.apps.operations.cancel
Path : v1beta1/{+name}:cancel
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/operations/{operationsId}:cancel
HTTP Method : POST
Parameters :
name
Description : The name of the operation resource to be cancelled.
Pattern : ^projects/[^/]+/locations/[^/]+/apps/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
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`.
▼ ▲ aiplatform.projects.locations.apps.operations.wait
Path : v1beta1/{+name}:wait
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/operations/{operationsId}:wait
HTTP Method : POST
Parameters :
name
Description : The name of the operation resource to wait on.
Pattern : ^projects/[^/]+/locations/[^/]+/apps/[^/]+/operations/[^/]+$
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.
Location : query
Type : string
Format : google-duration
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.
▼ ▲ aiplatform.projects.locations.edgeDevices.operations.list
Path : v1beta1/{+name}/operations
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/edgeDevices/{edgeDevicesId}/operations
HTTP Method : GET
Parameters :
name
Description : The name of the operation's parent resource.
Pattern : ^projects/[^/]+/locations/[^/]+/edgeDevices/[^/]+$
Location : path
Required : Yes
Type : string
filter
Description : The standard list filter.
Location : query
Type : string
pageSize
Description : The standard list page size.
Location : query
Type : integer
Format : int32
pageToken
Description : The standard list page token.
Location : query
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
▼ ▲ aiplatform.projects.locations.edgeDevices.operations.get
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/edgeDevices/{edgeDevicesId}/operations/{operationsId}
HTTP Method : GET
Parameters :
name
Description : The name of the operation resource.
Pattern : ^projects/[^/]+/locations/[^/]+/edgeDevices/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
▼ ▲ aiplatform.projects.locations.edgeDevices.operations.delete
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/edgeDevices/{edgeDevicesId}/operations/{operationsId}
HTTP Method : DELETE
Parameters :
name
Description : The name of the operation resource to be deleted.
Pattern : ^projects/[^/]+/locations/[^/]+/edgeDevices/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
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`.
▼ ▲ aiplatform.projects.locations.edgeDevices.operations.cancel
Path : v1beta1/{+name}:cancel
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/edgeDevices/{edgeDevicesId}/operations/{operationsId}:cancel
HTTP Method : POST
Parameters :
name
Description : The name of the operation resource to be cancelled.
Pattern : ^projects/[^/]+/locations/[^/]+/edgeDevices/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
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`.
▼ ▲ aiplatform.projects.locations.edgeDevices.operations.wait
Path : v1beta1/{+name}:wait
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/edgeDevices/{edgeDevicesId}/operations/{operationsId}:wait
HTTP Method : POST
Parameters :
name
Description : The name of the operation resource to wait on.
Pattern : ^projects/[^/]+/locations/[^/]+/edgeDevices/[^/]+/operations/[^/]+$
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.
Location : query
Type : string
Format : google-duration
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.
▼ ▲ aiplatform.projects.locations.evaluationTasks.operations.list
Path : v1beta1/{+name}/operations
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationTasks/{evaluationTasksId}/operations
HTTP Method : GET
Parameters :
name
Description : The name of the operation's parent resource.
Pattern : ^projects/[^/]+/locations/[^/]+/evaluationTasks/[^/]+$
Location : path
Required : Yes
Type : string
filter
Description : The standard list filter.
Location : query
Type : string
pageSize
Description : The standard list page size.
Location : query
Type : integer
Format : int32
pageToken
Description : The standard list page token.
Location : query
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
▼ ▲ aiplatform.projects.locations.evaluationTasks.operations.get
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationTasks/{evaluationTasksId}/operations/{operationsId}
HTTP Method : GET
Parameters :
name
Description : The name of the operation resource.
Pattern : ^projects/[^/]+/locations/[^/]+/evaluationTasks/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
▼ ▲ aiplatform.projects.locations.evaluationTasks.operations.delete
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationTasks/{evaluationTasksId}/operations/{operationsId}
HTTP Method : DELETE
Parameters :
name
Description : The name of the operation resource to be deleted.
Pattern : ^projects/[^/]+/locations/[^/]+/evaluationTasks/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
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`.
▼ ▲ aiplatform.projects.locations.evaluationTasks.operations.wait
Path : v1beta1/{+name}:wait
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationTasks/{evaluationTasksId}/operations/{operationsId}:wait
HTTP Method : POST
Parameters :
name
Description : The name of the operation resource to wait on.
Pattern : ^projects/[^/]+/locations/[^/]+/evaluationTasks/[^/]+/operations/[^/]+$
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.
Location : query
Type : string
Format : google-duration
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.
▼ ▲ aiplatform.projects.locations.exampleStores.operations.list
Path : v1beta1/{+name}/operations
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/exampleStores/{exampleStoresId}/operations
HTTP Method : GET
Parameters :
name
Description : The name of the operation's parent resource.
Pattern : ^projects/[^/]+/locations/[^/]+/exampleStores/[^/]+$
Location : path
Required : Yes
Type : string
filter
Description : The standard list filter.
Location : query
Type : string
pageSize
Description : The standard list page size.
Location : query
Type : integer
Format : int32
pageToken
Description : The standard list page token.
Location : query
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
▼ ▲ aiplatform.projects.locations.exampleStores.operations.get
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/exampleStores/{exampleStoresId}/operations/{operationsId}
HTTP Method : GET
Parameters :
name
Description : The name of the operation resource.
Pattern : ^projects/[^/]+/locations/[^/]+/exampleStores/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
▼ ▲ aiplatform.projects.locations.exampleStores.operations.delete
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/exampleStores/{exampleStoresId}/operations/{operationsId}
HTTP Method : DELETE
Parameters :
name
Description : The name of the operation resource to be deleted.
Pattern : ^projects/[^/]+/locations/[^/]+/exampleStores/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
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`.
▼ ▲ aiplatform.projects.locations.exampleStores.operations.cancel
Path : v1beta1/{+name}:cancel
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/exampleStores/{exampleStoresId}/operations/{operationsId}:cancel
HTTP Method : POST
Parameters :
name
Description : The name of the operation resource to be cancelled.
Pattern : ^projects/[^/]+/locations/[^/]+/exampleStores/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
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`.
▼ ▲ aiplatform.projects.locations.exampleStores.operations.wait
Path : v1beta1/{+name}:wait
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/exampleStores/{exampleStoresId}/operations/{operationsId}:wait
HTTP Method : POST
Parameters :
name
Description : The name of the operation resource to wait on.
Pattern : ^projects/[^/]+/locations/[^/]+/exampleStores/[^/]+/operations/[^/]+$
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.
Location : query
Type : string
Format : google-duration
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.
▼ ▲ aiplatform.projects.locations.extensionControllers.operations.list
Path : v1beta1/{+name}/operations
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/extensionControllers/{extensionControllersId}/operations
HTTP Method : GET
Parameters :
name
Description : The name of the operation's parent resource.
Pattern : ^projects/[^/]+/locations/[^/]+/extensionControllers/[^/]+$
Location : path
Required : Yes
Type : string
filter
Description : The standard list filter.
Location : query
Type : string
pageSize
Description : The standard list page size.
Location : query
Type : integer
Format : int32
pageToken
Description : The standard list page token.
Location : query
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
▼ ▲ aiplatform.projects.locations.extensionControllers.operations.get
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/extensionControllers/{extensionControllersId}/operations/{operationsId}
HTTP Method : GET
Parameters :
name
Description : The name of the operation resource.
Pattern : ^projects/[^/]+/locations/[^/]+/extensionControllers/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
▼ ▲ aiplatform.projects.locations.extensionControllers.operations.delete
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/extensionControllers/{extensionControllersId}/operations/{operationsId}
HTTP Method : DELETE
Parameters :
name
Description : The name of the operation resource to be deleted.
Pattern : ^projects/[^/]+/locations/[^/]+/extensionControllers/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
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`.
▼ ▲ aiplatform.projects.locations.extensionControllers.operations.cancel
Path : v1beta1/{+name}:cancel
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/extensionControllers/{extensionControllersId}/operations/{operationsId}:cancel
HTTP Method : POST
Parameters :
name
Description : The name of the operation resource to be cancelled.
Pattern : ^projects/[^/]+/locations/[^/]+/extensionControllers/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
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`.
▼ ▲ aiplatform.projects.locations.extensionControllers.operations.wait
Path : v1beta1/{+name}:wait
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/extensionControllers/{extensionControllersId}/operations/{operationsId}:wait
HTTP Method : POST
Parameters :
name
Description : The name of the operation resource to wait on.
Pattern : ^projects/[^/]+/locations/[^/]+/extensionControllers/[^/]+/operations/[^/]+$
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.
Location : query
Type : string
Format : google-duration
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.
▼ ▲ aiplatform.projects.locations.solvers.operations.list
Path : v1beta1/{+name}/operations
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/solvers/{solversId}/operations
HTTP Method : GET
Parameters :
name
Description : The name of the operation's parent resource.
Pattern : ^projects/[^/]+/locations/[^/]+/solvers/[^/]+$
Location : path
Required : Yes
Type : string
filter
Description : The standard list filter.
Location : query
Type : string
pageSize
Description : The standard list page size.
Location : query
Type : integer
Format : int32
pageToken
Description : The standard list page token.
Location : query
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
▼ ▲ aiplatform.projects.locations.solvers.operations.get
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/solvers/{solversId}/operations/{operationsId}
HTTP Method : GET
Parameters :
name
Description : The name of the operation resource.
Pattern : ^projects/[^/]+/locations/[^/]+/solvers/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
▼ ▲ aiplatform.projects.locations.solvers.operations.delete
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/solvers/{solversId}/operations/{operationsId}
HTTP Method : DELETE
Parameters :
name
Description : The name of the operation resource to be deleted.
Pattern : ^projects/[^/]+/locations/[^/]+/solvers/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
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`.
▼ ▲ aiplatform.projects.locations.cachedContents.create
Path : v1beta1/{+parent}/cachedContents
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/cachedContents
HTTP Method : POST
Parameters :
parent
Description : Required. The parent resource where the cached content will be created
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Creates cached content, this call will initialize the cached content in the data storage, and users need to pay for the cache data storage.
▼ ▲ aiplatform.projects.locations.cachedContents.get
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/cachedContents/{cachedContentsId}
HTTP Method : GET
Parameters :
name
Description : Required. The resource name referring to the cached content
Pattern : ^projects/[^/]+/locations/[^/]+/cachedContents/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets cached content configurations
▼ ▲ aiplatform.projects.locations.cachedContents.patch
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/cachedContents/{cachedContentsId}
HTTP Method : PATCH
Parameters :
name
Description : Immutable. Identifier. The server-generated resource name of the cached content Format: projects/{project}/locations/{location}/cachedContents/{cached_content}
Pattern : ^projects/[^/]+/locations/[^/]+/cachedContents/[^/]+$
Location : path
Required : Yes
Type : string
updateMask
Description : Required. The list of fields to update.
Location : query
Type : string
Format : google-fieldmask
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Updates cached content configurations
▼ ▲ aiplatform.projects.locations.cachedContents.delete
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/cachedContents/{cachedContentsId}
HTTP Method : DELETE
Parameters :
name
Description : Required. The resource name referring to the cached content
Pattern : ^projects/[^/]+/locations/[^/]+/cachedContents/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Deletes cached content
▼ ▲ aiplatform.projects.locations.cachedContents.list
Path : v1beta1/{+parent}/cachedContents
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/cachedContents
HTTP Method : GET
Parameters :
parent
Description : Required. The parent, which owns this collection of cached contents.
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
pageSize
Description : Optional. The maximum number of cached contents to return. The service may return fewer than this value. If unspecified, some default (under maximum) number of items will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
Location : query
Type : integer
Format : int32
pageToken
Description : Optional. A page token, received from a previous `ListCachedContents` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListCachedContents` must match the call that provided the page token.
Location : query
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists cached contents in a project
▼ ▲ aiplatform.projects.locations.datasets.create
Path : v1beta1/{+parent}/datasets
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/datasets
HTTP Method : POST
Parameters :
parent
Description : Required. The resource name of the Location to create the Dataset in. Format: `projects/{project}/locations/{location}`
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Creates a Dataset.
▼ ▲ aiplatform.projects.locations.datasets.get
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}
HTTP Method : GET
Parameters :
name
Description : Required. The name of the Dataset resource.
Pattern : ^projects/[^/]+/locations/[^/]+/datasets/[^/]+$
Location : path
Required : Yes
Type : string
readMask
Description : Mask specifying which fields to read.
Location : query
Type : string
Format : google-fieldmask
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets a Dataset.
▼ ▲ aiplatform.projects.locations.datasets.patch
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}
HTTP Method : PATCH
Parameters :
name
Description : Output only. Identifier. The resource name of the Dataset. Format: `projects/{project}/locations/{location}/datasets/{dataset}`
Pattern : ^projects/[^/]+/locations/[^/]+/datasets/[^/]+$
Location : path
Required : Yes
Type : string
updateMask
Description : Required. The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask. Updatable fields: * `display_name` * `description` * `labels`
Location : query
Type : string
Format : google-fieldmask
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Updates a Dataset.
▼ ▲ aiplatform.projects.locations.datasets.list
Path : v1beta1/{+parent}/datasets
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/datasets
HTTP Method : GET
Parameters :
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
filter
Description : An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `display_name`: supports = and != * `metadata_schema_uri`: supports = and != * `labels` supports general map functions that is: * `labels.key=value` - key:value equality * `labels.key:* or labels:key - key existence * A key including a space must be quoted. `labels."a key"`. Some examples: * `displayName="myDisplayName"` * `labels.myKey="myValue"`
Location : query
Type : string
pageSize
Description : The standard list page size.
Location : query
Type : integer
Format : int32
pageToken
Description : The standard list page token.
Location : query
Type : string
readMask
Description : Mask specifying which fields to read.
Location : query
Type : string
Format : google-fieldmask
orderBy
Description : A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `display_name` * `create_time` * `update_time`
Location : query
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists Datasets in a Location.
▼ ▲ aiplatform.projects.locations.datasets.delete
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}
HTTP Method : DELETE
Parameters :
name
Description : Required. The resource name of the Dataset to delete. Format: `projects/{project}/locations/{location}/datasets/{dataset}`
Pattern : ^projects/[^/]+/locations/[^/]+/datasets/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Deletes a Dataset.
▼ ▲ aiplatform.projects.locations.datasets.import
Path : v1beta1/{+name}:import
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}:import
HTTP Method : POST
Parameters :
name
Description : Required. The name of the Dataset resource. Format: `projects/{project}/locations/{location}/datasets/{dataset}`
Pattern : ^projects/[^/]+/locations/[^/]+/datasets/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Imports data into a Dataset.
▼ ▲ aiplatform.projects.locations.datasets.export
Path : v1beta1/{+name}:export
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}:export
HTTP Method : POST
Parameters :
name
Description : Required. The name of the Dataset resource. Format: `projects/{project}/locations/{location}/datasets/{dataset}`
Pattern : ^projects/[^/]+/locations/[^/]+/datasets/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Exports data from a Dataset.
▼ ▲ aiplatform.projects.locations.datasets.searchDataItems
Path : v1beta1/{+dataset}:searchDataItems
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}:searchDataItems
HTTP Method : GET
Parameters :
dataset
Description : Required. The resource name of the Dataset from which to search DataItems. Format: `projects/{project}/locations/{location}/datasets/{dataset}`
Pattern : ^projects/[^/]+/locations/[^/]+/datasets/[^/]+$
Location : path
Required : Yes
Type : string
orderByDataItem
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
Type : string
orderByAnnotation.savedQuery
Description : Required. Saved query of the Annotation. Only Annotations belong to this saved query will be considered for ordering.
Location : query
Type : string
orderByAnnotation.orderBy
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
Type : string
savedQuery
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
Deprecated : Yes
Type : string
dataLabelingJob
Description : The resource name of a DataLabelingJob. Format: `projects/{project}/locations/{location}/dataLabelingJobs/{data_labeling_job}` If this field is set, all of the search will be done in the context of this DataLabelingJob.
Location : query
Type : string
dataItemFilter
Description : An expression for filtering the DataItem that will be returned. * `data_item_id` - for = or !=. * `labeled` - for = or !=. * `has_annotation(ANNOTATION_SPEC_ID)` - true only for DataItem that have at least one annotation with annotation_spec_id = `ANNOTATION_SPEC_ID` in the context of SavedQuery or DataLabelingJob. For example: * `data_item=1` * `has_annotation(5)`
Location : query
Type : string
annotationsFilter
Description : An expression for filtering the Annotations that will be returned per DataItem. * `annotation_spec_id` - for = or !=.
Location : query
Deprecated : Yes
Type : string
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.
Location : query
Repeated : Yes
Type : string
fieldMask
Description : Mask specifying which fields of DataItemView to read.
Location : query
Type : string
Format : google-fieldmask
annotationsLimit
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.
Location : query
Type : integer
Format : int32
pageSize
Description : Requested page size. Server may return fewer results than requested. Default and maximum page size is 100.
Location : query
Type : integer
Format : int32
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
Deprecated : Yes
Type : string
pageToken
Description : A token identifying a page of results for the server to return Typically obtained via SearchDataItemsResponse.next_page_token of the previous DatasetService.SearchDataItems call.
Location : query
Type : string
Parameter Order : dataset
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Searches DataItems in a Dataset.
▼ ▲ aiplatform.projects.locations.datasets.operations.list
Path : v1beta1/{+name}/operations
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/operations
HTTP Method : GET
Parameters :
name
Description : The name of the operation's parent resource.
Pattern : ^projects/[^/]+/locations/[^/]+/datasets/[^/]+$
Location : path
Required : Yes
Type : string
filter
Description : The standard list filter.
Location : query
Type : string
pageSize
Description : The standard list page size.
Location : query
Type : integer
Format : int32
pageToken
Description : The standard list page token.
Location : query
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
▼ ▲ aiplatform.projects.locations.datasets.operations.get
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/operations/{operationsId}
HTTP Method : GET
Parameters :
name
Description : The name of the operation resource.
Pattern : ^projects/[^/]+/locations/[^/]+/datasets/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
▼ ▲ aiplatform.projects.locations.datasets.operations.delete
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/operations/{operationsId}
HTTP Method : DELETE
Parameters :
name
Description : The name of the operation resource to be deleted.
Pattern : ^projects/[^/]+/locations/[^/]+/datasets/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
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`.
▼ ▲ aiplatform.projects.locations.datasets.operations.cancel
Path : v1beta1/{+name}:cancel
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/operations/{operationsId}:cancel
HTTP Method : POST
Parameters :
name
Description : The name of the operation resource to be cancelled.
Pattern : ^projects/[^/]+/locations/[^/]+/datasets/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
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`.
▼ ▲ aiplatform.projects.locations.datasets.operations.wait
Path : v1beta1/{+name}:wait
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/operations/{operationsId}:wait
HTTP Method : POST
Parameters :
name
Description : The name of the operation resource to wait on.
Pattern : ^projects/[^/]+/locations/[^/]+/datasets/[^/]+/operations/[^/]+$
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.
Location : query
Type : string
Format : google-duration
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.
▼ ▲ aiplatform.projects.locations.datasets.datasetVersions.create
Path : v1beta1/{+parent}/datasetVersions
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/datasetVersions
HTTP Method : POST
Parameters :
parent
Description : Required. The name of the Dataset resource. Format: `projects/{project}/locations/{location}/datasets/{dataset}`
Pattern : ^projects/[^/]+/locations/[^/]+/datasets/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Create a version from a Dataset.
▼ ▲ aiplatform.projects.locations.datasets.datasetVersions.patch
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/datasetVersions/{datasetVersionsId}
HTTP Method : PATCH
Parameters :
name
Description : Output only. Identifier. The resource name of the DatasetVersion. Format: `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}`
Pattern : ^projects/[^/]+/locations/[^/]+/datasets/[^/]+/datasetVersions/[^/]+$
Location : path
Required : Yes
Type : string
updateMask
Description : Required. The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask. Updatable fields: * `display_name`
Location : query
Type : string
Format : google-fieldmask
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Updates a DatasetVersion.
▼ ▲ aiplatform.projects.locations.datasets.datasetVersions.delete
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/datasetVersions/{datasetVersionsId}
HTTP Method : DELETE
Parameters :
name
Description : Required. The resource name of the Dataset version to delete. Format: `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}`
Pattern : ^projects/[^/]+/locations/[^/]+/datasets/[^/]+/datasetVersions/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Deletes a Dataset version.
▼ ▲ aiplatform.projects.locations.datasets.datasetVersions.get
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/datasetVersions/{datasetVersionsId}
HTTP Method : GET
Parameters :
name
Description : Required. The resource name of the Dataset version to delete. Format: `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}`
Pattern : ^projects/[^/]+/locations/[^/]+/datasets/[^/]+/datasetVersions/[^/]+$
Location : path
Required : Yes
Type : string
readMask
Description : Mask specifying which fields to read.
Location : query
Type : string
Format : google-fieldmask
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets a Dataset version.
▼ ▲ aiplatform.projects.locations.datasets.datasetVersions.list
Path : v1beta1/{+parent}/datasetVersions
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/datasetVersions
HTTP Method : GET
Parameters :
parent
Description : Required. The resource name of the Dataset to list DatasetVersions from. Format: `projects/{project}/locations/{location}/datasets/{dataset}`
Pattern : ^projects/[^/]+/locations/[^/]+/datasets/[^/]+$
Location : path
Required : Yes
Type : string
filter
Description : Optional. The standard list filter.
Location : query
Type : string
pageSize
Description : Optional. The standard list page size.
Location : query
Type : integer
Format : int32
pageToken
Description : Optional. The standard list page token.
Location : query
Type : string
readMask
Description : Optional. Mask specifying which fields to read.
Location : query
Type : string
Format : google-fieldmask
orderBy
Description : Optional. 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
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists DatasetVersions in a Dataset.
▼ ▲ aiplatform.projects.locations.datasets.datasetVersions.restore
Path : v1beta1/{+name}:restore
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/datasetVersions/{datasetVersionsId}:restore
HTTP Method : GET
Parameters :
name
Description : Required. The name of the DatasetVersion resource. Format: `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}`
Pattern : ^projects/[^/]+/locations/[^/]+/datasets/[^/]+/datasetVersions/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Restores a dataset version.
▼ ▲ aiplatform.projects.locations.datasets.dataItems.list
Path : v1beta1/{+parent}/dataItems
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems
HTTP Method : GET
Parameters :
parent
Description : Required. The resource name of the Dataset to list DataItems from. Format: `projects/{project}/locations/{location}/datasets/{dataset}`
Pattern : ^projects/[^/]+/locations/[^/]+/datasets/[^/]+$
Location : path
Required : Yes
Type : string
filter
Description : The standard list filter.
Location : query
Type : string
pageSize
Description : The standard list page size.
Location : query
Type : integer
Format : int32
pageToken
Description : The standard list page token.
Location : query
Type : string
readMask
Description : Mask specifying which fields to read.
Location : query
Type : string
Format : google-fieldmask
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
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists DataItems in a Dataset.
▼ ▲ aiplatform.projects.locations.datasets.dataItems.operations.list
Path : v1beta1/{+name}/operations
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/operations
HTTP Method : GET
Parameters :
name
Description : The name of the operation's parent resource.
Pattern : ^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dataItems/[^/]+$
Location : path
Required : Yes
Type : string
filter
Description : The standard list filter.
Location : query
Type : string
pageSize
Description : The standard list page size.
Location : query
Type : integer
Format : int32
pageToken
Description : The standard list page token.
Location : query
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
▼ ▲ aiplatform.projects.locations.datasets.dataItems.operations.get
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/operations/{operationsId}
HTTP Method : GET
Parameters :
name
Description : The name of the operation resource.
Pattern : ^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dataItems/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
▼ ▲ aiplatform.projects.locations.datasets.dataItems.operations.delete
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/operations/{operationsId}
HTTP Method : DELETE
Parameters :
name
Description : The name of the operation resource to be deleted.
Pattern : ^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dataItems/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
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`.
▼ ▲ aiplatform.projects.locations.datasets.dataItems.operations.cancel
Path : v1beta1/{+name}:cancel
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/operations/{operationsId}:cancel
HTTP Method : POST
Parameters :
name
Description : The name of the operation resource to be cancelled.
Pattern : ^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dataItems/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
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`.
▼ ▲ aiplatform.projects.locations.datasets.dataItems.operations.wait
Path : v1beta1/{+name}:wait
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/operations/{operationsId}:wait
HTTP Method : POST
Parameters :
name
Description : The name of the operation resource to wait on.
Pattern : ^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dataItems/[^/]+/operations/[^/]+$
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.
Location : query
Type : string
Format : google-duration
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.
▼ ▲ aiplatform.projects.locations.datasets.dataItems.annotations.list
Path : v1beta1/{+parent}/annotations
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/annotations
HTTP Method : GET
Parameters :
parent
Description : Required. The resource name of the DataItem to list Annotations from. Format: `projects/{project}/locations/{location}/datasets/{dataset}/dataItems/{data_item}`
Pattern : ^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dataItems/[^/]+$
Location : path
Required : Yes
Type : string
filter
Description : The standard list filter.
Location : query
Type : string
pageSize
Description : The standard list page size.
Location : query
Type : integer
Format : int32
pageToken
Description : The standard list page token.
Location : query
Type : string
readMask
Description : Mask specifying which fields to read.
Location : query
Type : string
Format : google-fieldmask
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
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists Annotations belongs to a dataitem This RPC is only available in InternalDatasetService. It is only used for exporting conversation data to CCAI Insights.
▼ ▲ aiplatform.projects.locations.datasets.dataItems.annotations.operations.list
Path : v1beta1/{+name}/operations
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/annotations/{annotationsId}/operations
HTTP Method : GET
Parameters :
name
Description : The name of the operation's parent resource.
Pattern : ^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dataItems/[^/]+/annotations/[^/]+$
Location : path
Required : Yes
Type : string
filter
Description : The standard list filter.
Location : query
Type : string
pageSize
Description : The standard list page size.
Location : query
Type : integer
Format : int32
pageToken
Description : The standard list page token.
Location : query
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
▼ ▲ aiplatform.projects.locations.datasets.dataItems.annotations.operations.get
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/annotations/{annotationsId}/operations/{operationsId}
HTTP Method : GET
Parameters :
name
Description : The name of the operation resource.
Pattern : ^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dataItems/[^/]+/annotations/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
▼ ▲ aiplatform.projects.locations.datasets.dataItems.annotations.operations.delete
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/annotations/{annotationsId}/operations/{operationsId}
HTTP Method : DELETE
Parameters :
name
Description : The name of the operation resource to be deleted.
Pattern : ^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dataItems/[^/]+/annotations/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
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`.
▼ ▲ aiplatform.projects.locations.datasets.dataItems.annotations.operations.cancel
Path : v1beta1/{+name}:cancel
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/annotations/{annotationsId}/operations/{operationsId}:cancel
HTTP Method : POST
Parameters :
name
Description : The name of the operation resource to be cancelled.
Pattern : ^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dataItems/[^/]+/annotations/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
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`.
▼ ▲ aiplatform.projects.locations.datasets.dataItems.annotations.operations.wait
Path : v1beta1/{+name}:wait
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/annotations/{annotationsId}/operations/{operationsId}:wait
HTTP Method : POST
Parameters :
name
Description : The name of the operation resource to wait on.
Pattern : ^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dataItems/[^/]+/annotations/[^/]+/operations/[^/]+$
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.
Location : query
Type : string
Format : google-duration
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.
▼ ▲ aiplatform.projects.locations.datasets.savedQueries.list
Path : v1beta1/{+parent}/savedQueries
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/savedQueries
HTTP Method : GET
Parameters :
parent
Description : Required. The resource name of the Dataset to list SavedQueries from. Format: `projects/{project}/locations/{location}/datasets/{dataset}`
Pattern : ^projects/[^/]+/locations/[^/]+/datasets/[^/]+$
Location : path
Required : Yes
Type : string
filter
Description : The standard list filter.
Location : query
Type : string
pageSize
Description : The standard list page size.
Location : query
Type : integer
Format : int32
pageToken
Description : The standard list page token.
Location : query
Type : string
readMask
Description : Mask specifying which fields to read.
Location : query
Type : string
Format : google-fieldmask
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
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists SavedQueries in a Dataset.
▼ ▲ aiplatform.projects.locations.datasets.savedQueries.delete
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/savedQueries/{savedQueriesId}
HTTP Method : DELETE
Parameters :
name
Description : Required. The resource name of the SavedQuery to delete. Format: `projects/{project}/locations/{location}/datasets/{dataset}/savedQueries/{saved_query}`
Pattern : ^projects/[^/]+/locations/[^/]+/datasets/[^/]+/savedQueries/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Deletes a SavedQuery.
▼ ▲ aiplatform.projects.locations.datasets.savedQueries.operations.list
Path : v1beta1/{+name}/operations
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/savedQueries/{savedQueriesId}/operations
HTTP Method : GET
Parameters :
name
Description : The name of the operation's parent resource.
Pattern : ^projects/[^/]+/locations/[^/]+/datasets/[^/]+/savedQueries/[^/]+$
Location : path
Required : Yes
Type : string
filter
Description : The standard list filter.
Location : query
Type : string
pageSize
Description : The standard list page size.
Location : query
Type : integer
Format : int32
pageToken
Description : The standard list page token.
Location : query
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
▼ ▲ aiplatform.projects.locations.datasets.savedQueries.operations.get
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/savedQueries/{savedQueriesId}/operations/{operationsId}
HTTP Method : GET
Parameters :
name
Description : The name of the operation resource.
Pattern : ^projects/[^/]+/locations/[^/]+/datasets/[^/]+/savedQueries/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
▼ ▲ aiplatform.projects.locations.datasets.savedQueries.operations.delete
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/savedQueries/{savedQueriesId}/operations/{operationsId}
HTTP Method : DELETE
Parameters :
name
Description : The name of the operation resource to be deleted.
Pattern : ^projects/[^/]+/locations/[^/]+/datasets/[^/]+/savedQueries/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
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`.
▼ ▲ aiplatform.projects.locations.datasets.savedQueries.operations.cancel
Path : v1beta1/{+name}:cancel
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/savedQueries/{savedQueriesId}/operations/{operationsId}:cancel
HTTP Method : POST
Parameters :
name
Description : The name of the operation resource to be cancelled.
Pattern : ^projects/[^/]+/locations/[^/]+/datasets/[^/]+/savedQueries/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
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`.
▼ ▲ aiplatform.projects.locations.datasets.savedQueries.operations.wait
Path : v1beta1/{+name}:wait
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/savedQueries/{savedQueriesId}/operations/{operationsId}:wait
HTTP Method : POST
Parameters :
name
Description : The name of the operation resource to wait on.
Pattern : ^projects/[^/]+/locations/[^/]+/datasets/[^/]+/savedQueries/[^/]+/operations/[^/]+$
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.
Location : query
Type : string
Format : google-duration
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.
▼ ▲ aiplatform.projects.locations.datasets.annotationSpecs.get
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/annotationSpecs/{annotationSpecsId}
HTTP Method : GET
Parameters :
name
Description : Required. The name of the AnnotationSpec resource. Format: `projects/{project}/locations/{location}/datasets/{dataset}/annotationSpecs/{annotation_spec}`
Pattern : ^projects/[^/]+/locations/[^/]+/datasets/[^/]+/annotationSpecs/[^/]+$
Location : path
Required : Yes
Type : string
readMask
Description : Mask specifying which fields to read.
Location : query
Type : string
Format : google-fieldmask
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets an AnnotationSpec.
▼ ▲ aiplatform.projects.locations.datasets.annotationSpecs.operations.list
Path : v1beta1/{+name}/operations
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/annotationSpecs/{annotationSpecsId}/operations
HTTP Method : GET
Parameters :
name
Description : The name of the operation's parent resource.
Pattern : ^projects/[^/]+/locations/[^/]+/datasets/[^/]+/annotationSpecs/[^/]+$
Location : path
Required : Yes
Type : string
filter
Description : The standard list filter.
Location : query
Type : string
pageSize
Description : The standard list page size.
Location : query
Type : integer
Format : int32
pageToken
Description : The standard list page token.
Location : query
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
▼ ▲ aiplatform.projects.locations.datasets.annotationSpecs.operations.get
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/annotationSpecs/{annotationSpecsId}/operations/{operationsId}
HTTP Method : GET
Parameters :
name
Description : The name of the operation resource.
Pattern : ^projects/[^/]+/locations/[^/]+/datasets/[^/]+/annotationSpecs/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
▼ ▲ aiplatform.projects.locations.datasets.annotationSpecs.operations.delete
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/annotationSpecs/{annotationSpecsId}/operations/{operationsId}
HTTP Method : DELETE
Parameters :
name
Description : The name of the operation resource to be deleted.
Pattern : ^projects/[^/]+/locations/[^/]+/datasets/[^/]+/annotationSpecs/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
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`.
▼ ▲ aiplatform.projects.locations.datasets.annotationSpecs.operations.cancel
Path : v1beta1/{+name}:cancel
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/annotationSpecs/{annotationSpecsId}/operations/{operationsId}:cancel
HTTP Method : POST
Parameters :
name
Description : The name of the operation resource to be cancelled.
Pattern : ^projects/[^/]+/locations/[^/]+/datasets/[^/]+/annotationSpecs/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
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`.
▼ ▲ aiplatform.projects.locations.datasets.annotationSpecs.operations.wait
Path : v1beta1/{+name}:wait
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/annotationSpecs/{annotationSpecsId}/operations/{operationsId}:wait
HTTP Method : POST
Parameters :
name
Description : The name of the operation resource to wait on.
Pattern : ^projects/[^/]+/locations/[^/]+/datasets/[^/]+/annotationSpecs/[^/]+/operations/[^/]+$
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.
Location : query
Type : string
Format : google-duration
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.
▼ ▲ aiplatform.projects.locations.deploymentResourcePools.create
Path : v1beta1/{+parent}/deploymentResourcePools
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools
HTTP Method : POST
Parameters :
parent
Description : Required. The parent location resource where this DeploymentResourcePool will be created. Format: `projects/{project}/locations/{location}`
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Create a DeploymentResourcePool.
▼ ▲ aiplatform.projects.locations.deploymentResourcePools.get
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}
HTTP Method : GET
Parameters :
name
Description : Required. The name of the DeploymentResourcePool to retrieve. Format: `projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}`
Pattern : ^projects/[^/]+/locations/[^/]+/deploymentResourcePools/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Get a DeploymentResourcePool.
▼ ▲ aiplatform.projects.locations.deploymentResourcePools.list
Path : v1beta1/{+parent}/deploymentResourcePools
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools
HTTP Method : GET
Parameters :
parent
Description : Required. The parent Location which owns this collection of DeploymentResourcePools. Format: `projects/{project}/locations/{location}`
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
pageSize
Description : The maximum number of DeploymentResourcePools to return. The service may return fewer than this value.
Location : query
Type : integer
Format : int32
pageToken
Description : A page token, received from a previous `ListDeploymentResourcePools` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListDeploymentResourcePools` must match the call that provided the page token.
Location : query
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : List DeploymentResourcePools in a location.
▼ ▲ aiplatform.projects.locations.deploymentResourcePools.patch
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}
HTTP Method : PATCH
Parameters :
name
Description : Immutable. The resource name of the DeploymentResourcePool. Format: `projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}`
Pattern : ^projects/[^/]+/locations/[^/]+/deploymentResourcePools/[^/]+$
Location : path
Required : Yes
Type : string
updateMask
Description : Required. The list of fields to update.
Location : query
Type : string
Format : google-fieldmask
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Update a DeploymentResourcePool.
▼ ▲ aiplatform.projects.locations.deploymentResourcePools.delete
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}
HTTP Method : DELETE
Parameters :
name
Description : Required. The name of the DeploymentResourcePool to delete. Format: `projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}`
Pattern : ^projects/[^/]+/locations/[^/]+/deploymentResourcePools/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Delete a DeploymentResourcePool.
▼ ▲ aiplatform.projects.locations.deploymentResourcePools.queryDeployedModels
Path : v1beta1/{+deploymentResourcePool}:queryDeployedModels
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}:queryDeployedModels
HTTP Method : GET
Parameters :
deploymentResourcePool
Description : Required. The name of the target DeploymentResourcePool to query. Format: `projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}`
Pattern : ^projects/[^/]+/locations/[^/]+/deploymentResourcePools/[^/]+$
Location : path
Required : Yes
Type : string
pageSize
Description : The maximum number of DeployedModels to return. The service may return fewer than this value.
Location : query
Type : integer
Format : int32
pageToken
Description : A page token, received from a previous `QueryDeployedModels` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `QueryDeployedModels` must match the call that provided the page token.
Location : query
Type : string
Parameter Order : deploymentResourcePool
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : List DeployedModels that have been deployed on this DeploymentResourcePool.
▼ ▲ aiplatform.projects.locations.deploymentResourcePools.operations.list
Path : v1beta1/{+name}/operations
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}/operations
HTTP Method : GET
Parameters :
name
Description : The name of the operation's parent resource.
Pattern : ^projects/[^/]+/locations/[^/]+/deploymentResourcePools/[^/]+$
Location : path
Required : Yes
Type : string
filter
Description : The standard list filter.
Location : query
Type : string
pageSize
Description : The standard list page size.
Location : query
Type : integer
Format : int32
pageToken
Description : The standard list page token.
Location : query
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
▼ ▲ aiplatform.projects.locations.deploymentResourcePools.operations.get
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}/operations/{operationsId}
HTTP Method : GET
Parameters :
name
Description : The name of the operation resource.
Pattern : ^projects/[^/]+/locations/[^/]+/deploymentResourcePools/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
▼ ▲ aiplatform.projects.locations.deploymentResourcePools.operations.delete
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}/operations/{operationsId}
HTTP Method : DELETE
Parameters :
name
Description : The name of the operation resource to be deleted.
Pattern : ^projects/[^/]+/locations/[^/]+/deploymentResourcePools/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
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`.
▼ ▲ aiplatform.projects.locations.deploymentResourcePools.operations.cancel
Path : v1beta1/{+name}:cancel
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}/operations/{operationsId}:cancel
HTTP Method : POST
Parameters :
name
Description : The name of the operation resource to be cancelled.
Pattern : ^projects/[^/]+/locations/[^/]+/deploymentResourcePools/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
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`.
▼ ▲ aiplatform.projects.locations.deploymentResourcePools.operations.wait
Path : v1beta1/{+name}:wait
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}/operations/{operationsId}:wait
HTTP Method : POST
Parameters :
name
Description : The name of the operation resource to wait on.
Pattern : ^projects/[^/]+/locations/[^/]+/deploymentResourcePools/[^/]+/operations/[^/]+$
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.
Location : query
Type : string
Format : google-duration
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.
▼ ▲ aiplatform.projects.locations.extensions.import
Path : v1beta1/{+parent}/extensions:import
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/extensions:import
HTTP Method : POST
Parameters :
parent
Description : Required. The resource name of the Location to import the Extension in. Format: `projects/{project}/locations/{location}`
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Imports an Extension.
▼ ▲ aiplatform.projects.locations.extensions.get
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/extensions/{extensionsId}
HTTP Method : GET
Parameters :
name
Description : Required. The name of the Extension resource. Format: `projects/{project}/locations/{location}/extensions/{extension}`
Pattern : ^projects/[^/]+/locations/[^/]+/extensions/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets an Extension.
▼ ▲ aiplatform.projects.locations.extensions.list
Path : v1beta1/{+parent}/extensions
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/extensions
HTTP Method : GET
Parameters :
parent
Description : Required. The resource name of the Location to list the Extensions from. Format: `projects/{project}/locations/{location}`
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
filter
Description : Optional. The standard list filter. Supported fields: * `display_name` * `create_time` * `update_time` More detail in [AIP-160](https://google.aip.dev/160).
Location : query
Type : string
pageSize
Description : Optional. The standard list page size.
Location : query
Type : integer
Format : int32
pageToken
Description : Optional. The standard list page token.
Location : query
Type : string
orderBy
Description : Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `display_name` * `create_time` * `update_time` Example: `display_name, create_time desc`.
Location : query
Type : string
Parameter Order : parent
Scopes :
Description : Lists Extensions in a location.
▼ ▲ aiplatform.projects.locations.extensions.patch
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/extensions/{extensionsId}
HTTP Method : PATCH
Parameters :
name
Description : Identifier. The resource name of the Extension.
Pattern : ^projects/[^/]+/locations/[^/]+/extensions/[^/]+$
Location : path
Required : Yes
Type : string
updateMask
Description : Required. Mask specifying which fields to update. Supported fields: * `display_name` * `description` * `runtime_config` * `tool_use_examples` * `manifest.description`
Location : query
Type : string
Format : google-fieldmask
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Updates an Extension.
▼ ▲ aiplatform.projects.locations.extensions.delete
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/extensions/{extensionsId}
HTTP Method : DELETE
Parameters :
name
Description : Required. The name of the Extension resource to be deleted. Format: `projects/{project}/locations/{location}/extensions/{extension}`
Pattern : ^projects/[^/]+/locations/[^/]+/extensions/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Deletes an Extension.
▼ ▲ aiplatform.projects.locations.extensions.execute
Path : v1beta1/{+name}:execute
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/extensions/{extensionsId}:execute
HTTP Method : POST
Parameters :
name
Description : Required. Name (identifier) of the extension; Format: `projects/{project}/locations/{location}/extensions/{extension}`
Pattern : ^projects/[^/]+/locations/[^/]+/extensions/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Executes the request against a given extension.
▼ ▲ aiplatform.projects.locations.extensions.query
Path : v1beta1/{+name}:query
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/extensions/{extensionsId}:query
HTTP Method : POST
Parameters :
name
Description : Required. Name (identifier) of the extension; Format: `projects/{project}/locations/{location}/extensions/{extension}`
Pattern : ^projects/[^/]+/locations/[^/]+/extensions/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Queries an extension with a default controller.
▼ ▲ aiplatform.projects.locations.extensions.operations.list
Path : v1beta1/{+name}/operations
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/extensions/{extensionsId}/operations
HTTP Method : GET
Parameters :
name
Description : The name of the operation's parent resource.
Pattern : ^projects/[^/]+/locations/[^/]+/extensions/[^/]+$
Location : path
Required : Yes
Type : string
filter
Description : The standard list filter.
Location : query
Type : string
pageSize
Description : The standard list page size.
Location : query
Type : integer
Format : int32
pageToken
Description : The standard list page token.
Location : query
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
▼ ▲ aiplatform.projects.locations.extensions.operations.get
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/extensions/{extensionsId}/operations/{operationsId}
HTTP Method : GET
Parameters :
name
Description : The name of the operation resource.
Pattern : ^projects/[^/]+/locations/[^/]+/extensions/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
▼ ▲ aiplatform.projects.locations.extensions.operations.delete
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/extensions/{extensionsId}/operations/{operationsId}
HTTP Method : DELETE
Parameters :
name
Description : The name of the operation resource to be deleted.
Pattern : ^projects/[^/]+/locations/[^/]+/extensions/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
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`.
▼ ▲ aiplatform.projects.locations.extensions.operations.cancel
Path : v1beta1/{+name}:cancel
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/extensions/{extensionsId}/operations/{operationsId}:cancel
HTTP Method : POST
Parameters :
name
Description : The name of the operation resource to be cancelled.
Pattern : ^projects/[^/]+/locations/[^/]+/extensions/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
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`.
▼ ▲ aiplatform.projects.locations.extensions.operations.wait
Path : v1beta1/{+name}:wait
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/extensions/{extensionsId}/operations/{operationsId}:wait
HTTP Method : POST
Parameters :
name
Description : The name of the operation resource to wait on.
Pattern : ^projects/[^/]+/locations/[^/]+/extensions/[^/]+/operations/[^/]+$
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.
Location : query
Type : string
Format : google-duration
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.
▼ ▲ aiplatform.projects.locations.tuningJobs.create
Path : v1beta1/{+parent}/tuningJobs
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/tuningJobs
HTTP Method : POST
Parameters :
parent
Description : Required. The resource name of the Location to create the TuningJob in. Format: `projects/{project}/locations/{location}`
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Creates a TuningJob. A created TuningJob right away will be attempted to be run.
▼ ▲ aiplatform.projects.locations.tuningJobs.get
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/tuningJobs/{tuningJobsId}
HTTP Method : GET
Parameters :
name
Description : Required. The name of the TuningJob resource. Format: `projects/{project}/locations/{location}/tuningJobs/{tuning_job}`
Pattern : ^projects/[^/]+/locations/[^/]+/tuningJobs/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets a TuningJob.
▼ ▲ aiplatform.projects.locations.tuningJobs.list
Path : v1beta1/{+parent}/tuningJobs
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/tuningJobs
HTTP Method : GET
Parameters :
parent
Description : Required. The resource name of the Location to list the TuningJobs from. Format: `projects/{project}/locations/{location}`
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
filter
Description : Optional. The standard list filter.
Location : query
Type : string
pageSize
Description : Optional. The standard list page size.
Location : query
Type : integer
Format : int32
pageToken
Description : Optional. The standard list page token. Typically obtained via ListTuningJobsResponse.next_page_token of the previous GenAiTuningService.ListTuningJob][] call.
Location : query
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists TuningJobs in a Location.
▼ ▲ aiplatform.projects.locations.tuningJobs.cancel
Path : v1beta1/{+name}:cancel
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/tuningJobs/{tuningJobsId}:cancel
HTTP Method : POST
Parameters :
name
Description : Required. The name of the TuningJob to cancel. Format: `projects/{project}/locations/{location}/tuningJobs/{tuning_job}`
Pattern : ^projects/[^/]+/locations/[^/]+/tuningJobs/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Cancels a TuningJob. Starts asynchronous cancellation on the TuningJob. The server makes a best effort to cancel the job, but success is not guaranteed. Clients can use GenAiTuningService.GetTuningJob or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On successful cancellation, the TuningJob is not deleted; instead it becomes a job with a TuningJob.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`, and TuningJob.state is set to `CANCELLED`.
▼ ▲ aiplatform.projects.locations.tuningJobs.rebaseTunedModel
Path : v1beta1/{+parent}/tuningJobs:rebaseTunedModel
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/tuningJobs:rebaseTunedModel
HTTP Method : POST
Parameters :
parent
Description : Required. The resource name of the Location into which to rebase the Model. Format: `projects/{project}/locations/{location}`
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Rebase a TunedModel.
▼ ▲ aiplatform.projects.locations.tuningJobs.operations.delete
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/tuningJobs/{tuningJobsId}/operations/{operationsId}
HTTP Method : DELETE
Parameters :
name
Description : The name of the operation resource to be deleted.
Pattern : ^projects/[^/]+/locations/[^/]+/tuningJobs/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
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`.
▼ ▲ aiplatform.projects.locations.indexes.create
Path : v1beta1/{+parent}/indexes
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/indexes
HTTP Method : POST
Parameters :
parent
Description : Required. The resource name of the Location to create the Index in. Format: `projects/{project}/locations/{location}`
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Creates an Index.
▼ ▲ aiplatform.projects.locations.indexes.get
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}
HTTP Method : GET
Parameters :
name
Description : Required. The name of the Index resource. Format: `projects/{project}/locations/{location}/indexes/{index}`
Pattern : ^projects/[^/]+/locations/[^/]+/indexes/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets an Index.
▼ ▲ aiplatform.projects.locations.indexes.list
Path : v1beta1/{+parent}/indexes
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/indexes
HTTP Method : GET
Parameters :
parent
Description : Required. The resource name of the Location from which to list the Indexes. Format: `projects/{project}/locations/{location}`
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
filter
Description : The standard list filter.
Location : query
Type : string
pageSize
Description : The standard list page size.
Location : query
Type : integer
Format : int32
pageToken
Description : The standard list page token. Typically obtained via ListIndexesResponse.next_page_token of the previous IndexService.ListIndexes call.
Location : query
Type : string
readMask
Description : Mask specifying which fields to read.
Location : query
Type : string
Format : google-fieldmask
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists Indexes in a Location.
▼ ▲ aiplatform.projects.locations.indexes.patch
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}
HTTP Method : PATCH
Parameters :
name
Description : Output only. The resource name of the Index.
Pattern : ^projects/[^/]+/locations/[^/]+/indexes/[^/]+$
Location : path
Required : Yes
Type : string
updateMask
Description : The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask.
Location : query
Type : string
Format : google-fieldmask
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Updates an Index.
▼ ▲ aiplatform.projects.locations.indexes.delete
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}
HTTP Method : DELETE
Parameters :
name
Description : Required. The name of the Index resource to be deleted. Format: `projects/{project}/locations/{location}/indexes/{index}`
Pattern : ^projects/[^/]+/locations/[^/]+/indexes/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Deletes an Index. An Index can only be deleted when all its DeployedIndexes had been undeployed.
▼ ▲ aiplatform.projects.locations.indexes.upsertDatapoints
Path : v1beta1/{+index}:upsertDatapoints
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}:upsertDatapoints
HTTP Method : POST
Parameters :
index
Description : Required. The name of the Index resource to be updated. Format: `projects/{project}/locations/{location}/indexes/{index}`
Pattern : ^projects/[^/]+/locations/[^/]+/indexes/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : index
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Add/update Datapoints into an Index.
▼ ▲ aiplatform.projects.locations.indexes.removeDatapoints
Path : v1beta1/{+index}:removeDatapoints
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}:removeDatapoints
HTTP Method : POST
Parameters :
index
Description : Required. The name of the Index resource to be updated. Format: `projects/{project}/locations/{location}/indexes/{index}`
Pattern : ^projects/[^/]+/locations/[^/]+/indexes/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : index
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Remove Datapoints from an Index.
▼ ▲ aiplatform.projects.locations.indexes.operations.list
Path : v1beta1/{+name}/operations
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}/operations
HTTP Method : GET
Parameters :
name
Description : The name of the operation's parent resource.
Pattern : ^projects/[^/]+/locations/[^/]+/indexes/[^/]+$
Location : path
Required : Yes
Type : string
filter
Description : The standard list filter.
Location : query
Type : string
pageSize
Description : The standard list page size.
Location : query
Type : integer
Format : int32
pageToken
Description : The standard list page token.
Location : query
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
▼ ▲ aiplatform.projects.locations.indexes.operations.get
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}/operations/{operationsId}
HTTP Method : GET
Parameters :
name
Description : The name of the operation resource.
Pattern : ^projects/[^/]+/locations/[^/]+/indexes/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
▼ ▲ aiplatform.projects.locations.indexes.operations.delete
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}/operations/{operationsId}
HTTP Method : DELETE
Parameters :
name
Description : The name of the operation resource to be deleted.
Pattern : ^projects/[^/]+/locations/[^/]+/indexes/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
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`.
▼ ▲ aiplatform.projects.locations.indexes.operations.cancel
Path : v1beta1/{+name}:cancel
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}/operations/{operationsId}:cancel
HTTP Method : POST
Parameters :
name
Description : The name of the operation resource to be cancelled.
Pattern : ^projects/[^/]+/locations/[^/]+/indexes/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
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`.
▼ ▲ aiplatform.projects.locations.indexes.operations.wait
Path : v1beta1/{+name}:wait
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}/operations/{operationsId}:wait
HTTP Method : POST
Parameters :
name
Description : The name of the operation resource to wait on.
Pattern : ^projects/[^/]+/locations/[^/]+/indexes/[^/]+/operations/[^/]+$
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.
Location : query
Type : string
Format : google-duration
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.
▼ ▲ aiplatform.projects.locations.indexEndpoints.create
Path : v1beta1/{+parent}/indexEndpoints
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/indexEndpoints
HTTP Method : POST
Parameters :
parent
Description : Required. The resource name of the Location to create the IndexEndpoint in. Format: `projects/{project}/locations/{location}`
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Creates an IndexEndpoint.
▼ ▲ aiplatform.projects.locations.indexEndpoints.get
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}
HTTP Method : GET
Parameters :
name
Description : Required. The name of the IndexEndpoint resource. Format: `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}`
Pattern : ^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets an IndexEndpoint.
▼ ▲ aiplatform.projects.locations.indexEndpoints.list
Path : v1beta1/{+parent}/indexEndpoints
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/indexEndpoints
HTTP Method : GET
Parameters :
parent
Description : Required. The resource name of the Location from which to list the IndexEndpoints. Format: `projects/{project}/locations/{location}`
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
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"`
Location : query
Type : string
pageSize
Description : Optional. The standard list page size.
Location : query
Type : integer
Format : int32
pageToken
Description : Optional. The standard list page token. Typically obtained via ListIndexEndpointsResponse.next_page_token of the previous IndexEndpointService.ListIndexEndpoints call.
Location : query
Type : string
readMask
Description : Optional. Mask specifying which fields to read.
Location : query
Type : string
Format : google-fieldmask
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists IndexEndpoints in a Location.
▼ ▲ aiplatform.projects.locations.indexEndpoints.patch
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}
HTTP Method : PATCH
Parameters :
name
Description : Output only. The resource name of the IndexEndpoint.
Pattern : ^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+$
Location : path
Required : Yes
Type : string
updateMask
Description : Required. The update mask applies to the resource. See google.protobuf.FieldMask.
Location : query
Type : string
Format : google-fieldmask
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Updates an IndexEndpoint.
▼ ▲ aiplatform.projects.locations.indexEndpoints.delete
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}
HTTP Method : DELETE
Parameters :
name
Description : Required. The name of the IndexEndpoint resource to be deleted. Format: `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}`
Pattern : ^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Deletes an IndexEndpoint.
▼ ▲ aiplatform.projects.locations.indexEndpoints.deployIndex
Path : v1beta1/{+indexEndpoint}:deployIndex
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}:deployIndex
HTTP Method : POST
Parameters :
indexEndpoint
Description : Required. The name of the IndexEndpoint resource into which to deploy an Index. Format: `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}`
Pattern : ^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : indexEndpoint
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Deploys an Index into this IndexEndpoint, creating a DeployedIndex within it. Only non-empty Indexes can be deployed.
▼ ▲ aiplatform.projects.locations.indexEndpoints.undeployIndex
Path : v1beta1/{+indexEndpoint}:undeployIndex
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}:undeployIndex
HTTP Method : POST
Parameters :
indexEndpoint
Description : Required. The name of the IndexEndpoint resource from which to undeploy an Index. Format: `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}`
Pattern : ^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : indexEndpoint
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Undeploys an Index from an IndexEndpoint, removing a DeployedIndex from it, and freeing all resources it's using.
▼ ▲ aiplatform.projects.locations.indexEndpoints.mutateDeployedIndex
Path : v1beta1/{+indexEndpoint}:mutateDeployedIndex
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}:mutateDeployedIndex
HTTP Method : POST
Parameters :
indexEndpoint
Description : Required. The name of the IndexEndpoint resource into which to deploy an Index. Format: `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}`
Pattern : ^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : indexEndpoint
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Update an existing DeployedIndex under an IndexEndpoint.
▼ ▲ aiplatform.projects.locations.indexEndpoints.findNeighbors
Path : v1beta1/{+indexEndpoint}:findNeighbors
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}:findNeighbors
HTTP Method : POST
Parameters :
indexEndpoint
Description : Required. The name of the index endpoint. Format: `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}`
Pattern : ^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : indexEndpoint
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Finds the nearest neighbors of each vector within the request.
▼ ▲ aiplatform.projects.locations.indexEndpoints.readIndexDatapoints
Path : v1beta1/{+indexEndpoint}:readIndexDatapoints
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}:readIndexDatapoints
HTTP Method : POST
Parameters :
indexEndpoint
Description : Required. The name of the index endpoint. Format: `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}`
Pattern : ^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : indexEndpoint
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Reads the datapoints/vectors of the given IDs. A maximum of 1000 datapoints can be retrieved in a batch.
▼ ▲ aiplatform.projects.locations.indexEndpoints.operations.list
Path : v1beta1/{+name}/operations
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}/operations
HTTP Method : GET
Parameters :
name
Description : The name of the operation's parent resource.
Pattern : ^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+$
Location : path
Required : Yes
Type : string
filter
Description : The standard list filter.
Location : query
Type : string
pageSize
Description : The standard list page size.
Location : query
Type : integer
Format : int32
pageToken
Description : The standard list page token.
Location : query
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
▼ ▲ aiplatform.projects.locations.indexEndpoints.operations.get
Path : v1beta1/{+name}
Flat Path : v1beta1/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/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
▼ ▲ aiplatform.projects.locations.indexEndpoints.operations.delete
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}/operations/{operationsId}
HTTP Method : DELETE
Parameters :
name
Description : The name of the operation resource to be deleted.
Pattern : ^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
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`.
▼ ▲ aiplatform.projects.locations.indexEndpoints.operations.cancel
Path : v1beta1/{+name}:cancel
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}/operations/{operationsId}:cancel
HTTP Method : POST
Parameters :
name
Description : The name of the operation resource to be cancelled.
Pattern : ^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
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`.
▼ ▲ aiplatform.projects.locations.indexEndpoints.operations.wait
Path : v1beta1/{+name}:wait
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}/operations/{operationsId}:wait
HTTP Method : POST
Parameters :
name
Description : The name of the operation resource to wait on.
Pattern : ^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+/operations/[^/]+$
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.
Location : query
Type : string
Format : google-duration
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.
▼ ▲ aiplatform.projects.locations.customJobs.create
Path : v1beta1/{+parent}/customJobs
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/customJobs
HTTP Method : POST
Parameters :
parent
Description : Required. The resource name of the Location to create the CustomJob in. Format: `projects/{project}/locations/{location}`
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Creates a CustomJob. A created CustomJob right away will be attempted to be run.
▼ ▲ aiplatform.projects.locations.customJobs.get
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/customJobs/{customJobsId}
HTTP Method : GET
Parameters :
name
Description : Required. The name of the CustomJob resource. Format: `projects/{project}/locations/{location}/customJobs/{custom_job}`
Pattern : ^projects/[^/]+/locations/[^/]+/customJobs/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets a CustomJob.
▼ ▲ aiplatform.projects.locations.customJobs.list
Path : v1beta1/{+parent}/customJobs
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/customJobs
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
Required : Yes
Type : string
filter
Description : The standard list filter. Supported fields: * `display_name` supports `=`, `!=` comparisons, and `:` wildcard. * `state` supports `=`, `!=` comparisons. * `create_time` supports `=`, `!=`,`<`, `<=`,`>`, `>=` comparisons. `create_time` must be in RFC 3339 format. * `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* - key existence Some examples of using the filter are: * `state="JOB_STATE_SUCCEEDED" AND display_name:"my_job_*"` * `state!="JOB_STATE_FAILED" OR display_name="my_job"` * `NOT display_name="my_job"` * `create_time>"2021-05-18T00:00:00Z"` * `labels.keyA=valueA` * `labels.keyB:*`
Location : query
Type : string
pageSize
Description : The standard list page size.
Location : query
Type : integer
Format : int32
pageToken
Description : The standard list page token. Typically obtained via ListCustomJobsResponse.next_page_token of the previous JobService.ListCustomJobs call.
Location : query
Type : string
readMask
Description : Mask specifying which fields to read.
Location : query
Type : string
Format : google-fieldmask
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists CustomJobs in a Location.
▼ ▲ aiplatform.projects.locations.customJobs.delete
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/customJobs/{customJobsId}
HTTP Method : DELETE
Parameters :
name
Description : Required. The name of the CustomJob resource to be deleted. Format: `projects/{project}/locations/{location}/customJobs/{custom_job}`
Pattern : ^projects/[^/]+/locations/[^/]+/customJobs/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Deletes a CustomJob.
▼ ▲ aiplatform.projects.locations.customJobs.cancel
Path : v1beta1/{+name}:cancel
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/customJobs/{customJobsId}:cancel
HTTP Method : POST
Parameters :
name
Description : Required. The name of the CustomJob to cancel. Format: `projects/{project}/locations/{location}/customJobs/{custom_job}`
Pattern : ^projects/[^/]+/locations/[^/]+/customJobs/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
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`.
▼ ▲ aiplatform.projects.locations.customJobs.operations.list
Path : v1beta1/{+name}/operations
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/customJobs/{customJobsId}/operations
HTTP Method : GET
Parameters :
name
Description : The name of the operation's parent resource.
Pattern : ^projects/[^/]+/locations/[^/]+/customJobs/[^/]+$
Location : path
Required : Yes
Type : string
filter
Description : The standard list filter.
Location : query
Type : string
pageSize
Description : The standard list page size.
Location : query
Type : integer
Format : int32
pageToken
Description : The standard list page token.
Location : query
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
▼ ▲ aiplatform.projects.locations.customJobs.operations.get
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/customJobs/{customJobsId}/operations/{operationsId}
HTTP Method : GET
Parameters :
name
Description : The name of the operation resource.
Pattern : ^projects/[^/]+/locations/[^/]+/customJobs/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
▼ ▲ aiplatform.projects.locations.customJobs.operations.delete
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/customJobs/{customJobsId}/operations/{operationsId}
HTTP Method : DELETE
Parameters :
name
Description : The name of the operation resource to be deleted.
Pattern : ^projects/[^/]+/locations/[^/]+/customJobs/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
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`.
▼ ▲ aiplatform.projects.locations.customJobs.operations.cancel
Path : v1beta1/{+name}:cancel
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/customJobs/{customJobsId}/operations/{operationsId}:cancel
HTTP Method : POST
Parameters :
name
Description : The name of the operation resource to be cancelled.
Pattern : ^projects/[^/]+/locations/[^/]+/customJobs/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
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`.
▼ ▲ aiplatform.projects.locations.customJobs.operations.wait
Path : v1beta1/{+name}:wait
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/customJobs/{customJobsId}/operations/{operationsId}:wait
HTTP Method : POST
Parameters :
name
Description : The name of the operation resource to wait on.
Pattern : ^projects/[^/]+/locations/[^/]+/customJobs/[^/]+/operations/[^/]+$
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.
Location : query
Type : string
Format : google-duration
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.
▼ ▲ aiplatform.projects.locations.dataLabelingJobs.create
Path : v1beta1/{+parent}/dataLabelingJobs
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs
HTTP Method : POST
Parameters :
parent
Description : Required. The parent of the DataLabelingJob. Format: `projects/{project}/locations/{location}`
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Creates a DataLabelingJob.
▼ ▲ aiplatform.projects.locations.dataLabelingJobs.get
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs/{dataLabelingJobsId}
HTTP Method : GET
Parameters :
name
Description : Required. The name of the DataLabelingJob. Format: `projects/{project}/locations/{location}/dataLabelingJobs/{data_labeling_job}`
Pattern : ^projects/[^/]+/locations/[^/]+/dataLabelingJobs/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets a DataLabelingJob.
▼ ▲ aiplatform.projects.locations.dataLabelingJobs.list
Path : v1beta1/{+parent}/dataLabelingJobs
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs
HTTP Method : GET
Parameters :
parent
Description : Required. The parent of the DataLabelingJob. Format: `projects/{project}/locations/{location}`
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
filter
Description : The standard list filter. Supported fields: * `display_name` supports `=`, `!=` comparisons, and `:` wildcard. * `state` supports `=`, `!=` comparisons. * `create_time` supports `=`, `!=`,`<`, `<=`,`>`, `>=` comparisons. `create_time` must be in RFC 3339 format. * `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* - key existence Some examples of using the filter are: * `state="JOB_STATE_SUCCEEDED" AND display_name:"my_job_*"` * `state!="JOB_STATE_FAILED" OR display_name="my_job"` * `NOT display_name="my_job"` * `create_time>"2021-05-18T00:00:00Z"` * `labels.keyA=valueA` * `labels.keyB:*`
Location : query
Type : string
pageSize
Description : The standard list page size.
Location : query
Type : integer
Format : int32
pageToken
Description : The standard list page token.
Location : query
Type : string
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.
Location : query
Type : string
Format : google-fieldmask
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
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists DataLabelingJobs in a Location.
▼ ▲ aiplatform.projects.locations.dataLabelingJobs.delete
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs/{dataLabelingJobsId}
HTTP Method : DELETE
Parameters :
name
Description : Required. The name of the DataLabelingJob to be deleted. Format: `projects/{project}/locations/{location}/dataLabelingJobs/{data_labeling_job}`
Pattern : ^projects/[^/]+/locations/[^/]+/dataLabelingJobs/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Deletes a DataLabelingJob.
▼ ▲ aiplatform.projects.locations.dataLabelingJobs.cancel
Path : v1beta1/{+name}:cancel
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs/{dataLabelingJobsId}:cancel
HTTP Method : POST
Parameters :
name
Description : Required. The name of the DataLabelingJob. Format: `projects/{project}/locations/{location}/dataLabelingJobs/{data_labeling_job}`
Pattern : ^projects/[^/]+/locations/[^/]+/dataLabelingJobs/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Cancels a DataLabelingJob. Success of cancellation is not guaranteed.
▼ ▲ aiplatform.projects.locations.dataLabelingJobs.operations.list
Path : v1beta1/{+name}/operations
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs/{dataLabelingJobsId}/operations
HTTP Method : GET
Parameters :
name
Description : The name of the operation's parent resource.
Pattern : ^projects/[^/]+/locations/[^/]+/dataLabelingJobs/[^/]+$
Location : path
Required : Yes
Type : string
filter
Description : The standard list filter.
Location : query
Type : string
pageSize
Description : The standard list page size.
Location : query
Type : integer
Format : int32
pageToken
Description : The standard list page token.
Location : query
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
▼ ▲ aiplatform.projects.locations.dataLabelingJobs.operations.get
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs/{dataLabelingJobsId}/operations/{operationsId}
HTTP Method : GET
Parameters :
name
Description : The name of the operation resource.
Pattern : ^projects/[^/]+/locations/[^/]+/dataLabelingJobs/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
▼ ▲ aiplatform.projects.locations.dataLabelingJobs.operations.delete
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs/{dataLabelingJobsId}/operations/{operationsId}
HTTP Method : DELETE
Parameters :
name
Description : The name of the operation resource to be deleted.
Pattern : ^projects/[^/]+/locations/[^/]+/dataLabelingJobs/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
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`.
▼ ▲ aiplatform.projects.locations.dataLabelingJobs.operations.cancel
Path : v1beta1/{+name}:cancel
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs/{dataLabelingJobsId}/operations/{operationsId}:cancel
HTTP Method : POST
Parameters :
name
Description : The name of the operation resource to be cancelled.
Pattern : ^projects/[^/]+/locations/[^/]+/dataLabelingJobs/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
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`.
▼ ▲ aiplatform.projects.locations.dataLabelingJobs.operations.wait
Path : v1beta1/{+name}:wait
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs/{dataLabelingJobsId}/operations/{operationsId}:wait
HTTP Method : POST
Parameters :
name
Description : The name of the operation resource to wait on.
Pattern : ^projects/[^/]+/locations/[^/]+/dataLabelingJobs/[^/]+/operations/[^/]+$
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.
Location : query
Type : string
Format : google-duration
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.
▼ ▲ aiplatform.projects.locations.hyperparameterTuningJobs.create
Path : v1beta1/{+parent}/hyperparameterTuningJobs
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs
HTTP Method : POST
Parameters :
parent
Description : Required. The resource name of the Location to create the HyperparameterTuningJob in. Format: `projects/{project}/locations/{location}`
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Creates a HyperparameterTuningJob
▼ ▲ aiplatform.projects.locations.hyperparameterTuningJobs.get
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs/{hyperparameterTuningJobsId}
HTTP Method : GET
Parameters :
name
Description : Required. The name of the HyperparameterTuningJob resource. Format: `projects/{project}/locations/{location}/hyperparameterTuningJobs/{hyperparameter_tuning_job}`
Pattern : ^projects/[^/]+/locations/[^/]+/hyperparameterTuningJobs/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets a HyperparameterTuningJob
▼ ▲ aiplatform.projects.locations.hyperparameterTuningJobs.list
Path : v1beta1/{+parent}/hyperparameterTuningJobs
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs
HTTP Method : GET
Parameters :
parent
Description : Required. The resource name of the Location to list the HyperparameterTuningJobs from. Format: `projects/{project}/locations/{location}`
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
filter
Description : The standard list filter. Supported fields: * `display_name` supports `=`, `!=` comparisons, and `:` wildcard. * `state` supports `=`, `!=` comparisons. * `create_time` supports `=`, `!=`,`<`, `<=`,`>`, `>=` comparisons. `create_time` must be in RFC 3339 format. * `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* - key existence Some examples of using the filter are: * `state="JOB_STATE_SUCCEEDED" AND display_name:"my_job_*"` * `state!="JOB_STATE_FAILED" OR display_name="my_job"` * `NOT display_name="my_job"` * `create_time>"2021-05-18T00:00:00Z"` * `labels.keyA=valueA` * `labels.keyB:*`
Location : query
Type : string
pageSize
Description : The standard list page size.
Location : query
Type : integer
Format : int32
pageToken
Description : The standard list page token. Typically obtained via ListHyperparameterTuningJobsResponse.next_page_token of the previous JobService.ListHyperparameterTuningJobs call.
Location : query
Type : string
readMask
Description : Mask specifying which fields to read.
Location : query
Type : string
Format : google-fieldmask
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists HyperparameterTuningJobs in a Location.
▼ ▲ aiplatform.projects.locations.hyperparameterTuningJobs.delete
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs/{hyperparameterTuningJobsId}
HTTP Method : DELETE
Parameters :
name
Description : Required. The name of the HyperparameterTuningJob resource to be deleted. Format: `projects/{project}/locations/{location}/hyperparameterTuningJobs/{hyperparameter_tuning_job}`
Pattern : ^projects/[^/]+/locations/[^/]+/hyperparameterTuningJobs/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Deletes a HyperparameterTuningJob.
▼ ▲ aiplatform.projects.locations.hyperparameterTuningJobs.cancel
Path : v1beta1/{+name}:cancel
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs/{hyperparameterTuningJobsId}:cancel
HTTP Method : POST
Parameters :
name
Description : Required. The name of the HyperparameterTuningJob to cancel. Format: `projects/{project}/locations/{location}/hyperparameterTuningJobs/{hyperparameter_tuning_job}`
Pattern : ^projects/[^/]+/locations/[^/]+/hyperparameterTuningJobs/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Cancels a HyperparameterTuningJob. Starts asynchronous cancellation on the HyperparameterTuningJob. The server makes a best effort to cancel the job, but success is not guaranteed. Clients can use JobService.GetHyperparameterTuningJob or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On successful cancellation, the HyperparameterTuningJob is not deleted; instead it becomes a job with a HyperparameterTuningJob.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`, and HyperparameterTuningJob.state is set to `CANCELLED`.
▼ ▲ aiplatform.projects.locations.hyperparameterTuningJobs.operations.list
Path : v1beta1/{+name}/operations
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs/{hyperparameterTuningJobsId}/operations
HTTP Method : GET
Parameters :
name
Description : The name of the operation's parent resource.
Pattern : ^projects/[^/]+/locations/[^/]+/hyperparameterTuningJobs/[^/]+$
Location : path
Required : Yes
Type : string
filter
Description : The standard list filter.
Location : query
Type : string
pageSize
Description : The standard list page size.
Location : query
Type : integer
Format : int32
pageToken
Description : The standard list page token.
Location : query
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
▼ ▲ aiplatform.projects.locations.hyperparameterTuningJobs.operations.get
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs/{hyperparameterTuningJobsId}/operations/{operationsId}
HTTP Method : GET
Parameters :
name
Description : The name of the operation resource.
Pattern : ^projects/[^/]+/locations/[^/]+/hyperparameterTuningJobs/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
▼ ▲ aiplatform.projects.locations.hyperparameterTuningJobs.operations.delete
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs/{hyperparameterTuningJobsId}/operations/{operationsId}
HTTP Method : DELETE
Parameters :
name
Description : The name of the operation resource to be deleted.
Pattern : ^projects/[^/]+/locations/[^/]+/hyperparameterTuningJobs/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
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`.
▼ ▲ aiplatform.projects.locations.hyperparameterTuningJobs.operations.cancel
Path : v1beta1/{+name}:cancel
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs/{hyperparameterTuningJobsId}/operations/{operationsId}:cancel
HTTP Method : POST
Parameters :
name
Description : The name of the operation resource to be cancelled.
Pattern : ^projects/[^/]+/locations/[^/]+/hyperparameterTuningJobs/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
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`.
▼ ▲ aiplatform.projects.locations.hyperparameterTuningJobs.operations.wait
Path : v1beta1/{+name}:wait
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs/{hyperparameterTuningJobsId}/operations/{operationsId}:wait
HTTP Method : POST
Parameters :
name
Description : The name of the operation resource to wait on.
Pattern : ^projects/[^/]+/locations/[^/]+/hyperparameterTuningJobs/[^/]+/operations/[^/]+$
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.
Location : query
Type : string
Format : google-duration
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.
▼ ▲ aiplatform.projects.locations.nasJobs.create
Path : v1beta1/{+parent}/nasJobs
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/nasJobs
HTTP Method : POST
Parameters :
parent
Description : Required. The resource name of the Location to create the NasJob in. Format: `projects/{project}/locations/{location}`
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Creates a NasJob
▼ ▲ aiplatform.projects.locations.nasJobs.get
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/nasJobs/{nasJobsId}
HTTP Method : GET
Parameters :
name
Description : Required. The name of the NasJob resource. Format: `projects/{project}/locations/{location}/nasJobs/{nas_job}`
Pattern : ^projects/[^/]+/locations/[^/]+/nasJobs/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes :
Description : Gets a NasJob
▼ ▲ aiplatform.projects.locations.nasJobs.list
Path : v1beta1/{+parent}/nasJobs
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/nasJobs
HTTP Method : GET
Parameters :
parent
Description : Required. The resource name of the Location to list the NasJobs from. Format: `projects/{project}/locations/{location}`
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
filter
Description : The standard list filter. Supported fields: * `display_name` supports `=`, `!=` comparisons, and `:` wildcard. * `state` supports `=`, `!=` comparisons. * `create_time` supports `=`, `!=`,`<`, `<=`,`>`, `>=` comparisons. `create_time` must be in RFC 3339 format. * `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* - key existence Some examples of using the filter are: * `state="JOB_STATE_SUCCEEDED" AND display_name:"my_job_*"` * `state!="JOB_STATE_FAILED" OR display_name="my_job"` * `NOT display_name="my_job"` * `create_time>"2021-05-18T00:00:00Z"` * `labels.keyA=valueA` * `labels.keyB:*`
Location : query
Type : string
pageSize
Description : The standard list page size.
Location : query
Type : integer
Format : int32
pageToken
Description : The standard list page token. Typically obtained via ListNasJobsResponse.next_page_token of the previous JobService.ListNasJobs call.
Location : query
Type : string
readMask
Description : Mask specifying which fields to read.
Location : query
Type : string
Format : google-fieldmask
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists NasJobs in a Location.
▼ ▲ aiplatform.projects.locations.nasJobs.delete
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/nasJobs/{nasJobsId}
HTTP Method : DELETE
Parameters :
name
Description : Required. The name of the NasJob resource to be deleted. Format: `projects/{project}/locations/{location}/nasJobs/{nas_job}`
Pattern : ^projects/[^/]+/locations/[^/]+/nasJobs/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Deletes a NasJob.
▼ ▲ aiplatform.projects.locations.nasJobs.cancel
Path : v1beta1/{+name}:cancel
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/nasJobs/{nasJobsId}:cancel
HTTP Method : POST
Parameters :
name
Description : Required. The name of the NasJob to cancel. Format: `projects/{project}/locations/{location}/nasJobs/{nas_job}`
Pattern : ^projects/[^/]+/locations/[^/]+/nasJobs/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Cancels a NasJob. Starts asynchronous cancellation on the NasJob. The server makes a best effort to cancel the job, but success is not guaranteed. Clients can use JobService.GetNasJob or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On successful cancellation, the NasJob is not deleted; instead it becomes a job with a NasJob.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`, and NasJob.state is set to `CANCELLED`.
▼ ▲ aiplatform.projects.locations.nasJobs.nasTrialDetails.get
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/nasJobs/{nasJobsId}/nasTrialDetails/{nasTrialDetailsId}
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}`
Pattern : ^projects/[^/]+/locations/[^/]+/nasJobs/[^/]+/nasTrialDetails/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets a NasTrialDetail.
▼ ▲ aiplatform.projects.locations.nasJobs.nasTrialDetails.list
Path : v1beta1/{+parent}/nasTrialDetails
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/nasJobs/{nasJobsId}/nasTrialDetails
HTTP Method : GET
Parameters :
parent
Description : Required. The name of the NasJob resource. Format: `projects/{project}/locations/{location}/nasJobs/{nas_job}`
Pattern : ^projects/[^/]+/locations/[^/]+/nasJobs/[^/]+$
Location : path
Required : Yes
Type : string
pageSize
Description : The standard list page size.
Location : query
Type : integer
Format : int32
pageToken
Description : The standard list page token. Typically obtained via ListNasTrialDetailsResponse.next_page_token of the previous JobService.ListNasTrialDetails call.
Location : query
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : List top NasTrialDetails of a NasJob.
▼ ▲ aiplatform.projects.locations.batchPredictionJobs.create
Path : v1beta1/{+parent}/batchPredictionJobs
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/batchPredictionJobs
HTTP Method : POST
Parameters :
parent
Description : Required. The resource name of the Location to create the BatchPredictionJob in. Format: `projects/{project}/locations/{location}`
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Creates a BatchPredictionJob. A BatchPredictionJob once created will right away be attempted to start.
▼ ▲ aiplatform.projects.locations.batchPredictionJobs.get
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/batchPredictionJobs/{batchPredictionJobsId}
HTTP Method : GET
Parameters :
name
Description : Required. The name of the BatchPredictionJob resource. Format: `projects/{project}/locations/{location}/batchPredictionJobs/{batch_prediction_job}`
Pattern : ^projects/[^/]+/locations/[^/]+/batchPredictionJobs/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets a BatchPredictionJob
▼ ▲ aiplatform.projects.locations.batchPredictionJobs.list
Path : v1beta1/{+parent}/batchPredictionJobs
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/batchPredictionJobs
HTTP Method : GET
Parameters :
parent
Description : Required. The resource name of the Location to list the BatchPredictionJobs from. Format: `projects/{project}/locations/{location}`
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
filter
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:*`
Location : query
Type : string
pageSize
Description : The standard list page size.
Location : query
Type : integer
Format : int32
pageToken
Description : The standard list page token. Typically obtained via ListBatchPredictionJobsResponse.next_page_token of the previous JobService.ListBatchPredictionJobs call.
Location : query
Type : string
readMask
Description : Mask specifying which fields to read.
Location : query
Type : string
Format : google-fieldmask
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists BatchPredictionJobs in a Location.
▼ ▲ aiplatform.projects.locations.batchPredictionJobs.delete
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/batchPredictionJobs/{batchPredictionJobsId}
HTTP Method : DELETE
Parameters :
name
Description : Required. The name of the BatchPredictionJob resource to be deleted. Format: `projects/{project}/locations/{location}/batchPredictionJobs/{batch_prediction_job}`
Pattern : ^projects/[^/]+/locations/[^/]+/batchPredictionJobs/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Deletes a BatchPredictionJob. Can only be called on jobs that already finished.
▼ ▲ aiplatform.projects.locations.batchPredictionJobs.cancel
Path : v1beta1/{+name}:cancel
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/batchPredictionJobs/{batchPredictionJobsId}:cancel
HTTP Method : POST
Parameters :
name
Description : Required. The name of the BatchPredictionJob to cancel. Format: `projects/{project}/locations/{location}/batchPredictionJobs/{batch_prediction_job}`
Pattern : ^projects/[^/]+/locations/[^/]+/batchPredictionJobs/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Cancels a BatchPredictionJob. Starts asynchronous cancellation on the BatchPredictionJob. The server makes the best effort to cancel the job, but success is not guaranteed. Clients can use JobService.GetBatchPredictionJob or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On a successful cancellation, the BatchPredictionJob is not deleted;instead its BatchPredictionJob.state is set to `CANCELLED`. Any files already outputted by the job are not deleted.
▼ ▲ aiplatform.projects.locations.modelDeploymentMonitoringJobs.create
Path : v1beta1/{+parent}/modelDeploymentMonitoringJobs
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs
HTTP Method : POST
Parameters :
parent
Description : Required. The parent of the ModelDeploymentMonitoringJob. Format: `projects/{project}/locations/{location}`
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Creates a ModelDeploymentMonitoringJob. It will run periodically on a configured interval.
▼ ▲ aiplatform.projects.locations.modelDeploymentMonitoringJobs.searchModelDeploymentMonitoringStatsAnomalies
Path : v1beta1/{+modelDeploymentMonitoringJob}:searchModelDeploymentMonitoringStatsAnomalies
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}:searchModelDeploymentMonitoringStatsAnomalies
HTTP Method : POST
Parameters :
modelDeploymentMonitoringJob
Description : Required. ModelDeploymentMonitoring Job resource name. Format: `projects/{project}/locations/{location}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job}`
Pattern : ^projects/[^/]+/locations/[^/]+/modelDeploymentMonitoringJobs/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : modelDeploymentMonitoringJob
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Searches Model Monitoring Statistics generated within a given time window.
▼ ▲ aiplatform.projects.locations.modelDeploymentMonitoringJobs.get
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}
HTTP Method : GET
Parameters :
name
Description : Required. The resource name of the ModelDeploymentMonitoringJob. Format: `projects/{project}/locations/{location}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job}`
Pattern : ^projects/[^/]+/locations/[^/]+/modelDeploymentMonitoringJobs/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets a ModelDeploymentMonitoringJob.
▼ ▲ aiplatform.projects.locations.modelDeploymentMonitoringJobs.list
Path : v1beta1/{+parent}/modelDeploymentMonitoringJobs
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs
HTTP Method : GET
Parameters :
parent
Description : Required. The parent of the ModelDeploymentMonitoringJob. Format: `projects/{project}/locations/{location}`
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
filter
Description : The standard list filter. Supported fields: * `display_name` supports `=`, `!=` comparisons, and `:` wildcard. * `state` supports `=`, `!=` comparisons. * `create_time` supports `=`, `!=`,`<`, `<=`,`>`, `>=` comparisons. `create_time` must be in RFC 3339 format. * `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* - key existence Some examples of using the filter are: * `state="JOB_STATE_SUCCEEDED" AND display_name:"my_job_*"` * `state!="JOB_STATE_FAILED" OR display_name="my_job"` * `NOT display_name="my_job"` * `create_time>"2021-05-18T00:00:00Z"` * `labels.keyA=valueA` * `labels.keyB:*`
Location : query
Type : string
pageSize
Description : The standard list page size.
Location : query
Type : integer
Format : int32
pageToken
Description : The standard list page token.
Location : query
Type : string
readMask
Description : Mask specifying which fields to read
Location : query
Type : string
Format : google-fieldmask
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists ModelDeploymentMonitoringJobs in a Location.
▼ ▲ aiplatform.projects.locations.modelDeploymentMonitoringJobs.patch
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}
HTTP Method : PATCH
Parameters :
name
Description : Output only. Resource name of a ModelDeploymentMonitoringJob.
Pattern : ^projects/[^/]+/locations/[^/]+/modelDeploymentMonitoringJobs/[^/]+$
Location : path
Required : Yes
Type : string
updateMask
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
Type : string
Format : google-fieldmask
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Updates a ModelDeploymentMonitoringJob.
▼ ▲ aiplatform.projects.locations.modelDeploymentMonitoringJobs.delete
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}
HTTP Method : DELETE
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
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Deletes a ModelDeploymentMonitoringJob.
▼ ▲ aiplatform.projects.locations.modelDeploymentMonitoringJobs.pause
Path : v1beta1/{+name}:pause
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}:pause
HTTP Method : POST
Parameters :
name
Description : Required. The resource name of the ModelDeploymentMonitoringJob to pause. Format: `projects/{project}/locations/{location}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job}`
Pattern : ^projects/[^/]+/locations/[^/]+/modelDeploymentMonitoringJobs/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Pauses a ModelDeploymentMonitoringJob. If the job is running, the server makes a best effort to cancel the job. Will mark ModelDeploymentMonitoringJob.state to 'PAUSED'.
▼ ▲ aiplatform.projects.locations.modelDeploymentMonitoringJobs.resume
Path : v1beta1/{+name}:resume
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}:resume
HTTP Method : POST
Parameters :
name
Description : Required. The resource name of the ModelDeploymentMonitoringJob to resume. Format: `projects/{project}/locations/{location}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job}`
Pattern : ^projects/[^/]+/locations/[^/]+/modelDeploymentMonitoringJobs/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Resumes a paused ModelDeploymentMonitoringJob. It will start to run from next scheduled time. A deleted ModelDeploymentMonitoringJob can't be resumed.
▼ ▲ aiplatform.projects.locations.modelDeploymentMonitoringJobs.operations.list
Path : v1beta1/{+name}/operations
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}/operations
HTTP Method : GET
Parameters :
name
Description : The name of the operation's parent resource.
Pattern : ^projects/[^/]+/locations/[^/]+/modelDeploymentMonitoringJobs/[^/]+$
Location : path
Required : Yes
Type : string
filter
Description : The standard list filter.
Location : query
Type : string
pageSize
Description : The standard list page size.
Location : query
Type : integer
Format : int32
pageToken
Description : The standard list page token.
Location : query
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
▼ ▲ aiplatform.projects.locations.modelDeploymentMonitoringJobs.operations.get
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}/operations/{operationsId}
HTTP Method : GET
Parameters :
name
Description : The name of the operation resource.
Pattern : ^projects/[^/]+/locations/[^/]+/modelDeploymentMonitoringJobs/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
▼ ▲ aiplatform.projects.locations.modelDeploymentMonitoringJobs.operations.delete
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}/operations/{operationsId}
HTTP Method : DELETE
Parameters :
name
Description : The name of the operation resource to be deleted.
Pattern : ^projects/[^/]+/locations/[^/]+/modelDeploymentMonitoringJobs/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
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`.
▼ ▲ aiplatform.projects.locations.modelDeploymentMonitoringJobs.operations.cancel
Path : v1beta1/{+name}:cancel
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}/operations/{operationsId}:cancel
HTTP Method : POST
Parameters :
name
Description : The name of the operation resource to be cancelled.
Pattern : ^projects/[^/]+/locations/[^/]+/modelDeploymentMonitoringJobs/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
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`.
▼ ▲ aiplatform.projects.locations.modelDeploymentMonitoringJobs.operations.wait
Path : v1beta1/{+name}:wait
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}/operations/{operationsId}:wait
HTTP Method : POST
Parameters :
name
Description : The name of the operation resource to wait on.
Pattern : ^projects/[^/]+/locations/[^/]+/modelDeploymentMonitoringJobs/[^/]+/operations/[^/]+$
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.
Location : query
Type : string
Format : google-duration
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.
▼ ▲ aiplatform.projects.locations.metadataStores.create
Path : v1beta1/{+parent}/metadataStores
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores
HTTP Method : POST
Parameters :
parent
Description : Required. The resource name of the Location where the MetadataStore should be created. Format: `projects/{project}/locations/{location}/`
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
metadataStoreId
Description : The {metadatastore} portion of the resource name with the format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}` If not provided, the MetadataStore's ID will be a UUID generated by the service. Must be 4-128 characters in length. Valid characters are `/a-z-/`. Must be unique across all MetadataStores in the parent Location. (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED if the caller can't view the preexisting MetadataStore.)
Location : query
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Initializes a MetadataStore, including allocation of resources.
▼ ▲ aiplatform.projects.locations.metadataStores.get
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}
HTTP Method : GET
Parameters :
name
Description : Required. The resource name of the MetadataStore to retrieve. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}`
Pattern : ^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Retrieves a specific MetadataStore.
▼ ▲ aiplatform.projects.locations.metadataStores.list
Path : v1beta1/{+parent}/metadataStores
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores
HTTP Method : GET
Parameters :
parent
Description : Required. The Location whose MetadataStores should be listed. Format: `projects/{project}/locations/{location}`
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
pageSize
Description : The maximum number of Metadata Stores to return. The service may return fewer. Must be in range 1-1000, inclusive. Defaults to 100.
Location : query
Type : integer
Format : int32
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.)
Location : query
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists MetadataStores for a Location.
▼ ▲ aiplatform.projects.locations.metadataStores.delete
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}
HTTP Method : DELETE
Parameters :
name
Description : Required. The resource name of the MetadataStore to delete. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}`
Pattern : ^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+$
Location : path
Required : Yes
Type : string
force
Description : Deprecated: Field is no longer supported.
Location : query
Deprecated : Yes
Type : boolean
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Deletes a single MetadataStore and all its child resources (Artifacts, Executions, and Contexts).
▼ ▲ aiplatform.projects.locations.metadataStores.operations.list
Path : v1beta1/{+name}/operations
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/operations
HTTP Method : GET
Parameters :
name
Description : The name of the operation's parent resource.
Pattern : ^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+$
Location : path
Required : Yes
Type : string
filter
Description : The standard list filter.
Location : query
Type : string
pageSize
Description : The standard list page size.
Location : query
Type : integer
Format : int32
pageToken
Description : The standard list page token.
Location : query
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
▼ ▲ aiplatform.projects.locations.metadataStores.operations.get
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/operations/{operationsId}
HTTP Method : GET
Parameters :
name
Description : The name of the operation resource.
Pattern : ^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
▼ ▲ aiplatform.projects.locations.metadataStores.operations.delete
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/operations/{operationsId}
HTTP Method : DELETE
Parameters :
name
Description : The name of the operation resource to be deleted.
Pattern : ^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
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`.
▼ ▲ aiplatform.projects.locations.metadataStores.operations.cancel
Path : v1beta1/{+name}:cancel
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/operations/{operationsId}:cancel
HTTP Method : POST
Parameters :
name
Description : The name of the operation resource to be cancelled.
Pattern : ^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
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`.
▼ ▲ aiplatform.projects.locations.metadataStores.operations.wait
Path : v1beta1/{+name}:wait
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/operations/{operationsId}:wait
HTTP Method : POST
Parameters :
name
Description : The name of the operation resource to wait on.
Pattern : ^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/operations/[^/]+$
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.
Location : query
Type : string
Format : google-duration
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.
▼ ▲ aiplatform.projects.locations.metadataStores.artifacts.create
Path : v1beta1/{+parent}/artifacts
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts
HTTP Method : POST
Parameters :
parent
Description : Required. The resource name of the MetadataStore where the Artifact should be created. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}`
Pattern : ^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+$
Location : path
Required : Yes
Type : string
artifactId
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
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Creates an Artifact associated with a MetadataStore.
▼ ▲ aiplatform.projects.locations.metadataStores.artifacts.get
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts/{artifactsId}
HTTP Method : GET
Parameters :
name
Description : Required. The resource name of the Artifact to retrieve. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/artifacts/{artifact}`
Pattern : ^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/artifacts/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Retrieves a specific Artifact.
▼ ▲ aiplatform.projects.locations.metadataStores.artifacts.list
Path : v1beta1/{+parent}/artifacts
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts
HTTP Method : GET
Parameters :
parent
Description : Required. The MetadataStore whose Artifacts should be listed. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}`
Pattern : ^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+$
Location : path
Required : Yes
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
Type : integer
Format : int32
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
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
Description : How the list of messages is ordered. Specify the values to order by and an ordering operation. The default sorting order is ascending. To specify descending order for a field, users append a " desc" suffix; for example: "foo desc, bar". Subfields are specified with a `.` character, such as foo.bar. see https://google.aip.dev/132#ordering for more details.
Location : query
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists Artifacts in the MetadataStore.
▼ ▲ aiplatform.projects.locations.metadataStores.artifacts.patch
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts/{artifactsId}
HTTP Method : PATCH
Parameters :
name
Description : Output only. The resource name of the Artifact.
Pattern : ^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/artifacts/[^/]+$
Location : path
Required : Yes
Type : string
updateMask
Description : Optional. A FieldMask indicating which fields should be updated.
Location : query
Type : string
Format : google-fieldmask
allowMissing
Description : If set to true, and the Artifact is not found, a new Artifact is created.
Location : query
Type : boolean
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Updates a stored Artifact.
▼ ▲ aiplatform.projects.locations.metadataStores.artifacts.delete
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts/{artifactsId}
HTTP Method : DELETE
Parameters :
name
Description : Required. The resource name of the Artifact to delete. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/artifacts/{artifact}`
Pattern : ^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/artifacts/[^/]+$
Location : path
Required : Yes
Type : string
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
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Deletes an Artifact.
▼ ▲ aiplatform.projects.locations.metadataStores.artifacts.purge
Path : v1beta1/{+parent}/artifacts:purge
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts:purge
HTTP Method : POST
Parameters :
parent
Description : Required. The metadata store to purge Artifacts from. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}`
Pattern : ^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Purges Artifacts.
▼ ▲ aiplatform.projects.locations.metadataStores.artifacts.queryArtifactLineageSubgraph
Path : v1beta1/{+artifact}:queryArtifactLineageSubgraph
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts/{artifactsId}:queryArtifactLineageSubgraph
HTTP Method : GET
Parameters :
artifact
Description : Required. The resource name of the Artifact whose Lineage needs to be retrieved as a LineageSubgraph. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/artifacts/{artifact}` The request may error with FAILED_PRECONDITION if the number of Artifacts, the number of Executions, or the number of Events that would be returned for the Context exceeds 1000.
Pattern : ^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/artifacts/[^/]+$
Location : path
Required : Yes
Type : string
maxHops
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.
Location : query
Type : integer
Format : int32
filter
Description : Filter specifying the boolean condition for the Artifacts to satisfy in order to be part of the Lineage Subgraph. The syntax to define filter query is based on https://google.aip.dev/160. The supported set of filters include the following: * **Attribute filtering**: For example: `display_name = "test"` Supported fields include: `name`, `display_name`, `uri`, `state`, `schema_title`, `create_time`, and `update_time`. Time fields, such as `create_time` and `update_time`, require values specified in RFC-3339 format. For example: `create_time = "2020-11-19T11:30:00-04:00"` * **Metadata field**: To filter on metadata fields use traversal operation as follows: `metadata..`. For example: `metadata.field_1.number_value = 10.0` In case the field name contains special characters (such as colon), one can embed it inside double quote. For example: `metadata."field:1".number_value = 10.0` Each of the above supported filter types can be combined together using logical operators (`AND` & `OR`). Maximum nested expression depth allowed is 5. For example: `display_name = "test" AND metadata.field1.bool_value = true`.
Location : query
Type : string
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.
▼ ▲ aiplatform.projects.locations.metadataStores.artifacts.operations.list
Path : v1beta1/{+name}/operations
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts/{artifactsId}/operations
HTTP Method : GET
Parameters :
name
Description : The name of the operation's parent resource.
Pattern : ^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/artifacts/[^/]+$
Location : path
Required : Yes
Type : string
filter
Description : The standard list filter.
Location : query
Type : string
pageSize
Description : The standard list page size.
Location : query
Type : integer
Format : int32
pageToken
Description : The standard list page token.
Location : query
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
▼ ▲ aiplatform.projects.locations.metadataStores.artifacts.operations.get
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts/{artifactsId}/operations/{operationsId}
HTTP Method : GET
Parameters :
name
Description : The name of the operation resource.
Pattern : ^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/artifacts/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
▼ ▲ aiplatform.projects.locations.metadataStores.artifacts.operations.delete
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts/{artifactsId}/operations/{operationsId}
HTTP Method : DELETE
Parameters :
name
Description : The name of the operation resource to be deleted.
Pattern : ^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/artifacts/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
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`.
▼ ▲ aiplatform.projects.locations.metadataStores.artifacts.operations.cancel
Path : v1beta1/{+name}:cancel
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts/{artifactsId}/operations/{operationsId}:cancel
HTTP Method : POST
Parameters :
name
Description : The name of the operation resource to be cancelled.
Pattern : ^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/artifacts/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
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`.
▼ ▲ aiplatform.projects.locations.metadataStores.artifacts.operations.wait
Path : v1beta1/{+name}:wait
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts/{artifactsId}/operations/{operationsId}:wait
HTTP Method : POST
Parameters :
name
Description : The name of the operation resource to wait on.
Pattern : ^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/artifacts/[^/]+/operations/[^/]+$
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.
Location : query
Type : string
Format : google-duration
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.
▼ ▲ aiplatform.projects.locations.metadataStores.contexts.create
Path : v1beta1/{+parent}/contexts
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts
HTTP Method : POST
Parameters :
parent
Description : Required. The resource name of the MetadataStore where the Context should be created. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}`
Pattern : ^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+$
Location : path
Required : Yes
Type : string
contextId
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
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Creates a Context associated with a MetadataStore.
▼ ▲ aiplatform.projects.locations.metadataStores.contexts.get
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}
HTTP Method : GET
Parameters :
name
Description : Required. The resource name of the Context to retrieve. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}`
Pattern : ^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/contexts/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Retrieves a specific Context.
▼ ▲ aiplatform.projects.locations.metadataStores.contexts.list
Path : v1beta1/{+parent}/contexts
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts
HTTP Method : GET
Parameters :
parent
Description : Required. The MetadataStore whose Contexts should be listed. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}`
Pattern : ^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+$
Location : path
Required : Yes
Type : string
pageSize
Description : The maximum number of Contexts to return. The service may return fewer. Must be in range 1-1000, inclusive. Defaults to 100.
Location : query
Type : integer
Format : int32
pageToken
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
Type : string
filter
Description : Filter specifying the boolean condition for the Contexts to satisfy in order to be part of the result set. The syntax to define filter query is based on https://google.aip.dev/160. Following are the supported set of filters: * **Attribute filtering**: For example: `display_name = "test"`. Supported fields include: `name`, `display_name`, `schema_title`, `create_time`, and `update_time`. Time fields, such as `create_time` and `update_time`, require values specified in RFC-3339 format. For example: `create_time = "2020-11-19T11:30:00-04:00"`. * **Metadata field**: To filter on metadata fields use traversal operation as follows: `metadata..`. For example: `metadata.field_1.number_value = 10.0`. In case the field name contains special characters (such as colon), one can embed it inside double quote. For example: `metadata."field:1".number_value = 10.0` * **Parent Child filtering**: To filter Contexts based on parent-child relationship use the HAS operator as follows: ``` parent_contexts: "projects//locations//metadataStores//contexts/" child_contexts: "projects//locations//metadataStores//contexts/" ``` Each of the above supported filters can be combined together using logical operators (`AND` & `OR`). Maximum nested expression depth allowed is 5. For example: `display_name = "test" AND metadata.field1.bool_value = true`.
Location : query
Type : string
orderBy
Description : How the list of messages is ordered. Specify the values to order by and an ordering operation. The default sorting order is ascending. To specify descending order for a field, users append a " desc" suffix; for example: "foo desc, bar". Subfields are specified with a `.` character, such as foo.bar. see https://google.aip.dev/132#ordering for more details.
Location : query
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists Contexts on the MetadataStore.
▼ ▲ aiplatform.projects.locations.metadataStores.contexts.patch
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}
HTTP Method : PATCH
Parameters :
name
Description : Immutable. The resource name of the Context.
Pattern : ^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/contexts/[^/]+$
Location : path
Required : Yes
Type : string
updateMask
Description : Optional. A FieldMask indicating which fields should be updated.
Location : query
Type : string
Format : google-fieldmask
allowMissing
Description : If set to true, and the Context is not found, a new Context is created.
Location : query
Type : boolean
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Updates a stored Context.
▼ ▲ aiplatform.projects.locations.metadataStores.contexts.delete
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}
HTTP Method : DELETE
Parameters :
name
Description : Required. The resource name of the Context to delete. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}`
Pattern : ^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/contexts/[^/]+$
Location : path
Required : Yes
Type : string
force
Description : The force deletion semantics is still undefined. Users should not use this field.
Location : query
Type : boolean
etag
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.
Location : query
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Deletes a stored Context.
▼ ▲ aiplatform.projects.locations.metadataStores.contexts.purge
Path : v1beta1/{+parent}/contexts:purge
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts:purge
HTTP Method : POST
Parameters :
parent
Description : Required. The metadata store to purge Contexts from. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}`
Pattern : ^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Purges Contexts.
▼ ▲ aiplatform.projects.locations.metadataStores.contexts.addContextArtifactsAndExecutions
Path : v1beta1/{+context}:addContextArtifactsAndExecutions
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}:addContextArtifactsAndExecutions
HTTP Method : POST
Parameters :
context
Description : Required. The resource name of the Context that the Artifacts and Executions belong to. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}`
Pattern : ^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/contexts/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : context
Scopes : https://www.googleapis.com/auth/cloud-platform
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.addContextChildren
Path : v1beta1/{+context}:addContextChildren
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}:addContextChildren
HTTP Method : POST
Parameters :
context
Description : Required. The resource name of the parent Context. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}`
Pattern : ^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/contexts/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : context
Scopes : https://www.googleapis.com/auth/cloud-platform
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.
▼ ▲ aiplatform.projects.locations.metadataStores.contexts.removeContextChildren
Path : v1beta1/{+context}:removeContextChildren
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}:removeContextChildren
HTTP Method : POST
Parameters :
context
Description : Required. The resource name of the parent Context. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}`
Pattern : ^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/contexts/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : context
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Remove a set of children contexts from a parent Context. If any of the child Contexts were NOT added to the parent Context, they are simply skipped.
▼ ▲ aiplatform.projects.locations.metadataStores.contexts.queryContextLineageSubgraph
Path : v1beta1/{+context}:queryContextLineageSubgraph
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}:queryContextLineageSubgraph
HTTP Method : GET
Parameters :
context
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.
Pattern : ^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/contexts/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : context
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Retrieves Artifacts and Executions within the specified Context, connected by Event edges and returned as a LineageSubgraph.
▼ ▲ aiplatform.projects.locations.metadataStores.contexts.operations.list
Path : v1beta1/{+name}/operations
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}/operations
HTTP Method : GET
Parameters :
name
Description : The name of the operation's parent resource.
Pattern : ^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/contexts/[^/]+$
Location : path
Required : Yes
Type : string
filter
Description : The standard list filter.
Location : query
Type : string
pageSize
Description : The standard list page size.
Location : query
Type : integer
Format : int32
pageToken
Description : The standard list page token.
Location : query
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
▼ ▲ aiplatform.projects.locations.metadataStores.contexts.operations.get
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}/operations/{operationsId}
HTTP Method : GET
Parameters :
name
Description : The name of the operation resource.
Pattern : ^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/contexts/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
▼ ▲ aiplatform.projects.locations.metadataStores.contexts.operations.delete
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}/operations/{operationsId}
HTTP Method : DELETE
Parameters :
name
Description : The name of the operation resource to be deleted.
Pattern : ^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/contexts/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
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`.
▼ ▲ aiplatform.projects.locations.metadataStores.contexts.operations.cancel
Path : v1beta1/{+name}:cancel
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}/operations/{operationsId}:cancel
HTTP Method : POST
Parameters :
name
Description : The name of the operation resource to be cancelled.
Pattern : ^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/contexts/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
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`.
▼ ▲ aiplatform.projects.locations.metadataStores.contexts.operations.wait
Path : v1beta1/{+name}:wait
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}/operations/{operationsId}:wait
HTTP Method : POST
Parameters :
name
Description : The name of the operation resource to wait on.
Pattern : ^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/contexts/[^/]+/operations/[^/]+$
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.
Location : query
Type : string
Format : google-duration
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.
▼ ▲ aiplatform.projects.locations.metadataStores.executions.create
Path : v1beta1/{+parent}/executions
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions
HTTP Method : POST
Parameters :
parent
Description : Required. The resource name of the MetadataStore where the Execution should be created. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}`
Pattern : ^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+$
Location : path
Required : Yes
Type : string
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.)
Location : query
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Creates an Execution associated with a MetadataStore.
▼ ▲ aiplatform.projects.locations.metadataStores.executions.get
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions/{executionsId}
HTTP Method : GET
Parameters :
name
Description : Required. The resource name of the Execution to retrieve. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution}`
Pattern : ^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/executions/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Retrieves a specific Execution.
▼ ▲ aiplatform.projects.locations.metadataStores.executions.list
Path : v1beta1/{+parent}/executions
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions
HTTP Method : GET
Parameters :
parent
Description : Required. The MetadataStore whose Executions should be listed. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}`
Pattern : ^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+$
Location : path
Required : Yes
Type : string
pageSize
Description : The maximum number of Executions to return. The service may return fewer. Must be in range 1-1000, inclusive. Defaults to 100.
Location : query
Type : integer
Format : int32
pageToken
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.)
Location : query
Type : string
filter
Description : Filter specifying the boolean condition for the Executions to satisfy in order to be part of the result set. The syntax to define filter query is based on https://google.aip.dev/160. Following are the supported set of filters: * **Attribute filtering**: For example: `display_name = "test"`. Supported fields include: `name`, `display_name`, `state`, `schema_title`, `create_time`, and `update_time`. Time fields, such as `create_time` and `update_time`, require values specified in RFC-3339 format. For example: `create_time = "2020-11-19T11:30:00-04:00"`. * **Metadata field**: To filter on metadata fields use traversal operation as follows: `metadata..` For example: `metadata.field_1.number_value = 10.0` In case the field name contains special characters (such as colon), one can embed it inside double quote. For example: `metadata."field:1".number_value = 10.0` * **Context based filtering**: To filter Executions based on the contexts to which they belong use the function operator with the full resource name: `in_context()`. For example: `in_context("projects//locations//metadataStores//contexts/")` Each of the above supported filters can be combined together using logical operators (`AND` & `OR`). Maximum nested expression depth allowed is 5. For example: `display_name = "test" AND metadata.field1.bool_value = true`.
Location : query
Type : string
orderBy
Description : How the list of messages is ordered. Specify the values to order by and an ordering operation. The default sorting order is ascending. To specify descending order for a field, users append a " desc" suffix; for example: "foo desc, bar". Subfields are specified with a `.` character, such as foo.bar. see https://google.aip.dev/132#ordering for more details.
Location : query
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists Executions in the MetadataStore.
▼ ▲ aiplatform.projects.locations.metadataStores.executions.patch
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions/{executionsId}
HTTP Method : PATCH
Parameters :
name
Description : Output only. The resource name of the Execution.
Pattern : ^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/executions/[^/]+$
Location : path
Required : Yes
Type : string
updateMask
Description : Optional. A FieldMask indicating which fields should be updated.
Location : query
Type : string
Format : google-fieldmask
allowMissing
Description : If set to true, and the Execution is not found, a new Execution is created.
Location : query
Type : boolean
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Updates a stored Execution.
▼ ▲ aiplatform.projects.locations.metadataStores.executions.delete
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions/{executionsId}
HTTP Method : DELETE
Parameters :
name
Description : Required. The resource name of the Execution to delete. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution}`
Pattern : ^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/executions/[^/]+$
Location : path
Required : Yes
Type : string
etag
Description : Optional. The etag of the Execution to delete. If this is provided, it must match the server's etag. Otherwise, the request will fail with a FAILED_PRECONDITION.
Location : query
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Deletes an Execution.
▼ ▲ aiplatform.projects.locations.metadataStores.executions.purge
Path : v1beta1/{+parent}/executions:purge
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions:purge
HTTP Method : POST
Parameters :
parent
Description : Required. The metadata store to purge Executions from. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}`
Pattern : ^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Purges Executions.
▼ ▲ aiplatform.projects.locations.metadataStores.executions.addExecutionEvents
Path : v1beta1/{+execution}:addExecutionEvents
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions/{executionsId}:addExecutionEvents
HTTP Method : POST
Parameters :
execution
Description : Required. The resource name of the Execution that the Events connect Artifacts with. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution}`
Pattern : ^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/executions/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : execution
Scopes : https://www.googleapis.com/auth/cloud-platform
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.
▼ ▲ aiplatform.projects.locations.metadataStores.executions.queryExecutionInputsAndOutputs
Path : v1beta1/{+execution}:queryExecutionInputsAndOutputs
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions/{executionsId}:queryExecutionInputsAndOutputs
HTTP Method : GET
Parameters :
execution
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}`
Pattern : ^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/executions/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : execution
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Obtains the set of input and output Artifacts for this Execution, in the form of LineageSubgraph that also contains the Execution and connecting Events.
▼ ▲ aiplatform.projects.locations.metadataStores.executions.operations.list
Path : v1beta1/{+name}/operations
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions/{executionsId}/operations
HTTP Method : GET
Parameters :
name
Description : The name of the operation's parent resource.
Pattern : ^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/executions/[^/]+$
Location : path
Required : Yes
Type : string
filter
Description : The standard list filter.
Location : query
Type : string
pageSize
Description : The standard list page size.
Location : query
Type : integer
Format : int32
pageToken
Description : The standard list page token.
Location : query
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
▼ ▲ aiplatform.projects.locations.metadataStores.executions.operations.get
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions/{executionsId}/operations/{operationsId}
HTTP Method : GET
Parameters :
name
Description : The name of the operation resource.
Pattern : ^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/executions/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
▼ ▲ aiplatform.projects.locations.metadataStores.executions.operations.delete
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions/{executionsId}/operations/{operationsId}
HTTP Method : DELETE
Parameters :
name
Description : The name of the operation resource to be deleted.
Pattern : ^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/executions/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
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`.
▼ ▲ aiplatform.projects.locations.metadataStores.executions.operations.cancel
Path : v1beta1/{+name}:cancel
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions/{executionsId}/operations/{operationsId}:cancel
HTTP Method : POST
Parameters :
name
Description : The name of the operation resource to be cancelled.
Pattern : ^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/executions/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
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`.
▼ ▲ aiplatform.projects.locations.metadataStores.executions.operations.wait
Path : v1beta1/{+name}:wait
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions/{executionsId}/operations/{operationsId}:wait
HTTP Method : POST
Parameters :
name
Description : The name of the operation resource to wait on.
Pattern : ^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/executions/[^/]+/operations/[^/]+$
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.
Location : query
Type : string
Format : google-duration
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.
▼ ▲ aiplatform.projects.locations.metadataStores.metadataSchemas.create
Path : v1beta1/{+parent}/metadataSchemas
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/metadataSchemas
HTTP Method : POST
Parameters :
parent
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
Required : Yes
Type : string
metadataSchemaId
Description : The {metadata_schema} portion of the resource name with the format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/metadataSchemas/{metadataschema}` If not provided, the MetadataStore's ID will be a UUID generated by the service. Must be 4-128 characters in length. Valid characters are `/a-z-/`. Must be unique across all MetadataSchemas in the parent Location. (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED if the caller can't view the preexisting MetadataSchema.)
Location : query
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Creates a MetadataSchema.
▼ ▲ aiplatform.projects.locations.metadataStores.metadataSchemas.get
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/metadataSchemas/{metadataSchemasId}
HTTP Method : GET
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
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Retrieves a specific MetadataSchema.
▼ ▲ aiplatform.projects.locations.metadataStores.metadataSchemas.list
Path : v1beta1/{+parent}/metadataSchemas
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/metadataSchemas
HTTP Method : GET
Parameters :
parent
Description : Required. The MetadataStore whose MetadataSchemas should be listed. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}`
Pattern : ^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+$
Location : path
Required : Yes
Type : string
pageSize
Description : The maximum number of MetadataSchemas to return. The service may return fewer. Must be in range 1-1000, inclusive. Defaults to 100.
Location : query
Type : integer
Format : int32
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.)
Location : query
Type : string
filter
Description : A query to filter available MetadataSchemas for matching results.
Location : query
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists MetadataSchemas.
▼ ▲ aiplatform.projects.locations.migratableResources.search
Path : v1beta1/{+parent}/migratableResources:search
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/migratableResources:search
HTTP Method : POST
Parameters :
parent
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}`
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
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.
▼ ▲ aiplatform.projects.locations.migratableResources.batchMigrate
Path : v1beta1/{+parent}/migratableResources:batchMigrate
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/migratableResources:batchMigrate
HTTP Method : POST
Parameters :
parent
Description : Required. The location of the migrated resource will live in. Format: `projects/{project}/locations/{location}`
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Batch migrates resources from ml.googleapis.com, automl.googleapis.com, and datalabeling.googleapis.com to Vertex AI.
▼ ▲ aiplatform.projects.locations.migratableResources.operations.list
Path : v1beta1/{+name}/operations
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/migratableResources/{migratableResourcesId}/operations
HTTP Method : GET
Parameters :
name
Description : The name of the operation's parent resource.
Pattern : ^projects/[^/]+/locations/[^/]+/migratableResources/[^/]+$
Location : path
Required : Yes
Type : string
filter
Description : The standard list filter.
Location : query
Type : string
pageSize
Description : The standard list page size.
Location : query
Type : integer
Format : int32
pageToken
Description : The standard list page token.
Location : query
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
▼ ▲ aiplatform.projects.locations.migratableResources.operations.get
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/migratableResources/{migratableResourcesId}/operations/{operationsId}
HTTP Method : GET
Parameters :
name
Description : The name of the operation resource.
Pattern : ^projects/[^/]+/locations/[^/]+/migratableResources/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
▼ ▲ aiplatform.projects.locations.migratableResources.operations.delete
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/migratableResources/{migratableResourcesId}/operations/{operationsId}
HTTP Method : DELETE
Parameters :
name
Description : The name of the operation resource to be deleted.
Pattern : ^projects/[^/]+/locations/[^/]+/migratableResources/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
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`.
▼ ▲ aiplatform.projects.locations.migratableResources.operations.cancel
Path : v1beta1/{+name}:cancel
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/migratableResources/{migratableResourcesId}/operations/{operationsId}:cancel
HTTP Method : POST
Parameters :
name
Description : The name of the operation resource to be cancelled.
Pattern : ^projects/[^/]+/locations/[^/]+/migratableResources/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
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`.
▼ ▲ aiplatform.projects.locations.migratableResources.operations.wait
Path : v1beta1/{+name}:wait
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/migratableResources/{migratableResourcesId}/operations/{operationsId}:wait
HTTP Method : POST
Parameters :
name
Description : The name of the operation resource to wait on.
Pattern : ^projects/[^/]+/locations/[^/]+/migratableResources/[^/]+/operations/[^/]+$
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.
Location : query
Type : string
Format : google-duration
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.
▼ ▲ aiplatform.projects.locations.modelMonitors.create
Path : v1beta1/{+parent}/modelMonitors
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/modelMonitors
HTTP Method : POST
Parameters :
parent
Description : Required. The resource name of the Location to create the ModelMonitor in. Format: `projects/{project}/locations/{location}`
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
modelMonitorId
Description : Optional. The ID to use for the Model Monitor, which will become the final component of the model monitor resource name. The maximum length is 63 characters, and valid characters are `/^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$/`.
Location : query
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Creates a ModelMonitor.
▼ ▲ aiplatform.projects.locations.modelMonitors.patch
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/modelMonitors/{modelMonitorsId}
HTTP Method : PATCH
Parameters :
name
Description : Immutable. Resource name of the ModelMonitor. Format: `projects/{project}/locations/{location}/modelMonitors/{model_monitor}`.
Pattern : ^projects/[^/]+/locations/[^/]+/modelMonitors/[^/]+$
Location : path
Required : Yes
Type : string
updateMask
Description : Required. Mask specifying which fields to update.
Location : query
Type : string
Format : google-fieldmask
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Updates a ModelMonitor.
▼ ▲ aiplatform.projects.locations.modelMonitors.get
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/modelMonitors/{modelMonitorsId}
HTTP Method : GET
Parameters :
name
Description : Required. The name of the ModelMonitor resource. Format: `projects/{project}/locations/{location}/modelMonitors/{model_monitor}`
Pattern : ^projects/[^/]+/locations/[^/]+/modelMonitors/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets a ModelMonitor.
▼ ▲ aiplatform.projects.locations.modelMonitors.list
Path : v1beta1/{+parent}/modelMonitors
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/modelMonitors
HTTP Method : GET
Parameters :
parent
Description : Required. The resource name of the Location to list the ModelMonitors from. Format: `projects/{project}/locations/{location}`
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
filter
Description : The standard list filter. More detail in [AIP-160](https://google.aip.dev/160).
Location : query
Type : string
pageSize
Description : The standard list page size.
Location : query
Type : integer
Format : int32
pageToken
Description : The standard list page token.
Location : query
Type : string
readMask
Description : Mask specifying which fields to read.
Location : query
Type : string
Format : google-fieldmask
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists ModelMonitors in a Location.
▼ ▲ aiplatform.projects.locations.modelMonitors.delete
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/modelMonitors/{modelMonitorsId}
HTTP Method : DELETE
Parameters :
name
Description : Required. The name of the ModelMonitor resource to be deleted. Format: `projects/{project}/locations/{location}/modelMonitords/{model_monitor}`
Pattern : ^projects/[^/]+/locations/[^/]+/modelMonitors/[^/]+$
Location : path
Required : Yes
Type : string
force
Description : Optional. Force delete the model monitor with schedules.
Location : query
Type : boolean
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Deletes a ModelMonitor.
▼ ▲ aiplatform.projects.locations.modelMonitors.searchModelMonitoringStats
Path : v1beta1/{+modelMonitor}:searchModelMonitoringStats
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/modelMonitors/{modelMonitorsId}:searchModelMonitoringStats
HTTP Method : POST
Parameters :
modelMonitor
Description : Required. ModelMonitor resource name. Format: `projects/{project}/locations/{location}/modelMonitors/{model_monitor}`
Pattern : ^projects/[^/]+/locations/[^/]+/modelMonitors/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : modelMonitor
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Searches Model Monitoring Stats generated within a given time window.
▼ ▲ aiplatform.projects.locations.modelMonitors.searchModelMonitoringAlerts
Path : v1beta1/{+modelMonitor}:searchModelMonitoringAlerts
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/modelMonitors/{modelMonitorsId}:searchModelMonitoringAlerts
HTTP Method : POST
Parameters :
modelMonitor
Description : Required. ModelMonitor resource name. Format: `projects/{project}/locations/{location}/modelMonitors/{model_monitor}`
Pattern : ^projects/[^/]+/locations/[^/]+/modelMonitors/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : modelMonitor
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Returns the Model Monitoring alerts.
▼ ▲ aiplatform.projects.locations.modelMonitors.operations.list
Path : v1beta1/{+name}/operations
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/modelMonitors/{modelMonitorsId}/operations
HTTP Method : GET
Parameters :
name
Description : The name of the operation's parent resource.
Pattern : ^projects/[^/]+/locations/[^/]+/modelMonitors/[^/]+$
Location : path
Required : Yes
Type : string
filter
Description : The standard list filter.
Location : query
Type : string
pageSize
Description : The standard list page size.
Location : query
Type : integer
Format : int32
pageToken
Description : The standard list page token.
Location : query
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
▼ ▲ aiplatform.projects.locations.modelMonitors.operations.get
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/modelMonitors/{modelMonitorsId}/operations/{operationsId}
HTTP Method : GET
Parameters :
name
Description : The name of the operation resource.
Pattern : ^projects/[^/]+/locations/[^/]+/modelMonitors/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
▼ ▲ aiplatform.projects.locations.modelMonitors.operations.delete
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/modelMonitors/{modelMonitorsId}/operations/{operationsId}
HTTP Method : DELETE
Parameters :
name
Description : The name of the operation resource to be deleted.
Pattern : ^projects/[^/]+/locations/[^/]+/modelMonitors/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
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`.
▼ ▲ aiplatform.projects.locations.modelMonitors.operations.cancel
Path : v1beta1/{+name}:cancel
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/modelMonitors/{modelMonitorsId}/operations/{operationsId}:cancel
HTTP Method : POST
Parameters :
name
Description : The name of the operation resource to be cancelled.
Pattern : ^projects/[^/]+/locations/[^/]+/modelMonitors/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
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`.
▼ ▲ aiplatform.projects.locations.modelMonitors.operations.wait
Path : v1beta1/{+name}:wait
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/modelMonitors/{modelMonitorsId}/operations/{operationsId}:wait
HTTP Method : POST
Parameters :
name
Description : The name of the operation resource to wait on.
Pattern : ^projects/[^/]+/locations/[^/]+/modelMonitors/[^/]+/operations/[^/]+$
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.
Location : query
Type : string
Format : google-duration
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.
▼ ▲ aiplatform.projects.locations.modelMonitors.modelMonitoringJobs.create
Path : v1beta1/{+parent}/modelMonitoringJobs
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/modelMonitors/{modelMonitorsId}/modelMonitoringJobs
HTTP Method : POST
Parameters :
parent
Description : Required. The parent of the ModelMonitoringJob. Format: `projects/{project}/locations/{location}/modelMoniitors/{model_monitor}`
Pattern : ^projects/[^/]+/locations/[^/]+/modelMonitors/[^/]+$
Location : path
Required : Yes
Type : string
modelMonitoringJobId
Description : Optional. The ID to use for the Model Monitoring Job, which will become the final component of the model monitoring job resource name. The maximum length is 63 characters, and valid characters are `/^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$/`.
Location : query
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Creates a ModelMonitoringJob.
▼ ▲ aiplatform.projects.locations.modelMonitors.modelMonitoringJobs.get
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/modelMonitors/{modelMonitorsId}/modelMonitoringJobs/{modelMonitoringJobsId}
HTTP Method : GET
Parameters :
name
Description : Required. The resource name of the ModelMonitoringJob. Format: `projects/{project}/locations/{location}/modelMonitors/{model_monitor}/modelMonitoringJobs/{model_monitoring_job}`
Pattern : ^projects/[^/]+/locations/[^/]+/modelMonitors/[^/]+/modelMonitoringJobs/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets a ModelMonitoringJob.
▼ ▲ aiplatform.projects.locations.modelMonitors.modelMonitoringJobs.list
Path : v1beta1/{+parent}/modelMonitoringJobs
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/modelMonitors/{modelMonitorsId}/modelMonitoringJobs
HTTP Method : GET
Parameters :
parent
Description : Required. The parent of the ModelMonitoringJob. Format: `projects/{project}/locations/{location}/modelMonitors/{model_monitor}`
Pattern : ^projects/[^/]+/locations/[^/]+/modelMonitors/[^/]+$
Location : path
Required : Yes
Type : string
filter
Description : The standard list filter. More detail in [AIP-160](https://google.aip.dev/160).
Location : query
Type : string
pageSize
Description : The standard list page size.
Location : query
Type : integer
Format : int32
pageToken
Description : The standard list page token.
Location : query
Type : string
readMask
Description : Mask specifying which fields to read
Location : query
Type : string
Format : google-fieldmask
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists ModelMonitoringJobs. Callers may choose to read across multiple Monitors as per [AIP-159](https://google.aip.dev/159) by using '-' (the hyphen or dash character) as a wildcard character instead of modelMonitor id in the parent. Format `projects/{project_id}/locations/{location}/moodelMonitors/-/modelMonitoringJobs`
▼ ▲ aiplatform.projects.locations.modelMonitors.modelMonitoringJobs.delete
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/modelMonitors/{modelMonitorsId}/modelMonitoringJobs/{modelMonitoringJobsId}
HTTP Method : DELETE
Parameters :
name
Description : Required. The resource name of the model monitoring job to delete. Format: `projects/{project}/locations/{location}/modelMonitors/{model_monitor}/modelMonitoringJobs/{model_monitoring_job}`
Pattern : ^projects/[^/]+/locations/[^/]+/modelMonitors/[^/]+/modelMonitoringJobs/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Deletes a ModelMonitoringJob.
▼ ▲ aiplatform.projects.locations.notebookRuntimes.reportEvent
Path : v1beta1/{+name}:reportEvent
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}:reportEvent
HTTP Method : POST
Parameters :
name
Description : Required. The name of the NotebookRuntime resource. Format: `projects/{project}/locations/{location}/notebookRuntimes/{notebook_runtime}`
Pattern : ^projects/[^/]+/locations/[^/]+/notebookRuntimes/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
▼ ▲ aiplatform.projects.locations.notebookRuntimes.generateAccessToken
Path : v1beta1/{+name}:generateAccessToken
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}:generateAccessToken
HTTP Method : POST
Parameters :
name
Description : Required. The name of the resource requesting the OAuth2 token. Format: `projects/{project}/locations/{location}/notebookRuntimes/{notebook_runtime}` `projects/{project}/locations/{location}/notebookExecutionJobs/{notebook_execution_job}`
Pattern : ^projects/[^/]+/locations/[^/]+/notebookRuntimes/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Internal only: Called from Compute Engine instance to obtain EUC for owner Anonymous access: authenticates caller using VM identity JWT. Design doc: go/colab-on-vertex-euc-dd
▼ ▲ aiplatform.projects.locations.notebookRuntimes.assign
Path : v1beta1/{+parent}/notebookRuntimes:assign
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes:assign
HTTP Method : POST
Parameters :
parent
Description : Required. The resource name of the Location to get the NotebookRuntime assignment. Format: `projects/{project}/locations/{location}`
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Assigns a NotebookRuntime to a user for a particular Notebook file. This method will either returns an existing assignment or generates a new one.
▼ ▲ aiplatform.projects.locations.notebookRuntimes.get
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}
HTTP Method : GET
Parameters :
name
Description : Required. The name of the NotebookRuntime resource. Instead of checking whether the name is in valid NotebookRuntime resource name format, directly throw NotFound exception if there is no such NotebookRuntime in spanner.
Pattern : ^projects/[^/]+/locations/[^/]+/notebookRuntimes/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets a NotebookRuntime.
▼ ▲ aiplatform.projects.locations.notebookRuntimes.list
Path : v1beta1/{+parent}/notebookRuntimes
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes
HTTP Method : GET
Parameters :
parent
Description : Required. The resource name of the Location from which to list the NotebookRuntimes. Format: `projects/{project}/locations/{location}`
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
filter
Description : Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `notebookRuntime` supports = and !=. `notebookRuntime` represents the NotebookRuntime ID, i.e. the last segment of the NotebookRuntime's resource name. * `displayName` supports = and != and regex. * `notebookRuntimeTemplate` supports = and !=. `notebookRuntimeTemplate` represents the NotebookRuntimeTemplate ID, i.e. the last segment of the NotebookRuntimeTemplate's resource name. * `healthState` supports = and !=. healthState enum: [HEALTHY, UNHEALTHY, HEALTH_STATE_UNSPECIFIED]. * `runtimeState` supports = and !=. runtimeState enum: [RUNTIME_STATE_UNSPECIFIED, RUNNING, BEING_STARTED, BEING_STOPPED, STOPPED, BEING_UPGRADED, ERROR, INVALID]. * `runtimeUser` supports = and !=. * API version is UI only: `uiState` supports = and !=. uiState enum: [UI_RESOURCE_STATE_UNSPECIFIED, UI_RESOURCE_STATE_BEING_CREATED, UI_RESOURCE_STATE_ACTIVE, UI_RESOURCE_STATE_BEING_DELETED, UI_RESOURCE_STATE_CREATION_FAILED]. * `notebookRuntimeType` supports = and !=. notebookRuntimeType enum: [USER_DEFINED, ONE_CLICK]. * `machineType` supports = and !=. * `acceleratorType` supports = and !=. Some examples: * `notebookRuntime="notebookRuntime123"` * `displayName="myDisplayName"` and `displayName=~"myDisplayNameRegex"` * `notebookRuntimeTemplate="notebookRuntimeTemplate321"` * `healthState=HEALTHY` * `runtimeState=RUNNING` * `runtimeUser="test@google.com"` * `uiState=UI_RESOURCE_STATE_BEING_DELETED` * `notebookRuntimeType=USER_DEFINED` * `machineType=e2-standard-4` * `acceleratorType=NVIDIA_TESLA_T4`
Location : query
Type : string
pageSize
Description : Optional. The standard list page size.
Location : query
Type : integer
Format : int32
pageToken
Description : Optional. The standard list page token. Typically obtained via ListNotebookRuntimesResponse.next_page_token of the previous NotebookService.ListNotebookRuntimes call.
Location : query
Type : string
readMask
Description : Optional. Mask specifying which fields to read.
Location : query
Type : string
Format : google-fieldmask
orderBy
Description : Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `display_name` * `create_time` * `update_time` Example: `display_name, create_time desc`.
Location : query
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists NotebookRuntimes in a Location.
▼ ▲ aiplatform.projects.locations.notebookRuntimes.delete
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}
HTTP Method : DELETE
Parameters :
name
Description : Required. The name of the NotebookRuntime resource to be deleted. Instead of checking whether the name is in valid NotebookRuntime resource name format, directly throw NotFound exception if there is no such NotebookRuntime in spanner.
Pattern : ^projects/[^/]+/locations/[^/]+/notebookRuntimes/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Deletes a NotebookRuntime.
▼ ▲ aiplatform.projects.locations.notebookRuntimes.upgrade
Path : v1beta1/{+name}:upgrade
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}:upgrade
HTTP Method : POST
Parameters :
name
Description : Required. The name of the NotebookRuntime resource to be upgrade. Instead of checking whether the name is in valid NotebookRuntime resource name format, directly throw NotFound exception if there is no such NotebookRuntime in spanner.
Pattern : ^projects/[^/]+/locations/[^/]+/notebookRuntimes/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Upgrades a NotebookRuntime.
▼ ▲ aiplatform.projects.locations.notebookRuntimes.start
Path : v1beta1/{+name}:start
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}:start
HTTP Method : POST
Parameters :
name
Description : Required. The name of the NotebookRuntime resource to be started. Instead of checking whether the name is in valid NotebookRuntime resource name format, directly throw NotFound exception if there is no such NotebookRuntime in spanner.
Pattern : ^projects/[^/]+/locations/[^/]+/notebookRuntimes/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Starts a NotebookRuntime.
▼ ▲ aiplatform.projects.locations.notebookRuntimes.stop
Path : v1beta1/{+name}:stop
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}:stop
HTTP Method : POST
Parameters :
name
Description : Required. The name of the NotebookRuntime resource to be stopped. Instead of checking whether the name is in valid NotebookRuntime resource name format, directly throw NotFound exception if there is no such NotebookRuntime in spanner.
Pattern : ^projects/[^/]+/locations/[^/]+/notebookRuntimes/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Stops a NotebookRuntime.
▼ ▲ aiplatform.projects.locations.notebookRuntimes.operations.list
Path : v1beta1/{+name}/operations
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}/operations
HTTP Method : GET
Parameters :
name
Description : The name of the operation's parent resource.
Pattern : ^projects/[^/]+/locations/[^/]+/notebookRuntimes/[^/]+$
Location : path
Required : Yes
Type : string
filter
Description : The standard list filter.
Location : query
Type : string
pageSize
Description : The standard list page size.
Location : query
Type : integer
Format : int32
pageToken
Description : The standard list page token.
Location : query
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
▼ ▲ aiplatform.projects.locations.notebookRuntimes.operations.get
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}/operations/{operationsId}
HTTP Method : GET
Parameters :
name
Description : The name of the operation resource.
Pattern : ^projects/[^/]+/locations/[^/]+/notebookRuntimes/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
▼ ▲ aiplatform.projects.locations.notebookRuntimes.operations.delete
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}/operations/{operationsId}
HTTP Method : DELETE
Parameters :
name
Description : The name of the operation resource to be deleted.
Pattern : ^projects/[^/]+/locations/[^/]+/notebookRuntimes/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
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`.
▼ ▲ aiplatform.projects.locations.notebookRuntimes.operations.cancel
Path : v1beta1/{+name}:cancel
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}/operations/{operationsId}:cancel
HTTP Method : POST
Parameters :
name
Description : The name of the operation resource to be cancelled.
Pattern : ^projects/[^/]+/locations/[^/]+/notebookRuntimes/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
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`.
▼ ▲ aiplatform.projects.locations.notebookRuntimes.operations.wait
Path : v1beta1/{+name}:wait
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}/operations/{operationsId}:wait
HTTP Method : POST
Parameters :
name
Description : The name of the operation resource to wait on.
Pattern : ^projects/[^/]+/locations/[^/]+/notebookRuntimes/[^/]+/operations/[^/]+$
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.
Location : query
Type : string
Format : google-duration
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.
▼ ▲ aiplatform.projects.locations.notebookExecutionJobs.reportEvent
Path : v1beta1/{+name}:reportEvent
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs/{notebookExecutionJobsId}:reportEvent
HTTP Method : POST
Parameters :
name
Description : Required. The name of the NotebookExecutionJob resource. Format: `projects/{project}/locations/{location}/notebookExecutionJobs/{notebook_execution_jobs}`
Pattern : ^projects/[^/]+/locations/[^/]+/notebookExecutionJobs/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
▼ ▲ aiplatform.projects.locations.notebookExecutionJobs.generateAccessToken
Path : v1beta1/{+name}:generateAccessToken
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs/{notebookExecutionJobsId}:generateAccessToken
HTTP Method : POST
Parameters :
name
Description : Required. The name of the resource requesting the OAuth2 token. Format: `projects/{project}/locations/{location}/notebookRuntimes/{notebook_runtime}` `projects/{project}/locations/{location}/notebookExecutionJobs/{notebook_execution_job}`
Pattern : ^projects/[^/]+/locations/[^/]+/notebookExecutionJobs/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Internal only: Called from Compute Engine instance to obtain EUC for owner Anonymous access: authenticates caller using VM identity JWT. Design doc: go/colab-on-vertex-euc-dd
▼ ▲ aiplatform.projects.locations.notebookExecutionJobs.create
Path : v1beta1/{+parent}/notebookExecutionJobs
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs
HTTP Method : POST
Parameters :
parent
Description : Required. The resource name of the Location to create the NotebookExecutionJob. Format: `projects/{project}/locations/{location}`
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
notebookExecutionJobId
Description : Optional. User specified ID for the NotebookExecutionJob.
Location : query
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Creates a NotebookExecutionJob.
▼ ▲ aiplatform.projects.locations.notebookExecutionJobs.get
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs/{notebookExecutionJobsId}
HTTP Method : GET
Parameters :
name
Description : Required. The name of the NotebookExecutionJob resource.
Pattern : ^projects/[^/]+/locations/[^/]+/notebookExecutionJobs/[^/]+$
Location : path
Required : Yes
Type : string
view
Description : Optional. The NotebookExecutionJob view. Defaults to BASIC.
Location : query
Type : string
Enum Descriptions :
Enum :
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets a NotebookExecutionJob.
▼ ▲ aiplatform.projects.locations.notebookExecutionJobs.list
Path : v1beta1/{+parent}/notebookExecutionJobs
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs
HTTP Method : GET
Parameters :
parent
Description : Required. The resource name of the Location from which to list the NotebookExecutionJobs. Format: `projects/{project}/locations/{location}`
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
filter
Description : Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `notebookExecutionJob` supports = and !=. `notebookExecutionJob` represents the NotebookExecutionJob ID. * `displayName` supports = and != and regex. * `schedule` supports = and != and regex. Some examples: * `notebookExecutionJob="123"` * `notebookExecutionJob="my-execution-job"` * `displayName="myDisplayName"` and `displayName=~"myDisplayNameRegex"`
Location : query
Type : string
pageSize
Description : Optional. The standard list page size.
Location : query
Type : integer
Format : int32
pageToken
Description : Optional. The standard list page token. Typically obtained via ListNotebookExecutionJobsResponse.next_page_token of the previous NotebookService.ListNotebookExecutionJobs call.
Location : query
Type : string
orderBy
Description : Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `display_name` * `create_time` * `update_time` Example: `display_name, create_time desc`.
Location : query
Type : string
view
Description : Optional. The NotebookExecutionJob view. Defaults to BASIC.
Location : query
Type : string
Enum Descriptions :
Enum :
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists NotebookExecutionJobs in a Location.
▼ ▲ aiplatform.projects.locations.notebookExecutionJobs.delete
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs/{notebookExecutionJobsId}
HTTP Method : DELETE
Parameters :
name
Description : Required. The name of the NotebookExecutionJob resource to be deleted.
Pattern : ^projects/[^/]+/locations/[^/]+/notebookExecutionJobs/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Deletes a NotebookExecutionJob.
▼ ▲ aiplatform.projects.locations.notebookExecutionJobs.operations.list
Path : v1beta1/{+name}/operations
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs/{notebookExecutionJobsId}/operations
HTTP Method : GET
Parameters :
name
Description : The name of the operation's parent resource.
Pattern : ^projects/[^/]+/locations/[^/]+/notebookExecutionJobs/[^/]+$
Location : path
Required : Yes
Type : string
filter
Description : The standard list filter.
Location : query
Type : string
pageSize
Description : The standard list page size.
Location : query
Type : integer
Format : int32
pageToken
Description : The standard list page token.
Location : query
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
▼ ▲ aiplatform.projects.locations.notebookExecutionJobs.operations.get
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs/{notebookExecutionJobsId}/operations/{operationsId}
HTTP Method : GET
Parameters :
name
Description : The name of the operation resource.
Pattern : ^projects/[^/]+/locations/[^/]+/notebookExecutionJobs/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
▼ ▲ aiplatform.projects.locations.notebookExecutionJobs.operations.delete
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs/{notebookExecutionJobsId}/operations/{operationsId}
HTTP Method : DELETE
Parameters :
name
Description : The name of the operation resource to be deleted.
Pattern : ^projects/[^/]+/locations/[^/]+/notebookExecutionJobs/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
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`.
▼ ▲ aiplatform.projects.locations.notebookExecutionJobs.operations.cancel
Path : v1beta1/{+name}:cancel
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs/{notebookExecutionJobsId}/operations/{operationsId}:cancel
HTTP Method : POST
Parameters :
name
Description : The name of the operation resource to be cancelled.
Pattern : ^projects/[^/]+/locations/[^/]+/notebookExecutionJobs/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
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`.
▼ ▲ aiplatform.projects.locations.notebookExecutionJobs.operations.wait
Path : v1beta1/{+name}:wait
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs/{notebookExecutionJobsId}/operations/{operationsId}:wait
HTTP Method : POST
Parameters :
name
Description : The name of the operation resource to wait on.
Pattern : ^projects/[^/]+/locations/[^/]+/notebookExecutionJobs/[^/]+/operations/[^/]+$
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.
Location : query
Type : string
Format : google-duration
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.
▼ ▲ aiplatform.projects.locations.persistentResources.create
Path : v1beta1/{+parent}/persistentResources
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/persistentResources
HTTP Method : POST
Parameters :
parent
Description : Required. The resource name of the Location to create the PersistentResource in. Format: `projects/{project}/locations/{location}`
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
persistentResourceId
Description : Required. The ID to use for the PersistentResource, which become the final component of the PersistentResource's resource name. The maximum length is 63 characters, and valid characters are `/^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$/`.
Location : query
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Creates a PersistentResource.
▼ ▲ aiplatform.projects.locations.persistentResources.get
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}
HTTP Method : GET
Parameters :
name
Description : Required. The name of the PersistentResource resource. Format: `projects/{project_id_or_number}/locations/{location_id}/persistentResources/{persistent_resource_id}`
Pattern : ^projects/[^/]+/locations/[^/]+/persistentResources/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets a PersistentResource.
▼ ▲ aiplatform.projects.locations.persistentResources.list
Path : v1beta1/{+parent}/persistentResources
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/persistentResources
HTTP Method : GET
Parameters :
parent
Description : Required. The resource name of the Location to list the PersistentResources from. Format: `projects/{project}/locations/{location}`
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
pageSize
Description : Optional. The standard list page size.
Location : query
Type : integer
Format : int32
pageToken
Description : Optional. The standard list page token. Typically obtained via ListPersistentResourcesResponse.next_page_token of the previous PersistentResourceService.ListPersistentResource call.
Location : query
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists PersistentResources in a Location.
▼ ▲ aiplatform.projects.locations.persistentResources.delete
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}
HTTP Method : DELETE
Parameters :
name
Description : Required. The name of the PersistentResource to be deleted. Format: `projects/{project}/locations/{location}/persistentResources/{persistent_resource}`
Pattern : ^projects/[^/]+/locations/[^/]+/persistentResources/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Deletes a PersistentResource.
▼ ▲ aiplatform.projects.locations.persistentResources.patch
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}
HTTP Method : PATCH
Parameters :
name
Description : Immutable. Resource name of a PersistentResource.
Pattern : ^projects/[^/]+/locations/[^/]+/persistentResources/[^/]+$
Location : path
Required : Yes
Type : string
updateMask
Description : Required. Specify the fields to be overwritten in the PersistentResource by the update method.
Location : query
Type : string
Format : google-fieldmask
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Updates a PersistentResource.
▼ ▲ aiplatform.projects.locations.persistentResources.reboot
Path : v1beta1/{+name}:reboot
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}:reboot
HTTP Method : POST
Parameters :
name
Description : Required. The name of the PersistentResource resource. Format: `projects/{project_id_or_number}/locations/{location_id}/persistentResources/{persistent_resource_id}`
Pattern : ^projects/[^/]+/locations/[^/]+/persistentResources/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Reboots a PersistentResource.
▼ ▲ aiplatform.projects.locations.persistentResources.operations.list
Path : v1beta1/{+name}/operations
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}/operations
HTTP Method : GET
Parameters :
name
Description : The name of the operation's parent resource.
Pattern : ^projects/[^/]+/locations/[^/]+/persistentResources/[^/]+$
Location : path
Required : Yes
Type : string
filter
Description : The standard list filter.
Location : query
Type : string
pageSize
Description : The standard list page size.
Location : query
Type : integer
Format : int32
pageToken
Description : The standard list page token.
Location : query
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
▼ ▲ aiplatform.projects.locations.persistentResources.operations.get
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}/operations/{operationsId}
HTTP Method : GET
Parameters :
name
Description : The name of the operation resource.
Pattern : ^projects/[^/]+/locations/[^/]+/persistentResources/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
▼ ▲ aiplatform.projects.locations.persistentResources.operations.delete
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}/operations/{operationsId}
HTTP Method : DELETE
Parameters :
name
Description : The name of the operation resource to be deleted.
Pattern : ^projects/[^/]+/locations/[^/]+/persistentResources/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
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`.
▼ ▲ aiplatform.projects.locations.persistentResources.operations.cancel
Path : v1beta1/{+name}:cancel
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}/operations/{operationsId}:cancel
HTTP Method : POST
Parameters :
name
Description : The name of the operation resource to be cancelled.
Pattern : ^projects/[^/]+/locations/[^/]+/persistentResources/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
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`.
▼ ▲ aiplatform.projects.locations.persistentResources.operations.wait
Path : v1beta1/{+name}:wait
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}/operations/{operationsId}:wait
HTTP Method : POST
Parameters :
name
Description : The name of the operation resource to wait on.
Pattern : ^projects/[^/]+/locations/[^/]+/persistentResources/[^/]+/operations/[^/]+$
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.
Location : query
Type : string
Format : google-duration
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.
▼ ▲ aiplatform.projects.locations.trainingPipelines.create
Path : v1beta1/{+parent}/trainingPipelines
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/trainingPipelines
HTTP Method : POST
Parameters :
parent
Description : Required. The resource name of the Location to create the TrainingPipeline in. Format: `projects/{project}/locations/{location}`
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Creates a TrainingPipeline. A created TrainingPipeline right away will be attempted to be run.
▼ ▲ aiplatform.projects.locations.trainingPipelines.get
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}
HTTP Method : GET
Parameters :
name
Description : Required. The name of the TrainingPipeline resource. Format: `projects/{project}/locations/{location}/trainingPipelines/{training_pipeline}`
Pattern : ^projects/[^/]+/locations/[^/]+/trainingPipelines/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets a TrainingPipeline.
▼ ▲ aiplatform.projects.locations.trainingPipelines.list
Path : v1beta1/{+parent}/trainingPipelines
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/trainingPipelines
HTTP Method : GET
Parameters :
parent
Description : Required. The resource name of the Location to list the TrainingPipelines from. Format: `projects/{project}/locations/{location}`
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
filter
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*"`
Location : query
Type : string
pageSize
Description : The standard list page size.
Location : query
Type : integer
Format : int32
pageToken
Description : The standard list page token. Typically obtained via ListTrainingPipelinesResponse.next_page_token of the previous PipelineService.ListTrainingPipelines call.
Location : query
Type : string
readMask
Description : Mask specifying which fields to read.
Location : query
Type : string
Format : google-fieldmask
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists TrainingPipelines in a Location.
▼ ▲ aiplatform.projects.locations.trainingPipelines.delete
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}
HTTP Method : DELETE
Parameters :
name
Description : Required. The name of the TrainingPipeline resource to be deleted. Format: `projects/{project}/locations/{location}/trainingPipelines/{training_pipeline}`
Pattern : ^projects/[^/]+/locations/[^/]+/trainingPipelines/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Deletes a TrainingPipeline.
▼ ▲ aiplatform.projects.locations.trainingPipelines.cancel
Path : v1beta1/{+name}:cancel
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}:cancel
HTTP Method : POST
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
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Cancels a TrainingPipeline. Starts asynchronous cancellation on the TrainingPipeline. The server makes a best effort to cancel the pipeline, but success is not guaranteed. Clients can use PipelineService.GetTrainingPipeline or other methods to check whether the cancellation succeeded or whether the pipeline completed despite cancellation. On successful cancellation, the TrainingPipeline is not deleted; instead it becomes a pipeline with a TrainingPipeline.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`, and TrainingPipeline.state is set to `CANCELLED`.
▼ ▲ aiplatform.projects.locations.trainingPipelines.operations.list
Path : v1beta1/{+name}/operations
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}/operations
HTTP Method : GET
Parameters :
name
Description : The name of the operation's parent resource.
Pattern : ^projects/[^/]+/locations/[^/]+/trainingPipelines/[^/]+$
Location : path
Required : Yes
Type : string
filter
Description : The standard list filter.
Location : query
Type : string
pageSize
Description : The standard list page size.
Location : query
Type : integer
Format : int32
pageToken
Description : The standard list page token.
Location : query
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
▼ ▲ aiplatform.projects.locations.trainingPipelines.operations.get
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}/operations/{operationsId}
HTTP Method : GET
Parameters :
name
Description : The name of the operation resource.
Pattern : ^projects/[^/]+/locations/[^/]+/trainingPipelines/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
▼ ▲ aiplatform.projects.locations.trainingPipelines.operations.delete
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}/operations/{operationsId}
HTTP Method : DELETE
Parameters :
name
Description : The name of the operation resource to be deleted.
Pattern : ^projects/[^/]+/locations/[^/]+/trainingPipelines/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
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`.
▼ ▲ aiplatform.projects.locations.trainingPipelines.operations.cancel
Path : v1beta1/{+name}:cancel
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}/operations/{operationsId}:cancel
HTTP Method : POST
Parameters :
name
Description : The name of the operation resource to be cancelled.
Pattern : ^projects/[^/]+/locations/[^/]+/trainingPipelines/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
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`.
▼ ▲ aiplatform.projects.locations.trainingPipelines.operations.wait
Path : v1beta1/{+name}:wait
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}/operations/{operationsId}:wait
HTTP Method : POST
Parameters :
name
Description : The name of the operation resource to wait on.
Pattern : ^projects/[^/]+/locations/[^/]+/trainingPipelines/[^/]+/operations/[^/]+$
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.
Location : query
Type : string
Format : google-duration
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.
▼ ▲ aiplatform.projects.locations.pipelineJobs.create
Path : v1beta1/{+parent}/pipelineJobs
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/pipelineJobs
HTTP Method : POST
Parameters :
parent
Description : Required. The resource name of the Location to create the PipelineJob in. Format: `projects/{project}/locations/{location}`
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
pipelineJobId
Description : The ID to use for the PipelineJob, which will become the final component of the PipelineJob name. If not provided, an ID will be automatically generated. This value should be less than 128 characters, and valid characters are `/a-z-/`.
Location : query
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Creates a PipelineJob. A PipelineJob will run immediately when created.
▼ ▲ aiplatform.projects.locations.pipelineJobs.get
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/pipelineJobs/{pipelineJobsId}
HTTP Method : GET
Parameters :
name
Description : Required. The name of the PipelineJob resource. Format: `projects/{project}/locations/{location}/pipelineJobs/{pipeline_job}`
Pattern : ^projects/[^/]+/locations/[^/]+/pipelineJobs/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets a PipelineJob.
▼ ▲ aiplatform.projects.locations.pipelineJobs.list
Path : v1beta1/{+parent}/pipelineJobs
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/pipelineJobs
HTTP Method : GET
Parameters :
parent
Description : Required. The resource name of the Location to list the PipelineJobs from. Format: `projects/{project}/locations/{location}`
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
filter
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".
Location : query
Type : string
pageSize
Description : The standard list page size.
Location : query
Type : integer
Format : int32
pageToken
Description : The standard list page token. Typically obtained via ListPipelineJobsResponse.next_page_token of the previous PipelineService.ListPipelineJobs call.
Location : query
Type : string
orderBy
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`
Location : query
Type : string
readMask
Description : Mask specifying which fields to read.
Location : query
Type : string
Format : google-fieldmask
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists PipelineJobs in a Location.
▼ ▲ aiplatform.projects.locations.pipelineJobs.delete
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/pipelineJobs/{pipelineJobsId}
HTTP Method : DELETE
Parameters :
name
Description : Required. The name of the PipelineJob resource to be deleted. Format: `projects/{project}/locations/{location}/pipelineJobs/{pipeline_job}`
Pattern : ^projects/[^/]+/locations/[^/]+/pipelineJobs/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Deletes a PipelineJob.
▼ ▲ aiplatform.projects.locations.pipelineJobs.batchDelete
Path : v1beta1/{+parent}/pipelineJobs:batchDelete
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/pipelineJobs:batchDelete
HTTP Method : POST
Parameters :
parent
Description : Required. The name of the PipelineJobs' parent resource. Format: `projects/{project}/locations/{location}`
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Batch deletes PipelineJobs The Operation is atomic. If it fails, none of the PipelineJobs are deleted. If it succeeds, all of the PipelineJobs are deleted.
▼ ▲ aiplatform.projects.locations.pipelineJobs.cancel
Path : v1beta1/{+name}:cancel
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/pipelineJobs/{pipelineJobsId}:cancel
HTTP Method : POST
Parameters :
name
Description : Required. The name of the PipelineJob to cancel. Format: `projects/{project}/locations/{location}/pipelineJobs/{pipeline_job}`
Pattern : ^projects/[^/]+/locations/[^/]+/pipelineJobs/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
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`.
▼ ▲ aiplatform.projects.locations.pipelineJobs.batchCancel
Path : v1beta1/{+parent}/pipelineJobs:batchCancel
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/pipelineJobs:batchCancel
HTTP Method : POST
Parameters :
parent
Description : Required. The name of the PipelineJobs' parent resource. Format: `projects/{project}/locations/{location}`
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Batch cancel PipelineJobs. Firstly the server will check if all the jobs are in non-terminal states, and skip the jobs that are already terminated. If the operation failed, none of the pipeline jobs are cancelled. The server will poll the states of all the pipeline jobs periodically to check the cancellation status. This operation will return an LRO.
▼ ▲ aiplatform.projects.locations.pipelineJobs.operations.list
Path : v1beta1/{+name}/operations
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/pipelineJobs/{pipelineJobsId}/operations
HTTP Method : GET
Parameters :
name
Description : The name of the operation's parent resource.
Pattern : ^projects/[^/]+/locations/[^/]+/pipelineJobs/[^/]+$
Location : path
Required : Yes
Type : string
filter
Description : The standard list filter.
Location : query
Type : string
pageSize
Description : The standard list page size.
Location : query
Type : integer
Format : int32
pageToken
Description : The standard list page token.
Location : query
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
▼ ▲ aiplatform.projects.locations.pipelineJobs.operations.get
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/pipelineJobs/{pipelineJobsId}/operations/{operationsId}
HTTP Method : GET
Parameters :
name
Description : The name of the operation resource.
Pattern : ^projects/[^/]+/locations/[^/]+/pipelineJobs/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
▼ ▲ aiplatform.projects.locations.pipelineJobs.operations.delete
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/pipelineJobs/{pipelineJobsId}/operations/{operationsId}
HTTP Method : DELETE
Parameters :
name
Description : The name of the operation resource to be deleted.
Pattern : ^projects/[^/]+/locations/[^/]+/pipelineJobs/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
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`.
▼ ▲ aiplatform.projects.locations.pipelineJobs.operations.cancel
Path : v1beta1/{+name}:cancel
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/pipelineJobs/{pipelineJobsId}/operations/{operationsId}:cancel
HTTP Method : POST
Parameters :
name
Description : The name of the operation resource to be cancelled.
Pattern : ^projects/[^/]+/locations/[^/]+/pipelineJobs/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
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`.
▼ ▲ aiplatform.projects.locations.pipelineJobs.operations.wait
Path : v1beta1/{+name}:wait
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/pipelineJobs/{pipelineJobsId}/operations/{operationsId}:wait
HTTP Method : POST
Parameters :
name
Description : The name of the operation resource to wait on.
Pattern : ^projects/[^/]+/locations/[^/]+/pipelineJobs/[^/]+/operations/[^/]+$
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.
Location : query
Type : string
Format : google-duration
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.
▼ ▲ aiplatform.projects.locations.reasoningEngines.query
Path : v1beta1/{+name}:query
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}:query
HTTP Method : POST
Parameters :
name
Description : Required. The name of the ReasoningEngine resource to use. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`
Pattern : ^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Queries using a reasoning engine.
▼ ▲ aiplatform.projects.locations.reasoningEngines.streamQuery
Path : v1beta1/{+name}:streamQuery
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}:streamQuery
HTTP Method : POST
Parameters :
name
Description : Required. The name of the ReasoningEngine resource to use. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`
Pattern : ^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Streams queries using a reasoning engine.
▼ ▲ aiplatform.projects.locations.reasoningEngines.create
Path : v1beta1/{+parent}/reasoningEngines
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines
HTTP Method : POST
Parameters :
parent
Description : Required. The resource name of the Location to create the ReasoningEngine in. Format: `projects/{project}/locations/{location}`
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Creates a reasoning engine.
▼ ▲ aiplatform.projects.locations.reasoningEngines.get
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}
HTTP Method : GET
Parameters :
name
Description : Required. The name of the ReasoningEngine resource. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`
Pattern : ^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets a reasoning engine.
▼ ▲ aiplatform.projects.locations.reasoningEngines.list
Path : v1beta1/{+parent}/reasoningEngines
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines
HTTP Method : GET
Parameters :
parent
Description : Required. The resource name of the Location to list the ReasoningEngines from. Format: `projects/{project}/locations/{location}`
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
filter
Description : Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160).
Location : query
Type : string
pageSize
Description : Optional. The standard list page size.
Location : query
Type : integer
Format : int32
pageToken
Description : Optional. The standard list page token.
Location : query
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists reasoning engines in a location.
▼ ▲ aiplatform.projects.locations.reasoningEngines.patch
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}
HTTP Method : PATCH
Parameters :
name
Description : Identifier. The resource name of the ReasoningEngine.
Pattern : ^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$
Location : path
Required : Yes
Type : string
updateMask
Description : Optional. Mask specifying which fields to update.
Location : query
Type : string
Format : google-fieldmask
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Updates a reasoning engine.
▼ ▲ aiplatform.projects.locations.reasoningEngines.delete
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}
HTTP Method : DELETE
Parameters :
name
Description : Required. The name of the ReasoningEngine resource to be deleted. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`
Pattern : ^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Deletes a reasoning engine.
▼ ▲ aiplatform.projects.locations.reasoningEngines.operations.list
Path : v1beta1/{+name}/operations
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/operations
HTTP Method : GET
Parameters :
name
Description : The name of the operation's parent resource.
Pattern : ^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$
Location : path
Required : Yes
Type : string
filter
Description : The standard list filter.
Location : query
Type : string
pageSize
Description : The standard list page size.
Location : query
Type : integer
Format : int32
pageToken
Description : The standard list page token.
Location : query
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
▼ ▲ aiplatform.projects.locations.reasoningEngines.operations.get
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/operations/{operationsId}
HTTP Method : GET
Parameters :
name
Description : The name of the operation resource.
Pattern : ^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
▼ ▲ aiplatform.projects.locations.reasoningEngines.operations.delete
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/operations/{operationsId}
HTTP Method : DELETE
Parameters :
name
Description : The name of the operation resource to be deleted.
Pattern : ^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
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`.
▼ ▲ aiplatform.projects.locations.reasoningEngines.operations.cancel
Path : v1beta1/{+name}:cancel
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/operations/{operationsId}:cancel
HTTP Method : POST
Parameters :
name
Description : The name of the operation resource to be cancelled.
Pattern : ^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
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`.
▼ ▲ aiplatform.projects.locations.reasoningEngines.operations.wait
Path : v1beta1/{+name}:wait
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/operations/{operationsId}:wait
HTTP Method : POST
Parameters :
name
Description : The name of the operation resource to wait on.
Pattern : ^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/operations/[^/]+$
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.
Location : query
Type : string
Format : google-duration
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.
▼ ▲ aiplatform.projects.locations.schedules.create
Path : v1beta1/{+parent}/schedules
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/schedules
HTTP Method : POST
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
Required : Yes
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Creates a Schedule.
▼ ▲ aiplatform.projects.locations.schedules.delete
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}
HTTP Method : DELETE
Parameters :
name
Description : Required. The name of the Schedule resource to be deleted. Format: `projects/{project}/locations/{location}/schedules/{schedule}`
Pattern : ^projects/[^/]+/locations/[^/]+/schedules/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Deletes a Schedule.
▼ ▲ aiplatform.projects.locations.schedules.get
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}
HTTP Method : GET
Parameters :
name
Description : Required. The name of the Schedule resource. Format: `projects/{project}/locations/{location}/schedules/{schedule}`
Pattern : ^projects/[^/]+/locations/[^/]+/schedules/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets a Schedule.
▼ ▲ aiplatform.projects.locations.schedules.list
Path : v1beta1/{+parent}/schedules
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/schedules
HTTP Method : GET
Parameters :
parent
Description : Required. The resource name of the Location to list the Schedules from. Format: `projects/{project}/locations/{location}`
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
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:*`
Location : query
Type : string
pageSize
Description : The standard list page size. Default to 100 if not specified.
Location : query
Type : integer
Format : int32
pageToken
Description : The standard list page token. Typically obtained via ListSchedulesResponse.next_page_token of the previous ScheduleService.ListSchedules call.
Location : query
Type : string
orderBy
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`
Location : query
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists Schedules in a Location.
▼ ▲ aiplatform.projects.locations.schedules.pause
Path : v1beta1/{+name}:pause
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}:pause
HTTP Method : POST
Parameters :
name
Description : Required. The name of the Schedule resource to be paused. Format: `projects/{project}/locations/{location}/schedules/{schedule}`
Pattern : ^projects/[^/]+/locations/[^/]+/schedules/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
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.
▼ ▲ aiplatform.projects.locations.schedules.resume
Path : v1beta1/{+name}:resume
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}:resume
HTTP Method : POST
Parameters :
name
Description : Required. The name of the Schedule resource to be resumed. Format: `projects/{project}/locations/{location}/schedules/{schedule}`
Pattern : ^projects/[^/]+/locations/[^/]+/schedules/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
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.catch_up is set up true, all missed runs will be scheduled for backfill first.
▼ ▲ aiplatform.projects.locations.schedules.patch
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}
HTTP Method : PATCH
Parameters :
name
Description : Immutable. The resource name of the Schedule.
Pattern : ^projects/[^/]+/locations/[^/]+/schedules/[^/]+$
Location : path
Required : Yes
Type : string
updateMask
Description : Required. The update mask applies to the resource. See google.protobuf.FieldMask.
Location : query
Type : string
Format : google-fieldmask
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
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.
▼ ▲ aiplatform.projects.locations.schedules.operations.list
Path : v1beta1/{+name}/operations
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}/operations
HTTP Method : GET
Parameters :
name
Description : The name of the operation's parent resource.
Pattern : ^projects/[^/]+/locations/[^/]+/schedules/[^/]+$
Location : path
Required : Yes
Type : string
filter
Description : The standard list filter.
Location : query
Type : string
pageSize
Description : The standard list page size.
Location : query
Type : integer
Format : int32
pageToken
Description : The standard list page token.
Location : query
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
▼ ▲ aiplatform.projects.locations.schedules.operations.get
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}/operations/{operationsId}
HTTP Method : GET
Parameters :
name
Description : The name of the operation resource.
Pattern : ^projects/[^/]+/locations/[^/]+/schedules/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
▼ ▲ aiplatform.projects.locations.schedules.operations.delete
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}/operations/{operationsId}
HTTP Method : DELETE
Parameters :
name
Description : The name of the operation resource to be deleted.
Pattern : ^projects/[^/]+/locations/[^/]+/schedules/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
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`.
▼ ▲ aiplatform.projects.locations.schedules.operations.cancel
Path : v1beta1/{+name}:cancel
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}/operations/{operationsId}:cancel
HTTP Method : POST
Parameters :
name
Description : The name of the operation resource to be cancelled.
Pattern : ^projects/[^/]+/locations/[^/]+/schedules/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
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`.
▼ ▲ aiplatform.projects.locations.schedules.operations.wait
Path : v1beta1/{+name}:wait
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}/operations/{operationsId}:wait
HTTP Method : POST
Parameters :
name
Description : The name of the operation resource to wait on.
Pattern : ^projects/[^/]+/locations/[^/]+/schedules/[^/]+/operations/[^/]+$
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.
Location : query
Type : string
Format : google-duration
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.
▼ ▲ aiplatform.projects.locations.specialistPools.create
Path : v1beta1/{+parent}/specialistPools
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/specialistPools
HTTP Method : POST
Parameters :
parent
Description : Required. The parent Project name for the new SpecialistPool. The form is `projects/{project}/locations/{location}`.
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Creates a SpecialistPool.
▼ ▲ aiplatform.projects.locations.specialistPools.get
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}
HTTP Method : GET
Parameters :
name
Description : Required. The name of the SpecialistPool resource. The form is `projects/{project}/locations/{location}/specialistPools/{specialist_pool}`.
Pattern : ^projects/[^/]+/locations/[^/]+/specialistPools/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets a SpecialistPool.
▼ ▲ aiplatform.projects.locations.specialistPools.list
Path : v1beta1/{+parent}/specialistPools
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/specialistPools
HTTP Method : GET
Parameters :
parent
Description : Required. The name of the SpecialistPool's parent resource. Format: `projects/{project}/locations/{location}`
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
pageSize
Description : The standard list page size.
Location : query
Type : integer
Format : int32
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.
Location : query
Type : string
readMask
Description : Mask specifying which fields to read. FieldMask represents a set of
Location : query
Type : string
Format : google-fieldmask
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists SpecialistPools in a Location.
▼ ▲ aiplatform.projects.locations.specialistPools.delete
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}
HTTP Method : DELETE
Parameters :
name
Description : Required. The resource name of the SpecialistPool to delete. Format: `projects/{project}/locations/{location}/specialistPools/{specialist_pool}`
Pattern : ^projects/[^/]+/locations/[^/]+/specialistPools/[^/]+$
Location : path
Required : Yes
Type : string
force
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
Type : boolean
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Deletes a SpecialistPool as well as all Specialists in the pool.
▼ ▲ aiplatform.projects.locations.specialistPools.patch
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}
HTTP Method : PATCH
Parameters :
name
Description : Required. The resource name of the SpecialistPool.
Pattern : ^projects/[^/]+/locations/[^/]+/specialistPools/[^/]+$
Location : path
Required : Yes
Type : string
updateMask
Description : Required. The update mask applies to the resource.
Location : query
Type : string
Format : google-fieldmask
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Updates a SpecialistPool.
▼ ▲ aiplatform.projects.locations.specialistPools.operations.list
Path : v1beta1/{+name}/operations
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}/operations
HTTP Method : GET
Parameters :
name
Description : The name of the operation's parent resource.
Pattern : ^projects/[^/]+/locations/[^/]+/specialistPools/[^/]+$
Location : path
Required : Yes
Type : string
filter
Description : The standard list filter.
Location : query
Type : string
pageSize
Description : The standard list page size.
Location : query
Type : integer
Format : int32
pageToken
Description : The standard list page token.
Location : query
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
▼ ▲ aiplatform.projects.locations.specialistPools.operations.get
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}/operations/{operationsId}
HTTP Method : GET
Parameters :
name
Description : The name of the operation resource.
Pattern : ^projects/[^/]+/locations/[^/]+/specialistPools/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
▼ ▲ aiplatform.projects.locations.specialistPools.operations.delete
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}/operations/{operationsId}
HTTP Method : DELETE
Parameters :
name
Description : The name of the operation resource to be deleted.
Pattern : ^projects/[^/]+/locations/[^/]+/specialistPools/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
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`.
▼ ▲ aiplatform.projects.locations.specialistPools.operations.cancel
Path : v1beta1/{+name}:cancel
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}/operations/{operationsId}:cancel
HTTP Method : POST
Parameters :
name
Description : The name of the operation resource to be cancelled.
Pattern : ^projects/[^/]+/locations/[^/]+/specialistPools/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
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`.
▼ ▲ aiplatform.projects.locations.specialistPools.operations.wait
Path : v1beta1/{+name}:wait
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}/operations/{operationsId}:wait
HTTP Method : POST
Parameters :
name
Description : The name of the operation resource to wait on.
Pattern : ^projects/[^/]+/locations/[^/]+/specialistPools/[^/]+/operations/[^/]+$
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.
Location : query
Type : string
Format : google-duration
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.
▼ ▲ aiplatform.projects.locations.tensorboards.create
Path : v1beta1/{+parent}/tensorboards
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards
HTTP Method : POST
Parameters :
parent
Description : Required. The resource name of the Location to create the Tensorboard in. Format: `projects/{project}/locations/{location}`
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Creates a Tensorboard.
▼ ▲ aiplatform.projects.locations.tensorboards.get
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}
HTTP Method : GET
Parameters :
name
Description : Required. The name of the Tensorboard resource. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`
Pattern : ^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets a Tensorboard.
▼ ▲ aiplatform.projects.locations.tensorboards.patch
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}
HTTP Method : PATCH
Parameters :
name
Description : Output only. Name of the Tensorboard. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`
Pattern : ^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+$
Location : path
Required : Yes
Type : string
updateMask
Description : Required. Field mask is used to specify the fields to be overwritten in the Tensorboard resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it's in the mask. If the user does not provide a mask then all fields are overwritten if new values are specified.
Location : query
Type : string
Format : google-fieldmask
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Updates a Tensorboard.
▼ ▲ aiplatform.projects.locations.tensorboards.list
Path : v1beta1/{+parent}/tensorboards
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards
HTTP Method : GET
Parameters :
parent
Description : Required. The resource name of the Location to list Tensorboards. Format: `projects/{project}/locations/{location}`
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
filter
Description : Lists the Tensorboards that match the filter expression.
Location : query
Type : string
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.
Location : query
Type : integer
Format : int32
pageToken
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.
Location : query
Type : string
orderBy
Description : Field to use to sort the list.
Location : query
Type : string
readMask
Description : Mask specifying which fields to read.
Location : query
Type : string
Format : google-fieldmask
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists Tensorboards in a Location.
▼ ▲ aiplatform.projects.locations.tensorboards.delete
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}
HTTP Method : DELETE
Parameters :
name
Description : Required. The name of the Tensorboard to be deleted. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`
Pattern : ^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Deletes a Tensorboard.
▼ ▲ aiplatform.projects.locations.tensorboards.readUsage
Path : v1beta1/{+tensorboard}:readUsage
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}:readUsage
HTTP Method : GET
Parameters :
tensorboard
Description : Required. The name of the Tensorboard resource. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`
Pattern : ^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : tensorboard
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Returns a list of monthly active users for a given TensorBoard instance.
▼ ▲ aiplatform.projects.locations.tensorboards.readSize
Path : v1beta1/{+tensorboard}:readSize
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}:readSize
HTTP Method : GET
Parameters :
tensorboard
Description : Required. The name of the Tensorboard resource. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`
Pattern : ^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : tensorboard
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Returns the storage size for a given TensorBoard instance.
▼ ▲ aiplatform.projects.locations.tensorboards.batchRead
Path : v1beta1/{+tensorboard}:batchRead
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}:batchRead
HTTP Method : GET
Parameters :
tensorboard
Description : Required. The resource name of the Tensorboard containing TensorboardTimeSeries to read data from. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`. The TensorboardTimeSeries referenced by time_series must be sub resources of this Tensorboard.
Pattern : ^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+$
Location : path
Required : Yes
Type : string
timeSeries
Description : Required. The resource names of the TensorboardTimeSeries to read data from. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}`
Location : query
Repeated : Yes
Type : string
Parameter Order : tensorboard
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.
▼ ▲ aiplatform.projects.locations.tensorboards.operations.list
Path : v1beta1/{+name}/operations
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/operations
HTTP Method : GET
Parameters :
name
Description : The name of the operation's parent resource.
Pattern : ^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+$
Location : path
Required : Yes
Type : string
filter
Description : The standard list filter.
Location : query
Type : string
pageSize
Description : The standard list page size.
Location : query
Type : integer
Format : int32
pageToken
Description : The standard list page token.
Location : query
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
▼ ▲ aiplatform.projects.locations.tensorboards.operations.get
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/operations/{operationsId}
HTTP Method : GET
Parameters :
name
Description : The name of the operation resource.
Pattern : ^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
▼ ▲ aiplatform.projects.locations.tensorboards.operations.delete
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/operations/{operationsId}
HTTP Method : DELETE
Parameters :
name
Description : The name of the operation resource to be deleted.
Pattern : ^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
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`.
▼ ▲ aiplatform.projects.locations.tensorboards.operations.cancel
Path : v1beta1/{+name}:cancel
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/operations/{operationsId}:cancel
HTTP Method : POST
Parameters :
name
Description : The name of the operation resource to be cancelled.
Pattern : ^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
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`.
▼ ▲ aiplatform.projects.locations.tensorboards.operations.wait
Path : v1beta1/{+name}:wait
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/operations/{operationsId}:wait
HTTP Method : POST
Parameters :
name
Description : The name of the operation resource to wait on.
Pattern : ^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/operations/[^/]+$
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.
Location : query
Type : string
Format : google-duration
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.
▼ ▲ aiplatform.projects.locations.tensorboards.experiments.create
Path : v1beta1/{+parent}/experiments
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments
HTTP Method : POST
Parameters :
parent
Description : Required. The resource name of the Tensorboard to create the TensorboardExperiment in. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`
Pattern : ^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+$
Location : path
Required : Yes
Type : string
tensorboardExperimentId
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
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Creates a TensorboardExperiment.
▼ ▲ aiplatform.projects.locations.tensorboards.experiments.get
Path : v1beta1/{+name}
Flat Path : v1beta1/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
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets a TensorboardExperiment.
▼ ▲ aiplatform.projects.locations.tensorboards.experiments.patch
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}
HTTP Method : PATCH
Parameters :
name
Description : Output only. Name of the TensorboardExperiment. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}`
Pattern : ^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+$
Location : path
Required : Yes
Type : string
updateMask
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.
Location : query
Type : string
Format : google-fieldmask
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Updates a TensorboardExperiment.
▼ ▲ aiplatform.projects.locations.tensorboards.experiments.list
Path : v1beta1/{+parent}/experiments
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments
HTTP Method : GET
Parameters :
parent
Description : Required. The resource name of the Tensorboard to list TensorboardExperiments. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`
Pattern : ^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+$
Location : path
Required : Yes
Type : string
filter
Description : Lists the TensorboardExperiments that match the filter expression.
Location : query
Type : string
pageSize
Description : The maximum number of TensorboardExperiments to return. The service may return fewer than this value. If unspecified, at most 50 TensorboardExperiments are returned. The maximum value is 1000; values above 1000 are coerced to 1000.
Location : query
Type : integer
Format : int32
pageToken
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.
Location : query
Type : string
orderBy
Description : Field to use to sort the list.
Location : query
Type : string
readMask
Description : Mask specifying which fields to read.
Location : query
Type : string
Format : google-fieldmask
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists TensorboardExperiments in a Location.
▼ ▲ aiplatform.projects.locations.tensorboards.experiments.delete
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}
HTTP Method : DELETE
Parameters :
name
Description : Required. The name of the TensorboardExperiment to be deleted. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}`
Pattern : ^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Deletes a TensorboardExperiment.
▼ ▲ aiplatform.projects.locations.tensorboards.experiments.batchCreate
Path : v1beta1/{+parent}:batchCreate
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}:batchCreate
HTTP Method : POST
Parameters :
parent
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
Required : Yes
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Batch create TensorboardTimeSeries that belong to a TensorboardExperiment.
▼ ▲ aiplatform.projects.locations.tensorboards.experiments.write
Path : v1beta1/{+tensorboardExperiment}:write
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}:write
HTTP Method : POST
Parameters :
tensorboardExperiment
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/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : tensorboardExperiment
Scopes : https://www.googleapis.com/auth/cloud-platform
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.list
Path : v1beta1/{+name}/operations
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/operations
HTTP Method : GET
Parameters :
name
Description : The name of the operation's parent resource.
Pattern : ^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+$
Location : path
Required : Yes
Type : string
filter
Description : The standard list filter.
Location : query
Type : string
pageSize
Description : The standard list page size.
Location : query
Type : integer
Format : int32
pageToken
Description : The standard list page token.
Location : query
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
▼ ▲ aiplatform.projects.locations.tensorboards.experiments.operations.get
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/operations/{operationsId}
HTTP Method : GET
Parameters :
name
Description : The name of the operation resource.
Pattern : ^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
▼ ▲ aiplatform.projects.locations.tensorboards.experiments.operations.delete
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/operations/{operationsId}
HTTP Method : DELETE
Parameters :
name
Description : The name of the operation resource to be deleted.
Pattern : ^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
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`.
▼ ▲ aiplatform.projects.locations.tensorboards.experiments.operations.cancel
Path : v1beta1/{+name}:cancel
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/operations/{operationsId}:cancel
HTTP Method : POST
Parameters :
name
Description : The name of the operation resource to be cancelled.
Pattern : ^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
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`.
▼ ▲ aiplatform.projects.locations.tensorboards.experiments.operations.wait
Path : v1beta1/{+name}:wait
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/operations/{operationsId}:wait
HTTP Method : POST
Parameters :
name
Description : The name of the operation resource to wait on.
Pattern : ^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/operations/[^/]+$
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.
Location : query
Type : string
Format : google-duration
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.
▼ ▲ aiplatform.projects.locations.tensorboards.experiments.runs.create
Path : v1beta1/{+parent}/runs
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs
HTTP Method : POST
Parameters :
parent
Description : Required. The resource name of the TensorboardExperiment to create the TensorboardRun in. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}`
Pattern : ^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+$
Location : path
Required : Yes
Type : string
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-/`.
Location : query
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Creates a TensorboardRun.
▼ ▲ aiplatform.projects.locations.tensorboards.experiments.runs.batchCreate
Path : v1beta1/{+parent}/runs:batchCreate
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs:batchCreate
HTTP Method : POST
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.
Pattern : ^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Batch create TensorboardRuns.
▼ ▲ aiplatform.projects.locations.tensorboards.experiments.runs.get
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}
HTTP Method : GET
Parameters :
name
Description : Required. The name of the TensorboardRun resource. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}`
Pattern : ^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets a TensorboardRun.
▼ ▲ aiplatform.projects.locations.tensorboards.experiments.runs.patch
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}
HTTP Method : PATCH
Parameters :
name
Description : Output only. Name of the TensorboardRun. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}`
Pattern : ^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+$
Location : path
Required : Yes
Type : string
updateMask
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
Type : string
Format : google-fieldmask
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Updates a TensorboardRun.
▼ ▲ aiplatform.projects.locations.tensorboards.experiments.runs.list
Path : v1beta1/{+parent}/runs
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs
HTTP Method : GET
Parameters :
parent
Description : Required. The resource name of the TensorboardExperiment to list TensorboardRuns. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}`
Pattern : ^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+$
Location : path
Required : Yes
Type : string
filter
Description : Lists the TensorboardRuns that match the filter expression.
Location : query
Type : string
pageSize
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.
Location : query
Type : integer
Format : int32
pageToken
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.
Location : query
Type : string
orderBy
Description : Field to use to sort the list.
Location : query
Type : string
readMask
Description : Mask specifying which fields to read.
Location : query
Type : string
Format : google-fieldmask
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists TensorboardRuns in a Location.
▼ ▲ aiplatform.projects.locations.tensorboards.experiments.runs.delete
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}
HTTP Method : DELETE
Parameters :
name
Description : Required. The name of the TensorboardRun to be deleted. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}`
Pattern : ^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Deletes a TensorboardRun.
▼ ▲ aiplatform.projects.locations.tensorboards.experiments.runs.write
Path : v1beta1/{+tensorboardRun}:write
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}:write
HTTP Method : POST
Parameters :
tensorboardRun
Description : Required. The resource name of the TensorboardRun to write data to. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}`
Pattern : ^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : tensorboardRun
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Write time series data points into multiple TensorboardTimeSeries under a TensorboardRun. If any data fail to be ingested, an error is returned.
▼ ▲ aiplatform.projects.locations.tensorboards.experiments.runs.operations.list
Path : v1beta1/{+name}/operations
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/operations
HTTP Method : GET
Parameters :
name
Description : The name of the operation's parent resource.
Pattern : ^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+$
Location : path
Required : Yes
Type : string
filter
Description : The standard list filter.
Location : query
Type : string
pageSize
Description : The standard list page size.
Location : query
Type : integer
Format : int32
pageToken
Description : The standard list page token.
Location : query
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
▼ ▲ aiplatform.projects.locations.tensorboards.experiments.runs.operations.get
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/operations/{operationsId}
HTTP Method : GET
Parameters :
name
Description : The name of the operation resource.
Pattern : ^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
▼ ▲ aiplatform.projects.locations.tensorboards.experiments.runs.operations.delete
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/operations/{operationsId}
HTTP Method : DELETE
Parameters :
name
Description : The name of the operation resource to be deleted.
Pattern : ^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
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`.
▼ ▲ aiplatform.projects.locations.tensorboards.experiments.runs.operations.cancel
Path : v1beta1/{+name}:cancel
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/operations/{operationsId}:cancel
HTTP Method : POST
Parameters :
name
Description : The name of the operation resource to be cancelled.
Pattern : ^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
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`.
▼ ▲ aiplatform.projects.locations.tensorboards.experiments.runs.operations.wait
Path : v1beta1/{+name}:wait
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/operations/{operationsId}:wait
HTTP Method : POST
Parameters :
name
Description : The name of the operation resource to wait on.
Pattern : ^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/operations/[^/]+$
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.
Location : query
Type : string
Format : google-duration
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.
▼ ▲ aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.create
Path : v1beta1/{+parent}/timeSeries
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries
HTTP Method : POST
Parameters :
parent
Description : Required. The resource name of the TensorboardRun to create the TensorboardTimeSeries in. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}`
Pattern : ^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+$
Location : path
Required : Yes
Type : string
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}"
Location : query
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Creates a TensorboardTimeSeries.
▼ ▲ aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.get
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}
HTTP Method : GET
Parameters :
name
Description : Required. The name of the TensorboardTimeSeries resource. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}`
Pattern : ^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets a TensorboardTimeSeries.
▼ ▲ aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.patch
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}
HTTP Method : PATCH
Parameters :
name
Description : Output only. Name of the TensorboardTimeSeries.
Pattern : ^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+$
Location : path
Required : Yes
Type : string
updateMask
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.
Location : query
Type : string
Format : google-fieldmask
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Updates a TensorboardTimeSeries.
▼ ▲ aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.list
Path : v1beta1/{+parent}/timeSeries
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries
HTTP Method : GET
Parameters :
parent
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
Required : Yes
Type : string
filter
Description : Lists the TensorboardTimeSeries that match the filter expression.
Location : query
Type : string
pageSize
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.
Location : query
Type : integer
Format : int32
pageToken
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
Type : string
orderBy
Description : Field to use to sort the list.
Location : query
Type : string
readMask
Description : Mask specifying which fields to read.
Location : query
Type : string
Format : google-fieldmask
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists TensorboardTimeSeries in a Location.
▼ ▲ aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.delete
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}
HTTP Method : DELETE
Parameters :
name
Description : Required. The name of the TensorboardTimeSeries to be deleted. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}`
Pattern : ^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Deletes a TensorboardTimeSeries.
▼ ▲ aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.read
Path : v1beta1/{+tensorboardTimeSeries}:read
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}:read
HTTP Method : GET
Parameters :
tensorboardTimeSeries
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/[^/]+$
Location : path
Required : Yes
Type : string
maxDataPoints
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
Type : integer
Format : int32
filter
Description : Reads the TensorboardTimeSeries' data that match the filter expression.
Location : query
Type : string
Parameter Order : tensorboardTimeSeries
Scopes : https://www.googleapis.com/auth/cloud-platform
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.
▼ ▲ aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.readBlobData
Path : v1beta1/{+timeSeries}:readBlobData
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}:readBlobData
HTTP Method : GET
Parameters :
timeSeries
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}`
Pattern : ^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+$
Location : path
Required : Yes
Type : string
blobIds
Description : IDs of the blobs to read.
Location : query
Repeated : Yes
Type : string
Parameter Order : timeSeries
Scopes : https://www.googleapis.com/auth/cloud-platform
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.
▼ ▲ aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.exportTensorboardTimeSeries
Path : v1beta1/{+tensorboardTimeSeries}:exportTensorboardTimeSeries
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}:exportTensorboardTimeSeries
HTTP Method : POST
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}`
Pattern : ^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : tensorboardTimeSeries
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Exports a TensorboardTimeSeries' data. Data is returned in paginated responses.
▼ ▲ aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.operations.list
Path : v1beta1/{+name}/operations
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}/operations
HTTP Method : GET
Parameters :
name
Description : The name of the operation's parent resource.
Pattern : ^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+$
Location : path
Required : Yes
Type : string
filter
Description : The standard list filter.
Location : query
Type : string
pageSize
Description : The standard list page size.
Location : query
Type : integer
Format : int32
pageToken
Description : The standard list page token.
Location : query
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
▼ ▲ aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.operations.get
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}/operations/{operationsId}
HTTP Method : GET
Parameters :
name
Description : The name of the operation resource.
Pattern : ^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
▼ ▲ aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.operations.delete
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}/operations/{operationsId}
HTTP Method : DELETE
Parameters :
name
Description : The name of the operation resource to be deleted.
Pattern : ^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
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`.
▼ ▲ aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.operations.cancel
Path : v1beta1/{+name}:cancel
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}/operations/{operationsId}:cancel
HTTP Method : POST
Parameters :
name
Description : The name of the operation resource to be cancelled.
Pattern : ^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
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`.
▼ ▲ aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.operations.wait
Path : v1beta1/{+name}:wait
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}/operations/{operationsId}:wait
HTTP Method : POST
Parameters :
name
Description : The name of the operation resource to wait on.
Pattern : ^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+/operations/[^/]+$
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.
Location : query
Type : string
Format : google-duration
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.
▼ ▲ aiplatform.projects.locations.studies.create
Path : v1beta1/{+parent}/studies
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/studies
HTTP Method : POST
Parameters :
parent
Description : Required. The resource name of the Location to create the CustomJob in. Format: `projects/{project}/locations/{location}`
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Creates a Study. A resource name will be generated after creation of the Study.
▼ ▲ aiplatform.projects.locations.studies.get
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}
HTTP Method : GET
Parameters :
name
Description : Required. The name of the Study resource. Format: `projects/{project}/locations/{location}/studies/{study}`
Pattern : ^projects/[^/]+/locations/[^/]+/studies/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets a Study by name.
▼ ▲ aiplatform.projects.locations.studies.list
Path : v1beta1/{+parent}/studies
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/studies
HTTP Method : GET
Parameters :
parent
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
Type : string
pageToken
Description : Optional. A page token to request the next page of results. If unspecified, there are no subsequent pages.
Location : query
Type : string
pageSize
Description : Optional. The maximum number of studies to return per "page" of results. If unspecified, service will pick an appropriate default.
Location : query
Type : integer
Format : int32
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists all the studies in a region for an associated project.
▼ ▲ aiplatform.projects.locations.studies.delete
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}
HTTP Method : DELETE
Parameters :
name
Description : Required. The name of the Study resource to be deleted. Format: `projects/{project}/locations/{location}/studies/{study}`
Pattern : ^projects/[^/]+/locations/[^/]+/studies/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Deletes a Study.
▼ ▲ aiplatform.projects.locations.studies.lookup
Path : v1beta1/{+parent}/studies:lookup
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/studies:lookup
HTTP Method : POST
Parameters :
parent
Description : Required. The resource name of the Location to get the Study from. Format: `projects/{project}/locations/{location}`
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Looks a study up using the user-defined display_name field instead of the fully qualified resource name.
▼ ▲ aiplatform.projects.locations.studies.operations.list
Path : v1beta1/{+name}/operations
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/operations
HTTP Method : GET
Parameters :
name
Description : The name of the operation's parent resource.
Pattern : ^projects/[^/]+/locations/[^/]+/studies/[^/]+$
Location : path
Required : Yes
Type : string
filter
Description : The standard list filter.
Location : query
Type : string
pageSize
Description : The standard list page size.
Location : query
Type : integer
Format : int32
pageToken
Description : The standard list page token.
Location : query
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
▼ ▲ aiplatform.projects.locations.studies.operations.get
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/operations/{operationsId}
HTTP Method : GET
Parameters :
name
Description : The name of the operation resource.
Pattern : ^projects/[^/]+/locations/[^/]+/studies/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
▼ ▲ aiplatform.projects.locations.studies.operations.delete
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/operations/{operationsId}
HTTP Method : DELETE
Parameters :
name
Description : The name of the operation resource to be deleted.
Pattern : ^projects/[^/]+/locations/[^/]+/studies/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
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`.
▼ ▲ aiplatform.projects.locations.studies.operations.cancel
Path : v1beta1/{+name}:cancel
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/operations/{operationsId}:cancel
HTTP Method : POST
Parameters :
name
Description : The name of the operation resource to be cancelled.
Pattern : ^projects/[^/]+/locations/[^/]+/studies/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
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`.
▼ ▲ aiplatform.projects.locations.studies.operations.wait
Path : v1beta1/{+name}:wait
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/operations/{operationsId}:wait
HTTP Method : POST
Parameters :
name
Description : The name of the operation resource to wait on.
Pattern : ^projects/[^/]+/locations/[^/]+/studies/[^/]+/operations/[^/]+$
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.
Location : query
Type : string
Format : google-duration
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.
▼ ▲ aiplatform.projects.locations.studies.trials.suggest
Path : v1beta1/{+parent}/trials:suggest
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials:suggest
HTTP Method : POST
Parameters :
parent
Description : Required. The project and location that the Study belongs to. Format: `projects/{project}/locations/{location}/studies/{study}`
Pattern : ^projects/[^/]+/locations/[^/]+/studies/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
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.
▼ ▲ aiplatform.projects.locations.studies.trials.create
Path : v1beta1/{+parent}/trials
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials
HTTP Method : POST
Parameters :
parent
Description : Required. The resource name of the Study to create the Trial in. Format: `projects/{project}/locations/{location}/studies/{study}`
Pattern : ^projects/[^/]+/locations/[^/]+/studies/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Adds a user provided Trial to a Study.
▼ ▲ aiplatform.projects.locations.studies.trials.get
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}
HTTP Method : GET
Parameters :
name
Description : Required. The name of the Trial resource. Format: `projects/{project}/locations/{location}/studies/{study}/trials/{trial}`
Pattern : ^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets a Trial.
▼ ▲ aiplatform.projects.locations.studies.trials.list
Path : v1beta1/{+parent}/trials
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials
HTTP Method : GET
Parameters :
parent
Description : Required. The resource name of the Study to list the Trial from. Format: `projects/{project}/locations/{location}/studies/{study}`
Pattern : ^projects/[^/]+/locations/[^/]+/studies/[^/]+$
Location : path
Required : Yes
Type : string
pageToken
Description : Optional. A page token to request the next page of results. If unspecified, there are no subsequent pages.
Location : query
Type : string
pageSize
Description : Optional. The number of Trials to retrieve per "page" of results. If unspecified, the service will pick an appropriate default.
Location : query
Type : integer
Format : int32
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists the Trials associated with a Study.
▼ ▲ aiplatform.projects.locations.studies.trials.addTrialMeasurement
Path : v1beta1/{+trialName}:addTrialMeasurement
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}:addTrialMeasurement
HTTP Method : POST
Parameters :
trialName
Description : Required. The name of the trial to add measurement. Format: `projects/{project}/locations/{location}/studies/{study}/trials/{trial}`
Pattern : ^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+$
Location : path
Required : Yes
Type : string
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.complete
Path : v1beta1/{+name}:complete
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}:complete
HTTP Method : POST
Parameters :
name
Description : Required. The Trial's name. Format: `projects/{project}/locations/{location}/studies/{study}/trials/{trial}`
Pattern : ^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Marks a Trial as complete.
▼ ▲ aiplatform.projects.locations.studies.trials.delete
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}
HTTP Method : DELETE
Parameters :
name
Description : Required. The Trial's name. Format: `projects/{project}/locations/{location}/studies/{study}/trials/{trial}`
Pattern : ^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Deletes a Trial.
▼ ▲ aiplatform.projects.locations.studies.trials.checkTrialEarlyStoppingState
Path : v1beta1/{+trialName}:checkTrialEarlyStoppingState
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}:checkTrialEarlyStoppingState
HTTP Method : POST
Parameters :
trialName
Description : Required. The Trial's name. Format: `projects/{project}/locations/{location}/studies/{study}/trials/{trial}`
Pattern : ^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : trialName
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Checks whether a Trial should stop or not. Returns a long-running operation. When the operation is successful, it will contain a CheckTrialEarlyStoppingStateResponse.
▼ ▲ aiplatform.projects.locations.studies.trials.stop
Path : v1beta1/{+name}:stop
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}:stop
HTTP Method : POST
Parameters :
name
Description : Required. The Trial's name. Format: `projects/{project}/locations/{location}/studies/{study}/trials/{trial}`
Pattern : ^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Stops a Trial.
▼ ▲ aiplatform.projects.locations.studies.trials.listOptimalTrials
Path : v1beta1/{+parent}/trials:listOptimalTrials
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials:listOptimalTrials
HTTP Method : POST
Parameters :
parent
Description : Required. The name of the Study that the optimal Trial belongs to.
Pattern : ^projects/[^/]+/locations/[^/]+/studies/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
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
▼ ▲ aiplatform.projects.locations.studies.trials.operations.list
Path : v1beta1/{+name}/operations
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}/operations
HTTP Method : GET
Parameters :
name
Description : The name of the operation's parent resource.
Pattern : ^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+$
Location : path
Required : Yes
Type : string
filter
Description : The standard list filter.
Location : query
Type : string
pageSize
Description : The standard list page size.
Location : query
Type : integer
Format : int32
pageToken
Description : The standard list page token.
Location : query
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
▼ ▲ aiplatform.projects.locations.studies.trials.operations.get
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}/operations/{operationsId}
HTTP Method : GET
Parameters :
name
Description : The name of the operation resource.
Pattern : ^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
▼ ▲ aiplatform.projects.locations.studies.trials.operations.delete
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}/operations/{operationsId}
HTTP Method : DELETE
Parameters :
name
Description : The name of the operation resource to be deleted.
Pattern : ^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
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`.
▼ ▲ aiplatform.projects.locations.studies.trials.operations.cancel
Path : v1beta1/{+name}:cancel
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}/operations/{operationsId}:cancel
HTTP Method : POST
Parameters :
name
Description : The name of the operation resource to be cancelled.
Pattern : ^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
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`.
▼ ▲ aiplatform.projects.locations.studies.trials.operations.wait
Path : v1beta1/{+name}:wait
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}/operations/{operationsId}:wait
HTTP Method : POST
Parameters :
name
Description : The name of the operation resource to wait on.
Pattern : ^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+/operations/[^/]+$
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.
Location : query
Type : string
Format : google-duration
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.
▼ ▲ aiplatform.projects.locations.ragCorpora.create
Path : v1beta1/{+parent}/ragCorpora
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora
HTTP Method : POST
Parameters :
parent
Description : Required. The resource name of the Location to create the RagCorpus in. Format: `projects/{project}/locations/{location}`
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Creates a RagCorpus.
▼ ▲ aiplatform.projects.locations.ragCorpora.patch
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}
HTTP Method : PATCH
Parameters :
name
Description : Output only. The resource name of the RagCorpus.
Pattern : ^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Updates a RagCorpus.
▼ ▲ aiplatform.projects.locations.ragCorpora.get
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}
HTTP Method : GET
Parameters :
name
Description : Required. The name of the RagCorpus resource. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}`
Pattern : ^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets a RagCorpus.
▼ ▲ aiplatform.projects.locations.ragCorpora.list
Path : v1beta1/{+parent}/ragCorpora
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora
HTTP Method : GET
Parameters :
parent
Description : Required. The resource name of the Location from which to list the RagCorpora. Format: `projects/{project}/locations/{location}`
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
pageSize
Description : Optional. The standard list page size.
Location : query
Type : integer
Format : int32
pageToken
Description : Optional. The standard list page token. Typically obtained via ListRagCorporaResponse.next_page_token of the previous VertexRagDataService.ListRagCorpora call.
Location : query
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists RagCorpora in a Location.
▼ ▲ aiplatform.projects.locations.ragCorpora.delete
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}
HTTP Method : DELETE
Parameters :
name
Description : Required. The name of the RagCorpus resource to be deleted. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}`
Pattern : ^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+$
Location : path
Required : Yes
Type : string
force
Description : Optional. If set to true, any RagFiles in this RagCorpus will also be deleted. Otherwise, the request will only work if the RagCorpus has no RagFiles.
Location : query
Type : boolean
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Deletes a RagCorpus.
▼ ▲ aiplatform.projects.locations.ragCorpora.operations.list
Path : v1beta1/{+name}/operations
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/operations
HTTP Method : GET
Parameters :
name
Description : The name of the operation's parent resource.
Pattern : ^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+$
Location : path
Required : Yes
Type : string
filter
Description : The standard list filter.
Location : query
Type : string
pageSize
Description : The standard list page size.
Location : query
Type : integer
Format : int32
pageToken
Description : The standard list page token.
Location : query
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
▼ ▲ aiplatform.projects.locations.ragCorpora.operations.get
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/operations/{operationsId}
HTTP Method : GET
Parameters :
name
Description : The name of the operation resource.
Pattern : ^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
▼ ▲ aiplatform.projects.locations.ragCorpora.operations.delete
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/operations/{operationsId}
HTTP Method : DELETE
Parameters :
name
Description : The name of the operation resource to be deleted.
Pattern : ^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
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`.
▼ ▲ aiplatform.projects.locations.ragCorpora.operations.cancel
Path : v1beta1/{+name}:cancel
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/operations/{operationsId}:cancel
HTTP Method : POST
Parameters :
name
Description : The name of the operation resource to be cancelled.
Pattern : ^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
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`.
▼ ▲ aiplatform.projects.locations.ragCorpora.operations.wait
Path : v1beta1/{+name}:wait
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/operations/{operationsId}:wait
HTTP Method : POST
Parameters :
name
Description : The name of the operation resource to wait on.
Pattern : ^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+/operations/[^/]+$
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.
Location : query
Type : string
Format : google-duration
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.
▼ ▲ aiplatform.projects.locations.ragCorpora.ragFiles.import
Path : v1beta1/{+parent}/ragFiles:import
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/ragFiles:import
HTTP Method : POST
Parameters :
parent
Description : Required. The name of the RagCorpus resource into which to import files. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}`
Pattern : ^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Import files from Google Cloud Storage or Google Drive into a RagCorpus.
▼ ▲ aiplatform.projects.locations.ragCorpora.ragFiles.get
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/ragFiles/{ragFilesId}
HTTP Method : GET
Parameters :
name
Description : Required. The name of the RagFile resource. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}/ragFiles/{rag_file}`
Pattern : ^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+/ragFiles/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets a RagFile.
▼ ▲ aiplatform.projects.locations.ragCorpora.ragFiles.list
Path : v1beta1/{+parent}/ragFiles
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/ragFiles
HTTP Method : GET
Parameters :
parent
Description : Required. The resource name of the RagCorpus from which to list the RagFiles. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}`
Pattern : ^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+$
Location : path
Required : Yes
Type : string
pageSize
Description : Optional. The standard list page size.
Location : query
Type : integer
Format : int32
pageToken
Description : Optional. The standard list page token. Typically obtained via ListRagFilesResponse.next_page_token of the previous VertexRagDataService.ListRagFiles call.
Location : query
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists RagFiles in a RagCorpus.
▼ ▲ aiplatform.projects.locations.ragCorpora.ragFiles.delete
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/ragFiles/{ragFilesId}
HTTP Method : DELETE
Parameters :
name
Description : Required. The name of the RagFile resource to be deleted. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}/ragFiles/{rag_file}`
Pattern : ^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+/ragFiles/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Deletes a RagFile.
▼ ▲ aiplatform.projects.locations.ragCorpora.ragFiles.operations.list
Path : v1beta1/{+name}/operations
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/ragFiles/{ragFilesId}/operations
HTTP Method : GET
Parameters :
name
Description : The name of the operation's parent resource.
Pattern : ^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+/ragFiles/[^/]+$
Location : path
Required : Yes
Type : string
filter
Description : The standard list filter.
Location : query
Type : string
pageSize
Description : The standard list page size.
Location : query
Type : integer
Format : int32
pageToken
Description : The standard list page token.
Location : query
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
▼ ▲ aiplatform.projects.locations.ragCorpora.ragFiles.operations.get
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/ragFiles/{ragFilesId}/operations/{operationsId}
HTTP Method : GET
Parameters :
name
Description : The name of the operation resource.
Pattern : ^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+/ragFiles/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
▼ ▲ aiplatform.projects.locations.ragCorpora.ragFiles.operations.delete
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/ragFiles/{ragFilesId}/operations/{operationsId}
HTTP Method : DELETE
Parameters :
name
Description : The name of the operation resource to be deleted.
Pattern : ^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+/ragFiles/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
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`.
▼ ▲ aiplatform.projects.locations.ragCorpora.ragFiles.operations.cancel
Path : v1beta1/{+name}:cancel
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/ragFiles/{ragFilesId}/operations/{operationsId}:cancel
HTTP Method : POST
Parameters :
name
Description : The name of the operation resource to be cancelled.
Pattern : ^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+/ragFiles/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
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`.
▼ ▲ aiplatform.projects.locations.ragCorpora.ragFiles.operations.wait
Path : v1beta1/{+name}:wait
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/ragFiles/{ragFilesId}/operations/{operationsId}:wait
HTTP Method : POST
Parameters :
name
Description : The name of the operation resource to wait on.
Pattern : ^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+/ragFiles/[^/]+/operations/[^/]+$
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.
Location : query
Type : string
Format : google-duration
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.
▼ ▲ aiplatform.datasets.create
Path : v1beta1/datasets
Flat Path : v1beta1/datasets
HTTP Method : POST
Parameters :
parent
Description : Required. The resource name of the Location to create the Dataset in. Format: `projects/{project}/locations/{location}`
Location : query
Type : string
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Creates a Dataset.
▼ ▲ aiplatform.datasets.get
Path : v1beta1/{+name}
Flat Path : v1beta1/datasets/{datasetsId}
HTTP Method : GET
Parameters :
name
Description : Required. The name of the Dataset resource.
Pattern : ^datasets/[^/]+$
Location : path
Required : Yes
Type : string
readMask
Description : Mask specifying which fields to read.
Location : query
Type : string
Format : google-fieldmask
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets a Dataset.
▼ ▲ aiplatform.datasets.patch
Path : v1beta1/{+name}
Flat Path : v1beta1/datasets/{datasetsId}
HTTP Method : PATCH
Parameters :
name
Description : Output only. Identifier. The resource name of the Dataset. Format: `projects/{project}/locations/{location}/datasets/{dataset}`
Pattern : ^datasets/[^/]+$
Location : path
Required : Yes
Type : string
updateMask
Description : Required. The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask. Updatable fields: * `display_name` * `description` * `labels`
Location : query
Type : string
Format : google-fieldmask
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Updates a Dataset.
▼ ▲ aiplatform.datasets.list
Path : v1beta1/datasets
Flat Path : v1beta1/datasets
HTTP Method : GET
Parameters :
parent
Description : Required. The name of the Dataset's parent resource. Format: `projects/{project}/locations/{location}`
Location : query
Type : string
filter
Description : An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `display_name`: supports = and != * `metadata_schema_uri`: supports = and != * `labels` supports general map functions that is: * `labels.key=value` - key:value equality * `labels.key:* or labels:key - key existence * A key including a space must be quoted. `labels."a key"`. Some examples: * `displayName="myDisplayName"` * `labels.myKey="myValue"`
Location : query
Type : string
pageSize
Description : The standard list page size.
Location : query
Type : integer
Format : int32
pageToken
Description : The standard list page token.
Location : query
Type : string
readMask
Description : Mask specifying which fields to read.
Location : query
Type : string
Format : google-fieldmask
orderBy
Description : A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `display_name` * `create_time` * `update_time`
Location : query
Type : string
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists Datasets in a Location.
▼ ▲ aiplatform.datasets.delete
Path : v1beta1/{+name}
Flat Path : v1beta1/datasets/{datasetsId}
HTTP Method : DELETE
Parameters :
name
Description : Required. The resource name of the Dataset to delete. Format: `projects/{project}/locations/{location}/datasets/{dataset}`
Pattern : ^datasets/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Deletes a Dataset.
▼ ▲ aiplatform.datasets.datasetVersions.create
Path : v1beta1/{+parent}/datasetVersions
Flat Path : v1beta1/datasets/{datasetsId}/datasetVersions
HTTP Method : POST
Parameters :
parent
Description : Required. The name of the Dataset resource. Format: `projects/{project}/locations/{location}/datasets/{dataset}`
Pattern : ^datasets/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Create a version from a Dataset.
▼ ▲ aiplatform.datasets.datasetVersions.patch
Path : v1beta1/{+name}
Flat Path : v1beta1/datasets/{datasetsId}/datasetVersions/{datasetVersionsId}
HTTP Method : PATCH
Parameters :
name
Description : Output only. Identifier. The resource name of the DatasetVersion. Format: `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}`
Pattern : ^datasets/[^/]+/datasetVersions/[^/]+$
Location : path
Required : Yes
Type : string
updateMask
Description : Required. The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask. Updatable fields: * `display_name`
Location : query
Type : string
Format : google-fieldmask
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Updates a DatasetVersion.
▼ ▲ aiplatform.datasets.datasetVersions.delete
Path : v1beta1/{+name}
Flat Path : v1beta1/datasets/{datasetsId}/datasetVersions/{datasetVersionsId}
HTTP Method : DELETE
Parameters :
name
Description : Required. The resource name of the Dataset version to delete. Format: `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}`
Pattern : ^datasets/[^/]+/datasetVersions/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Deletes a Dataset version.
▼ ▲ aiplatform.datasets.datasetVersions.get
Path : v1beta1/{+name}
Flat Path : v1beta1/datasets/{datasetsId}/datasetVersions/{datasetVersionsId}
HTTP Method : GET
Parameters :
name
Description : Required. The resource name of the Dataset version to delete. Format: `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}`
Pattern : ^datasets/[^/]+/datasetVersions/[^/]+$
Location : path
Required : Yes
Type : string
readMask
Description : Mask specifying which fields to read.
Location : query
Type : string
Format : google-fieldmask
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets a Dataset version.
▼ ▲ aiplatform.datasets.datasetVersions.list
Path : v1beta1/{+parent}/datasetVersions
Flat Path : v1beta1/datasets/{datasetsId}/datasetVersions
HTTP Method : GET
Parameters :
parent
Description : Required. The resource name of the Dataset to list DatasetVersions from. Format: `projects/{project}/locations/{location}/datasets/{dataset}`
Pattern : ^datasets/[^/]+$
Location : path
Required : Yes
Type : string
filter
Description : Optional. The standard list filter.
Location : query
Type : string
pageSize
Description : Optional. The standard list page size.
Location : query
Type : integer
Format : int32
pageToken
Description : Optional. The standard list page token.
Location : query
Type : string
readMask
Description : Optional. Mask specifying which fields to read.
Location : query
Type : string
Format : google-fieldmask
orderBy
Description : Optional. 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
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists DatasetVersions in a Dataset.
▼ ▲ aiplatform.datasets.datasetVersions.restore
Path : v1beta1/{+name}:restore
Flat Path : v1beta1/datasets/{datasetsId}/datasetVersions/{datasetVersionsId}:restore
HTTP Method : GET
Parameters :
name
Description : Required. The name of the DatasetVersion resource. Format: `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}`
Pattern : ^datasets/[^/]+/datasetVersions/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Restores a dataset version.
▼ ▲ aiplatform.endpoints.countTokens
Path : v1beta1/{+endpoint}:countTokens
Flat Path : v1beta1/endpoints/{endpointsId}:countTokens
HTTP Method : POST
Parameters :
endpoint
Description : Required. The name of the Endpoint requested to perform token counting. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`
Pattern : ^endpoints/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : endpoint
Scopes :
Description : Perform a token counting.
▼ ▲ aiplatform.endpoints.generateContent
Path : v1beta1/{+model}:generateContent
Flat Path : v1beta1/endpoints/{endpointsId}:generateContent
HTTP Method : POST
Parameters :
model
Description : Required. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`
Pattern : ^endpoints/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : model
Scopes :
Description : Generate content with multimodal inputs.
▼ ▲ aiplatform.endpoints.streamGenerateContent
Path : v1beta1/{+model}:streamGenerateContent
Flat Path : v1beta1/endpoints/{endpointsId}:streamGenerateContent
HTTP Method : POST
Parameters :
model
Description : Required. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`
Pattern : ^endpoints/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : model
Scopes :
Description : Generate content with multimodal inputs with streaming support.
▼ ▲ aiplatform.endpoints.computeTokens
Path : v1beta1/{+endpoint}:computeTokens
Flat Path : v1beta1/endpoints/{endpointsId}:computeTokens
HTTP Method : POST
Parameters :
endpoint
Description : Required. The name of the Endpoint requested to get lists of tokens and token ids.
Pattern : ^endpoints/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : endpoint
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Return a list of tokens based on the input text.
▼ ▲ aiplatform.publishers.models.countTokens
Path : v1beta1/{+endpoint}:countTokens
Flat Path : v1beta1/publishers/{publishersId}/models/{modelsId}:countTokens
HTTP Method : POST
Parameters :
endpoint
Description : Required. The name of the Endpoint requested to perform token counting. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`
Pattern : ^publishers/[^/]+/models/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : endpoint
Scopes :
Description : Perform a token counting.
▼ ▲ aiplatform.publishers.models.generateContent
Path : v1beta1/{+model}:generateContent
Flat Path : v1beta1/publishers/{publishersId}/models/{modelsId}:generateContent
HTTP Method : POST
Parameters :
model
Description : Required. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`
Pattern : ^publishers/[^/]+/models/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : model
Scopes :
Description : Generate content with multimodal inputs.
▼ ▲ aiplatform.publishers.models.streamGenerateContent
Path : v1beta1/{+model}:streamGenerateContent
Flat Path : v1beta1/publishers/{publishersId}/models/{modelsId}:streamGenerateContent
HTTP Method : POST
Parameters :
model
Description : Required. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`
Pattern : ^publishers/[^/]+/models/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : model
Scopes :
Description : Generate content with multimodal inputs with streaming support.
▼ ▲ aiplatform.publishers.models.computeTokens
Path : v1beta1/{+endpoint}:computeTokens
Flat Path : v1beta1/publishers/{publishersId}/models/{modelsId}:computeTokens
HTTP Method : POST
Parameters :
endpoint
Description : Required. The name of the Endpoint requested to get lists of tokens and token ids.
Pattern : ^publishers/[^/]+/models/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : endpoint
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Return a list of tokens based on the input text.
▼ ▲ aiplatform.publishers.models.get
Path : v1beta1/{+name}
Flat Path : v1beta1/publishers/{publishersId}/models/{modelsId}
HTTP Method : GET
Parameters :
name
Description : Required. The name of the PublisherModel resource. Format: `publishers/{publisher}/models/{publisher_model}`
Pattern : ^publishers/[^/]+/models/[^/]+$
Location : path
Required : Yes
Type : string
languageCode
Description : Optional. The IETF BCP-47 language code representing the language in which the publisher model's text information should be written in.
Location : query
Type : string
view
Description : Optional. PublisherModel view specifying which fields to read.
Location : query
Type : string
Enum Descriptions :
Enum :
isHuggingFaceModel
Description : Optional. Boolean indicates whether the requested model is a Hugging Face model.
Location : query
Type : boolean
huggingFaceToken
Description : Optional. Token used to access Hugging Face gated models.
Location : query
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets a Model Garden publisher model.
▼ ▲ aiplatform.publishers.models.list
Path : v1beta1/{+parent}/models
Flat Path : v1beta1/publishers/{publishersId}/models
HTTP Method : GET
Parameters :
parent
Description : Required. The name of the Publisher from which to list the PublisherModels. Format: `publishers/{publisher}`
Pattern : ^publishers/[^/]+$
Location : path
Required : Yes
Type : string
filter
Description : Optional. The standard list filter.
Location : query
Type : string
pageSize
Description : Optional. The standard list page size.
Location : query
Type : integer
Format : int32
pageToken
Description : Optional. The standard list page token. Typically obtained via ListPublisherModelsResponse.next_page_token of the previous ModelGardenService.ListPublisherModels call.
Location : query
Type : string
view
Description : Optional. PublisherModel view specifying which fields to read.
Location : query
Type : string
Enum Descriptions :
Enum :
orderBy
Description : Optional. 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
languageCode
Description : Optional. The IETF BCP-47 language code representing the language in which the publisher models' text information should be written in. If not set, by default English (en).
Location : query
Type : string
listAllVersions
Description : Optional. List all publisher model versions if the flag is set to true.
Location : query
Type : boolean
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists publisher models in Model Garden.
▼ ▲ aiplatform.media.upload
Path : v1beta1/{+parent}/ragFiles:upload
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/ragFiles:upload
HTTP Method : POST
Parameters :
parent
Description : Required. The name of the RagCorpus resource into which to upload the file. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}`
Pattern : ^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : parent
Supportsmediaupload : Yes
Mediaupload :
Accept : */*
Protocols :
Simple :
Multipart : Yes
Path : /upload/v1beta1/{+parent}/ragFiles:upload
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Upload a file into a RagCorpus.