Gcp/aiplatform

@swamp/gcp/aiplatformv2026.05.31.1· 2d agoMODELS

01README

Google Cloud aiplatform infrastructure models

02Release Notes

Updated: cachedcontents, notebookexecutionjobs, notebookruntimetemplates, reasoningengines_sandboxenvironmenttemplates, schedules

03Models64

batchpredictionjobs.tsv2026.05.26.1

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
completionStats?	object	no	Output only. The number of entities for which any error was encountered.
dedicatedResources?	object	no	The number of accelerators to attach to the machine. For accelerator optimized machine types (https://cloud.google.com/compute/docs/accelerator-optimized-machines), One may set the accelerator_count from 1 to N for machine with N GPUs. If accelerator_count is less than or equal to N / 2, Vertex will co-schedule the replicas of the model into the same VM to save cost. For example, if the machine type is a3-highgpu-8g, which has 8 H100 GPUs, one can set accelerator_count to 1 to 8. If accelerator_count is 1, 2, 3, or 4, Vertex will co-schedule 8, 4, 2, or 2 replicas of the model into the same VM to save cost. When co-scheduling, CPU, memory and storage on the VM will be distributed to replicas on the VM. For example, one can expect a co-scheduled replica requesting 2 GPUs out of a 8-GPU VM will receive 25% of the CPU, memory and storage of the VM. Note that the feature is not compatible with multihost_gpu_node_count. When multihost_gpu_node_count is set, the co-scheduling will not be enabled.
disableContainerLogging?	boolean	no	For custom-trained Models and AutoML Tabular Models, the container of the DeployedModel instances will send `stderr` and `stdout` streams to Cloud Logging by default. Please note that the logs incur cost, which are subject to [Cloud Logging pricing](https://cloud.google.com/logging/pricing). User can disable container logging by setting this flag to true.
displayName?	string	no	Required. The user-defined name of this BatchPredictionJob.
encryptionSpec?	object	no	Required. Resource name of the Cloud KMS key used to protect the resource. The Cloud KMS key must be in the same region as the resource. It must have the format `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`.
error?	object	no	The status code, which should be an enum value of google.rpc.Code.
explanationSpec?	object	no	Points to a YAML file stored on Google Cloud Storage describing the format of the feature attributions. The schema is defined as an OpenAPI 3.0.2 [Schema Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). AutoML tabular Models always have this field populated by Vertex AI. Note: The URI given on output may be different, including the URI scheme, than the one given on input. The output URI will point to a location where the user only has a read access.
generateExplanation?	boolean	no	Generate explanation with the batch prediction results. When set to `true`, the batch prediction output changes based on the `predictions_format` field of the BatchPredictionJob.output_config object: * `bigquery`: output includes a column named `explanation`. The value is a struct that conforms to the Explanation object. * `jsonl`: The JSON objects on each line include an additional entry keyed `explanation`. The value of the entry is a JSON object that conforms to the Explanation object. * `csv`: Generating explanations for CSV format is not supported. If this field is set to true, either the Model.explanation_spec or explanation_spec must be populated.
inputConfig?	object	no	Required. BigQuery URI to a table, up to 2000 characters long. Accepted forms: * BigQuery path. For example: `bq://projectId.bqDatasetId.bqTableId`.
instanceConfig?	object	no	Fields that will be excluded in the prediction instance that is sent to the Model. Excluded will be attached to the batch prediction output if key_field is not specified. When excluded_fields is populated, included_fields must be empty. The input must be JSONL with objects at each line, BigQuery or TfRecord.
labels?	record	no	The labels with user-defined metadata to organize BatchPredictionJobs. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels.
manualBatchTuningParameters?	object	no	Immutable. The number of the records (e.g. instances) of the operation given in each batch to a machine replica. Machine type, and size of a single record should be considered when setting this parameter, higher value speeds up the batch operation's execution, but too high value will result in a whole batch not fitting in a machine's memory, and the whole operation will fail. The default value is 64.
model?	string	no	The name of the Model resource that produces the predictions via this job, must share the same ancestor Location. Starting this job has no impact on any existing deployments of the Model and their resources. Exactly one of model, unmanaged_container_model, or endpoint must be set. The model resource name may contain version id or version alias to specify the version. Example: `projects/{project}/locations/{location}/models/{model}@2` or `projects/{project}/locations/{location}/models/{model}@golden` if no version is specified, the default version will be deployed. The model resource could also be a publisher model. Example: `publishers/{publisher}/models/{model}` or `projects/{project}/locations/{location}/publishers/{publisher}/models/{model}`
modelParameters?	string	no	The parameters that govern the predictions. The schema of the parameters may be specified via the Model's PredictSchemata's parameters_schema_uri.
outputConfig?	object	no	Required. BigQuery URI to a project or table, up to 2000 characters long. When only the project is specified, the Dataset and Table is created. When the full table reference is specified, the Dataset must exist and table must not exist. Accepted forms: * BigQuery path. For example: `bq://projectId` or `bq://projectId.bqDatasetId` or `bq://projectId.bqDatasetId.bqTableId`.
outputInfo?	object	no	Output only. The path of the BigQuery dataset created, in `bq://projectId.bqDatasetId` format, into which the prediction output is written.
resourcesConsumed?	object	no	Output only. The number of replica hours used. Note that many replicas may run in parallel, and additionally any given work may be queued for some time. Therefore this value is not strictly related to wall time.
serviceAccount?	string	no	The service account that the DeployedModel's container runs as. If not specified, a system generated one will be used, which has minimal permissions and the custom container, if used, may not have enough permission to access other Google Cloud resources. Users deploying the Model must have the `iam.serviceAccounts.actAs` permission on this service account.
unmanagedContainerModel?	object	no	The path to the directory containing the Model artifact and any of its supporting files.
parent?	string	no	Required. The resource name of the Location to create the BatchPredictionJob in. Format: `projects/{project}/locations/{location}`

fn create()

Create a batchPredictionJobs

fn get(identifier: string)

Get a batchPredictionJobs

Argument	Type	Required	Description
identifier	string	yes	The name of the batchPredictionJobs

fn sync()

Sync batchPredictionJobs state from GCP

fn list(filter?: string, pageSize?: number, parent?: string, readMask?: string, maxPages?: number)

List batchPredictionJobs resources

Argument	Type	Required	Description
filter?	string	no	The standard list filter. Supported fields: * `display_name` supports `=`, `!=` comparisons, and `:` wildcard. * `model_display_name` supports `=`, `!=` comparisons. * `state` supports `=`, `!=` comparisons. * `create_time` supports `=`, `!=`,`<`, `<=`,`>`, `>=` comparisons. `create_time` must be in RFC 3339 format. * `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* - key existence Some examples of using the filter are: * `state="JOB_STATE_SUCCEEDED" AND display_name:"my_job_"` `state!="JOB_STATE_FAILED" OR display_name="my_job"` * `NOT display_name="my_job"` * `create_time>"2021-05-18T00:00:00Z"` * `labels.keyA=valueA` * `labels.keyB:*`
pageSize?	number	no	The standard list page size.
parent?	string	no	Required. The resource name of the Location to list the BatchPredictionJobs from. Format: `projects/{project}/locations/{location}`
readMask?	string	no	Mask specifying which fields to read.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

cachedcontents.tsv2026.05.31.1

Global Arguments

Argument	Type	Required	Description
contents?	array	no	Required. Outcome of the code execution.
displayName?	string	no	Optional. Immutable. The user-generated meaningful display name of the cached content.
encryptionSpec?	object	no	Required. Resource name of the Cloud KMS key used to protect the resource. The Cloud KMS key must be in the same region as the resource. It must have the format `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`.
expireTime?	string	no	Timestamp of when this resource is considered expired. This is always provided on output, regardless of what was sent on input.
model?	string	no	Immutable. The name of the `Model` to use for cached content. Currently, only the published Gemini base models are supported, in form of projects/{PROJECT}/locations/{LOCATION}/publishers/google/models/{MODEL}
name?	string	no	Immutable. Identifier. The server-generated resource name of the cached content Format: projects/{project}/locations/{location}/cachedContents/{cached_content}
systemInstruction?	object	no	Required. Outcome of the code execution.
toolConfig?	object	no	Optional. Function names to call. Only set when the Mode is ANY. Function names should match FunctionDeclaration.name. With mode set to ANY, model will predict a function call from the set of function names provided.
tools?	array	no	Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool.
ttl?	string	no	Input only. The TTL for this resource. The expiration time is computed: now + TTL.
usageMetadata?	object	no	Duration of audio in seconds.
location?	string	no	The location for this resource (e.g., 'us', 'us-central1', 'europe-west1')

fn create()

Create a cachedContents

fn get(identifier: string)

Get a cachedContents

Argument	Type	Required	Description
identifier	string	yes	The name of the cachedContents

fn update()

Update cachedContents attributes

fn delete(identifier: string)

Delete the cachedContents

Argument	Type	Required	Description
identifier	string	yes	The name of the cachedContents

fn sync()

Sync cachedContents state from GCP

fn list(pageSize?: number, maxPages?: number)

List cachedContents resources

Argument	Type	Required	Description
pageSize?	number	no	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.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

customjobs.tsv2026.05.26.1

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
displayName?	string	no	Required. The display name of the CustomJob. The name can be up to 128 characters long and can consist of any UTF-8 characters.
encryptionSpec?	object	no	Required. Resource name of the Cloud KMS key used to protect the resource. The Cloud KMS key must be in the same region as the resource. It must have the format `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`.
error?	object	no	The status code, which should be an enum value of google.rpc.Code.
jobSpec?	object	no	Required. Google Cloud Storage URI to output directory. If the uri doesn't end with '/', a '/' will be automatically appended. The directory is created if it doesn't exist.
labels?	record	no	The labels with user-defined metadata to organize CustomJobs. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels.
location?	string	no	The location for this resource (e.g., 'us', 'us-central1', 'europe-west1')

fn create()

Create a customJobs

fn get(identifier: string)

Get a customJobs

Argument	Type	Required	Description
identifier	string	yes	The name of the customJobs

fn delete(identifier: string)

Delete the customJobs

Argument	Type	Required	Description
identifier	string	yes	The name of the customJobs

fn sync()

Sync customJobs state from GCP

fn list(filter?: string, pageSize?: number, readMask?: string, maxPages?: number)

List customJobs resources

Argument	Type	Required	Description
filter?	string	no	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:*`
pageSize?	number	no	The standard list page size.
readMask?	string	no	Mask specifying which fields to read.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

fn cancel()

cancel

datalabelingjobs.tsv2026.05.26.1

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
activeLearningConfig?	object	no	Max number of human labeled DataItems.
annotationLabels?	record	no	Labels to assign to annotations generated by this DataLabelingJob. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable.
currentSpend?	object	no	The three-letter currency code defined in ISO 4217.
datasets?	array	no	Required. Dataset resource names. Right now we only support labeling from a single Dataset. Format: `projects/{project}/locations/{location}/datasets/{dataset}`
displayName?	string	no	Required. The user-defined name of the DataLabelingJob. The name can be up to 128 characters long and can consist of any UTF-8 characters. Display name of a DataLabelingJob.
encryptionSpec?	object	no	Required. Resource name of the Cloud KMS key used to protect the resource. The Cloud KMS key must be in the same region as the resource. It must have the format `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`.
error?	object	no	The status code, which should be an enum value of google.rpc.Code.
inputs?	string	no	Required. Input config parameters for the DataLabelingJob.
inputsSchemaUri?	string	no	Required. Points to a YAML file stored on Google Cloud Storage describing the config for a specific type of DataLabelingJob. The schema files that can be used here are found in the https://storage.googleapis.com/google-cloud-aiplatform bucket in the /schema/datalabelingjob/inputs/ folder.
instructionUri?	string	no	Required. The Google Cloud Storage location of the instruction pdf. This pdf is shared with labelers, and provides detailed description on how to label DataItems in Datasets.
labelerCount?	number	no	Required. Number of labelers to work on each DataItem.
specialistPools?	array	no	The SpecialistPools' resource names associated with this job.
location?	string	no	The location for this resource (e.g., 'us', 'us-central1', 'europe-west1')

fn create()

Create a dataLabelingJobs

fn get(identifier: string)

Get a dataLabelingJobs

Argument	Type	Required	Description
identifier	string	yes	The name of the dataLabelingJobs

fn delete(identifier: string)

Delete the dataLabelingJobs

Argument	Type	Required	Description
identifier	string	yes	The name of the dataLabelingJobs

fn sync()

Sync dataLabelingJobs state from GCP

fn list(filter?: string, orderBy?: string, pageSize?: number, readMask?: string, maxPages?: number)

List dataLabelingJobs resources

Argument	Type	Required	Description
filter?	string	no	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:*`
orderBy?	string	no	A comma-separated list of fields to order by, sorted in ascending order by default. Use `desc` after a field name for descending.
pageSize?	number	no	The standard list page size.
readMask?	string	no	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.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

fn cancel()

cancel

datasets.tsv2026.05.26.1

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
description?	string	no	The description of the Dataset.
displayName?	string	no	Required. The user-defined name of the Dataset. The name can be up to 128 characters long and can consist of any UTF-8 characters.
encryptionSpec?	object	no	Required. Resource name of the Cloud KMS key used to protect the resource. The Cloud KMS key must be in the same region as the resource. It must have the format `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`.
metadata?	string	no	Required. Additional information about the Dataset.
metadataSchemaUri?	string	no	Required. Points to a YAML file stored on Google Cloud Storage describing additional information about the Dataset. The schema is defined as an OpenAPI 3.0.2 Schema Object. The schema files that can be used here are found in gs://google-cloud-aiplatform/schema/dataset/metadata/.
modelReference?	string	no	Optional. Reference to the public base model last used by the dataset. Only set for prompt datasets.
savedQueries?	array	no	Output only. Filters on the Annotations in the dataset.
parent?	string	no	Required. The resource name of the Location to create the Dataset in. Format: `projects/{project}/locations/{location}`

fn create()

Create a datasets

fn get(identifier: string)

Get a datasets

Argument	Type	Required	Description
identifier	string	yes	The name of the datasets

fn update()

Update datasets attributes

fn delete(identifier: string)

Delete the datasets

Argument	Type	Required	Description
identifier	string	yes	The name of the datasets

fn sync()

Sync datasets state from GCP

fn list(filter?: string, orderBy?: string, pageSize?: number, parent?: string, readMask?: string, maxPages?: number)

List datasets resources

Argument	Type	Required	Description
filter?	string	no	An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `display_name`: supports = and != * `metadata_schema_uri`: supports = and != * `labels` supports general map functions that is: * `labels.key=value` - key:value equality * `labels.key:* or labels:key - key existence * A key including a space must be quoted. `labels."a key"`. Some examples: * `displayName="myDisplayName"` * `labels.myKey="myValue"`
orderBy?	string	no	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`
pageSize?	number	no	The standard list page size.
parent?	string	no	Required. The name of the Dataset's parent resource. Format: `projects/{project}/locations/{location}`
readMask?	string	no	Mask specifying which fields to read.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

datasets_annotationspecs.tsv2026.05.26.1

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)

fn get(identifier: string)

Get a annotationSpecs

Argument	Type	Required	Description
identifier	string	yes	The name of the annotationSpecs

fn sync()

Sync annotationSpecs state from GCP

datasets_dataitems.tsv2026.05.26.1

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
location?	string	no	The location for this resource (e.g., 'us', 'us-central1', 'europe-west1')

fn get(identifier: string)

Get a dataItems

Argument	Type	Required	Description
identifier	string	yes	The name of the dataItems

fn sync()

Sync dataItems state from GCP

fn list(filter?: string, orderBy?: string, pageSize?: number, readMask?: string, maxPages?: number)

List dataItems resources

Argument	Type	Required	Description
filter?	string	no	The standard list filter.
orderBy?	string	no	A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending.
pageSize?	number	no	The standard list page size.
readMask?	string	no	Mask specifying which fields to read.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

datasets_dataitems_annotations.tsv2026.05.26.1

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
location?	string	no	The location for this resource (e.g., 'us', 'us-central1', 'europe-west1')

fn get(identifier: string)

Get a annotations

Argument	Type	Required	Description
identifier	string	yes	The name of the annotations

fn sync()

Sync annotations state from GCP

fn list(filter?: string, orderBy?: string, pageSize?: number, readMask?: string, maxPages?: number)

List annotations resources

Argument	Type	Required	Description
filter?	string	no	The standard list filter.
orderBy?	string	no	A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending.
pageSize?	number	no	The standard list page size.
readMask?	string	no	Mask specifying which fields to read.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

datasets_datasetversions.tsv2026.05.26.1

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
displayName?	string	no	The user-defined name of the DatasetVersion. The name can be up to 128 characters long and can consist of any UTF-8 characters.
location?	string	no	The location for this resource (e.g., 'us', 'us-central1', 'europe-west1')

fn create()

Create a datasetVersions

fn get(identifier: string)

Get a datasetVersions

Argument	Type	Required	Description
identifier	string	yes	The name of the datasetVersions

fn update()

Update datasetVersions attributes

fn delete(identifier: string)

Delete the datasetVersions

Argument	Type	Required	Description
identifier	string	yes	The name of the datasetVersions

fn sync()

Sync datasetVersions state from GCP

fn list(filter?: string, orderBy?: string, pageSize?: number, readMask?: string, maxPages?: number)

List datasetVersions resources

Argument	Type	Required	Description
filter?	string	no	Optional. The standard list filter.
orderBy?	string	no	Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending.
pageSize?	number	no	Optional. The standard list page size.
readMask?	string	no	Optional. Mask specifying which fields to read.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

fn restore()

restore

datasets_savedqueries.tsv2026.05.26.1

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
location?	string	no	The location for this resource (e.g., 'us', 'us-central1', 'europe-west1')

fn get(identifier: string)

Get a savedQueries

Argument	Type	Required	Description
identifier	string	yes	The name of the savedQueries

fn delete(identifier: string)

Delete the savedQueries

Argument	Type	Required	Description
identifier	string	yes	The name of the savedQueries

fn sync()

Sync savedQueries state from GCP

fn list(filter?: string, orderBy?: string, pageSize?: number, readMask?: string, maxPages?: number)

List savedQueries resources

Argument	Type	Required	Description
filter?	string	no	The standard list filter.
orderBy?	string	no	A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending.
pageSize?	number	no	The standard list page size.
readMask?	string	no	Mask specifying which fields to read.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

deploymentresourcepools.tsv2026.05.26.1

Global Arguments

Argument	Type	Required	Description
deploymentResourcePool?	object	no	Output only. Timestamp when this DeploymentResourcePool was created.
deploymentResourcePoolId?	string	no	Required. The ID to use for the DeploymentResourcePool, which will become the final component of the DeploymentResourcePool's resource name. The maximum length is 63 characters, and valid characters are `/^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$/`.
createTime?	string	no	Output only. Timestamp when this DeploymentResourcePool was created.
dedicatedResources?	object	no	Required. The resource metric name. Supported metrics: * For Online Prediction: * `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle` * `aiplatform.googleapis.com/prediction/online/cpu/utilization` * `aiplatform.googleapis.com/prediction/online/request_count` * `pubsub.googleapis.com/subscription/num_undelivered_messages` * `prometheus.googleapis.com/vertex_dcgm_fi_dev_gpu_util` * `prometheus.googleapis.com/vertex_vllm_gpu_cache_usage_perc` * `prometheus.googleapis.com/vertex_vllm_num_requests_waiting`
disableContainerLogging?	boolean	no	If the DeploymentResourcePool is deployed with custom-trained Models or AutoML Tabular Models, the container(s) of the DeploymentResourcePool will send `stderr` and `stdout` streams to Cloud Logging by default. Please note that the logs incur cost, which are subject to [Cloud Logging pricing](https://cloud.google.com/logging/pricing). User can disable container logging by setting this flag to true.
encryptionSpec?	object	no	Required. Resource name of the Cloud KMS key used to protect the resource. The Cloud KMS key must be in the same region as the resource. It must have the format `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`.
name?	string	no	Immutable. The resource name of the DeploymentResourcePool. Format: `projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}`
satisfiesPzi?	boolean	no	Output only. Reserved for future use.
satisfiesPzs?	boolean	no	Output only. Reserved for future use.
serviceAccount?	string	no	The service account that the DeploymentResourcePool's container(s) run as. Specify the email address of the service account. If this service account is not specified, the container(s) run as a service account that doesn't have access to the resource project. Users deploying the Models to this DeploymentResourcePool must have the `iam.serviceAccounts.actAs` permission on this service account.
location?	string	no	The location for this resource (e.g., 'us', 'us-central1', 'europe-west1')

fn create()

Create a deploymentResourcePools

fn get(identifier: string)

Get a deploymentResourcePools

Argument	Type	Required	Description
identifier	string	yes	The name of the deploymentResourcePools

fn update()

Update deploymentResourcePools attributes

fn delete(identifier: string)

Delete the deploymentResourcePools

Argument	Type	Required	Description
identifier	string	yes	The name of the deploymentResourcePools

fn sync()

Sync deploymentResourcePools state from GCP

fn list(pageSize?: number, maxPages?: number)

List deploymentResourcePools resources

Argument	Type	Required	Description
pageSize?	number	no	The maximum number of DeploymentResourcePools to return. The service may return fewer than this value.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

fn query_deployed_models()

query deployed models

endpoints.tsv2026.05.26.1

Global Arguments

Argument	Type	Required	Description
clientConnectionConfig?	object	no	Customizable online prediction request timeout.
dedicatedEndpointEnabled?	boolean	no	If true, the endpoint will be exposed through a dedicated DNS [Endpoint.dedicated_endpoint_dns]. Your request to the dedicated DNS will be isolated from other users' traffic and will have better performance and reliability. Note: Once you enabled dedicated endpoint, you won't be able to send request to the shared DNS {region}-aiplatform.googleapis.com. The limitation will be removed soon.
description?	string	no	The description of the Endpoint.
displayName?	string	no	Required. The display name of the Endpoint. The name can be up to 128 characters long and can consist of any UTF-8 characters.
encryptionSpec?	object	no	Required. Resource name of the Cloud KMS key used to protect the resource. The Cloud KMS key must be in the same region as the resource. It must have the format `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`.
gdcConfig?	object	no	GDC zone. A cluster will be designated for the Vertex AI workload in this zone.
genAiAdvancedFeaturesConfig?	object	no	If true, enable Retrieval Augmented Generation in ChatCompletion request. Once enabled, the endpoint will be identified as GenAI endpoint and Arthedain router will be used.
labels?	record	no	The labels with user-defined metadata to organize your Endpoints. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels.
name?	string	no	Identifier. The resource name of the Endpoint.
network?	string	no	Optional. The full name of the Google Compute Engine [network](https://cloud.google.com//compute/docs/networks-and-firewalls#networks) to which the Endpoint should be peered. Private services access must already be configured for the network. If left unspecified, the Endpoint is not peered with any network. Only one of the fields, network or enable_private_service_connect, can be set. [Format](https://cloud.google.com/compute/docs/reference/rest/v1/networks/insert): `projects/{project}/global/networks/{network}`. Where `{project}` is a project number, as in `12345`, and `{network}` is network name.
predictRequestResponseLoggingConfig?	object	no	Required. BigQuery URI to a project or table, up to 2000 characters long. When only the project is specified, the Dataset and Table is created. When the full table reference is specified, the Dataset must exist and table must not exist. Accepted forms: * BigQuery path. For example: `bq://projectId` or `bq://projectId.bqDatasetId` or `bq://projectId.bqDatasetId.bqTableId`.
privateServiceConnectConfig?	object	no	Required. If true, expose the IndexEndpoint via private service connect.
trafficSplit?	record	no	A map from a DeployedModel's ID to the percentage of this Endpoint's traffic that should be forwarded to that DeployedModel. If a DeployedModel's ID is not listed in this map, then it receives no traffic. The traffic percentage values must add up to 100, or map must be empty if the Endpoint is to not accept any traffic at a moment.
endpoint?	object	no	Customizable online prediction request timeout.
endpointId?	string	no	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?	string	no	The location for this resource (e.g., 'us', 'us-central1', 'europe-west1')

fn create()

Create a endpoints

fn get(identifier: string)

Get a endpoints

Argument	Type	Required	Description
identifier	string	yes	The name of the endpoints

fn update()

Update endpoints attributes

fn delete(identifier: string)

Delete the endpoints

Argument	Type	Required	Description
identifier	string	yes	The name of the endpoints

fn sync()

Sync endpoints state from GCP

fn list(filter?: string, gdcZone?: string, orderBy?: string, pageSize?: number, readMask?: string, maxPages?: number)

List endpoints resources

Argument	Type	Required	Description
filter?	string	no	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"`
gdcZone?	string	no	Optional. Configures the Google Distributed Cloud (GDC) environment for online prediction. Only set this field when the Endpoint is to be deployed in a GDC environment.
orderBy?	string	no	A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `display_name` * `create_time` * `update_time` Example: `display_name, create_time desc`.
pageSize?	number	no	Optional. The standard list page size.
readMask?	string	no	Optional. Mask specifying which fields to read.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

fn compute_tokens(contents?: any, instances?: any, model?: any)

compute tokens

Argument	Type	Required
contents?	any	no
instances?	any	no
model?	any	no

fn count_tokens(contents?: any, generationConfig?: any, instances?: any, model?: any, systemInstruction?: any, tools?: any)

count tokens

Argument	Type	Required
contents?	any	no
generationConfig?	any	no
instances?	any	no
model?	any	no
systemInstruction?	any	no
tools?	any	no

fn deploy_model(deployedModel?: any, trafficSplit?: any)

deploy model

Argument	Type	Required	Description
deployedModel?	any	no
trafficSplit?	any	no

fn direct_predict(inputs?: any, parameters?: any)

direct predict

Argument	Type	Required	Description
inputs?	any	no
parameters?	any	no

fn direct_raw_predict(input?: any, methodName?: any)

direct raw predict

Argument	Type	Required	Description
input?	any	no
methodName?	any	no

fn explain(deployedModelId?: any, explanationSpecOverride?: any, instances?: any, parameters?: any)

explain

Argument	Type	Required
deployedModelId?	any	no
explanationSpecOverride?	any	no
instances?	any	no
parameters?	any	no

fn fetch_predict_operation(operationName?: any)

fetch predict operation

Argument	Type	Required	Description
operationName?	any	no

fn generate_content(cachedContent?: any, contents?: any, generationConfig?: any, labels?: any, modelArmorConfig?: any, safetySettings?: any, systemInstruction?: any, toolConfig?: any, tools?: any)

generate content

Argument	Type	Required
cachedContent?	any	no
contents?	any	no
generationConfig?	any	no
labels?	any	no
modelArmorConfig?	any	no
safetySettings?	any	no
systemInstruction?	any	no
toolConfig?	any	no
tools?	any	no

fn mutate_deployed_model(deployedModel?: any, updateMask?: any)

mutate deployed model

Argument	Type	Required	Description
deployedModel?	any	no
updateMask?	any	no

fn predict(inputs?: any, parameters?: any)

predict

Argument	Type	Required	Description
inputs?	any	no
parameters?	any	no

fn predict_long_running(instances?: any, labels?: any, parameters?: any)

predict long running

Argument	Type	Required
instances?	any	no
labels?	any	no
parameters?	any	no

fn raw_predict(input?: any, methodName?: any)

raw predict

Argument	Type	Required	Description
input?	any	no
methodName?	any	no

fn server_streaming_predict(inputs?: any, parameters?: any)

server streaming predict

Argument	Type	Required	Description
inputs?	any	no
parameters?	any	no

fn stream_generate_content(cachedContent?: any, contents?: any, generationConfig?: any, labels?: any, modelArmorConfig?: any, safetySettings?: any, systemInstruction?: any, toolConfig?: any, tools?: any)

stream generate content

Argument	Type	Required
cachedContent?	any	no
contents?	any	no
generationConfig?	any	no
labels?	any	no
modelArmorConfig?	any	no
safetySettings?	any	no
systemInstruction?	any	no
toolConfig?	any	no
tools?	any	no

fn stream_raw_predict(httpBody?: any)

stream raw predict

Argument	Type	Required	Description
httpBody?	any	no

fn undeploy_model(deployedModelId?: any, trafficSplit?: any)

undeploy model

Argument	Type	Required	Description
deployedModelId?	any	no
trafficSplit?	any	no

evaluationitems.tsv2026.05.26.1

Global Arguments

Argument	Type	Required	Description
displayName?	string	no	Required. The display name of the EvaluationItem.
error?	object	no	The status code, which should be an enum value of google.rpc.Code.
evaluationItemType?	enum	no	Required. The type of the EvaluationItem.
evaluationRequest?	object	no	Required. The name of the candidate that produced the response.
evaluationResponse?	object	no	Optional. Additional results for the metric.
gcsUri?	string	no	The Cloud Storage object where the request or response is stored.
labels?	record	no	Optional. Labels for the EvaluationItem.
metadata?	string	no	Optional. Metadata for the EvaluationItem.
name?	string	no	Identifier. The resource name of the EvaluationItem. Format: `projects/{project}/locations/{location}/evaluationItems/{evaluation_item}`
location?	string	no	The location for this resource (e.g., 'us', 'us-central1', 'europe-west1')

fn create()

Create a evaluationItems

fn get(identifier: string)

Get a evaluationItems

Argument	Type	Required	Description
identifier	string	yes	The name of the evaluationItems

fn delete(identifier: string)

Delete the evaluationItems

Argument	Type	Required	Description
identifier	string	yes	The name of the evaluationItems

fn sync()

Sync evaluationItems state from GCP

fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)

List evaluationItems resources

Argument	Type	Required	Description
filter?	string	no	Optional. Filter expression that matches a subset of the EvaluationItems to show. For field names both snake_case and camelCase are supported. For more information about filter syntax, see [AIP-160](https://google.aip.dev/160).
orderBy?	string	no	Optional. A comma-separated list of fields to order by, sorted in ascending order by default. Use `desc` after a field name for descending.
pageSize?	number	no	Optional. The maximum number of Evaluation Items to return.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

evaluationruns.tsv2026.05.27.1

Global Arguments

Argument	Type	Required	Description
dataSource?	object	no	Optional. Map of candidate name to candidate response column name. The column will be in evaluation_item.CandidateResponse format.
displayName?	string	no	Required. The display name of the Evaluation Run.
error?	object	no	The status code, which should be an enum value of google.rpc.Code.
evaluationConfig?	object	no	Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers//models/` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`
evaluationResults?	object	no	The evaluation set where item level results are stored.
inferenceConfigs?	record	no	Optional. The resource name of the Agent Engine. Format: projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine} For example: projects/123/locations/us-central1/reasoningEngines/456
labels?	record	no	Optional. Labels for the evaluation run.
metadata?	string	no	Optional. Metadata about the evaluation run, can be used by the caller to store additional tracking information about the evaluation run.
name?	string	no	Identifier. The resource name of the EvaluationRun. This is a unique identifier. Format: `projects/{project}/locations/{location}/evaluationRuns/{evaluation_run}`
location?	string	no	The location for this resource (e.g., 'us', 'us-central1', 'europe-west1')

fn create(waitForReady?: boolean)

Create a evaluationRuns

Argument	Type	Required	Description
waitForReady?	boolean	no	Wait for the resource to reach a ready state after creation (default: true)

fn get(identifier: string)

Get a evaluationRuns

Argument	Type	Required	Description
identifier	string	yes	The name of the evaluationRuns

fn delete(identifier: string)

Delete the evaluationRuns

Argument	Type	Required	Description
identifier	string	yes	The name of the evaluationRuns

fn sync()

Sync evaluationRuns state from GCP

fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)

List evaluationRuns resources

Argument	Type	Required	Description
filter?	string	no	Optional. Filter expression that matches a subset of the EvaluationRuns to show. For field names both snake_case and camelCase are supported. For more information about filter syntax, see [AIP-160](https://google.aip.dev/160).
orderBy?	string	no	Optional. A comma-separated list of fields to order by, sorted in ascending order by default. Use `desc` after a field name for descending.
pageSize?	number	no	Optional. The maximum number of Evaluation Runs to return.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

fn cancel()

cancel

evaluationsets.tsv2026.05.26.1

Global Arguments

Argument	Type	Required	Description
displayName?	string	no	Required. The display name of the EvaluationSet.
evaluationItems?	array	no	Required. The EvaluationItems that are part of this dataset.
metadata?	string	no	Optional. Metadata for the EvaluationSet.
name?	string	no	Identifier. The resource name of the EvaluationSet. Format: `projects/{project}/locations/{location}/evaluationSets/{evaluation_set}`
location?	string	no	The location for this resource (e.g., 'us', 'us-central1', 'europe-west1')

fn create()

Create a evaluationSets

fn get(identifier: string)

Get a evaluationSets

Argument	Type	Required	Description
identifier	string	yes	The name of the evaluationSets

fn update()

Update evaluationSets attributes

fn delete(identifier: string)

Delete the evaluationSets

Argument	Type	Required	Description
identifier	string	yes	The name of the evaluationSets

fn sync()

Sync evaluationSets state from GCP

fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)

List evaluationSets resources

Argument	Type	Required	Description
filter?	string	no	Optional. Filter expression that matches a subset of the EvaluationSets to show. For field names both snake_case and camelCase are supported. For more information about filter syntax, see [AIP-160](https://google.aip.dev/160).
orderBy?	string	no	Optional. A comma-separated list of fields to order by, sorted in ascending order by default. Use `desc` after a field name for descending.
pageSize?	number	no	Optional. The maximum number of Evaluation Sets to return.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

featuregroups.tsv2026.05.26.1

Global Arguments

Argument	Type	Required	Description
bigQuery?	object	no	Required. BigQuery URI to a table, up to 2000 characters long. Accepted forms: * BigQuery path. For example: `bq://projectId.bqDatasetId.bqTableId`.
description?	string	no	Optional. Description of the FeatureGroup.
labels?	record	no	Optional. The labels with user-defined metadata to organize your FeatureGroup. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information on and examples of labels. No more than 64 user labels can be associated with one FeatureGroup(System labels are excluded)." System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable.
name?	string	no	Identifier. Name of the FeatureGroup. Format: `projects/{project}/locations/{location}/featureGroups/{featureGroup}`
serviceAgentType?	enum	no	Optional. Service agent type used during jobs under a FeatureGroup. By default, the Vertex AI Service Agent is used. When using an IAM Policy to isolate this FeatureGroup within a project, a separate service account should be provisioned by setting this field to `SERVICE_AGENT_TYPE_FEATURE_GROUP`. This will generate a separate service account to access the BigQuery source table.
featureGroupId?	string	no	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?	string	no	The location for this resource (e.g., 'us', 'us-central1', 'europe-west1')

fn create()

Create a featureGroups

fn get(identifier: string)

Get a featureGroups

Argument	Type	Required	Description
identifier	string	yes	The name of the featureGroups

fn update()

Update featureGroups attributes

fn delete(identifier: string)

Delete the featureGroups

Argument	Type	Required	Description
identifier	string	yes	The name of the featureGroups

fn sync()

Sync featureGroups state from GCP

fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)

List featureGroups resources

Argument	Type	Required	Description
filter?	string	no	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".
orderBy?	string	no	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`
pageSize?	number	no	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.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

fn get_iam_policy()

get iam policy

fn set_iam_policy(policy?: any)

set iam policy

Argument	Type	Required	Description
policy?	any	no

fn test_iam_permissions()

test iam permissions

featuregroups_features.tsv2026.05.26.1

Global Arguments

Argument	Type	Required	Description
description?	string	no	Description of the Feature.
disableMonitoring?	boolean	no	Optional. Only applicable for Vertex AI Feature Store (Legacy). If not set, use the monitoring_config defined for the EntityType this Feature belongs to. Only Features with type (Feature.ValueType) BOOL, STRING, DOUBLE or INT64 can enable monitoring. If set to true, all types of data monitoring are disabled despite the config on EntityType.
labels?	record	no	Optional. The labels with user-defined metadata to organize your Features. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information on and examples of labels. No more than 64 user labels can be associated with one Feature (System labels are excluded)." System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable.
name?	string	no	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.
pointOfContact?	string	no	Entity responsible for maintaining this feature. Can be comma separated list of email addresses or URIs.
valueType?	enum	no	Immutable. Only applicable for Vertex AI Feature Store (Legacy). Type of Feature value.
versionColumnName?	string	no	Only applicable for Vertex AI Feature Store. The name of the BigQuery Table/View column hosting data for this version. If no value is provided, will use feature_id.
featureId?	string	no	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?	string	no	The location for this resource (e.g., 'us', 'us-central1', 'europe-west1')

fn create()

Create a features

fn get(identifier: string)

Get a features

Argument	Type	Required	Description
identifier	string	yes	The name of the features

fn update()

Update features attributes

fn delete(identifier: string)

Delete the features

Argument	Type	Required	Description
identifier	string	yes	The name of the features

fn sync()

Sync features state from GCP

fn list(filter?: string, latestStatsCount?: number, orderBy?: string, pageSize?: number, readMask?: string, maxPages?: number)

List features resources

Argument	Type	Required	Description
filter?	string	no	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.
latestStatsCount?	number	no	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.
orderBy?	string	no	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`
pageSize?	number	no	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.
readMask?	string	no	Mask specifying which fields to read.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

fn batch_create(requests?: any)

batch create

Argument	Type	Required	Description
requests?	any	no

featureonlinestores.tsv2026.05.26.1

Global Arguments

Argument	Type	Required	Description
bigtable?	object	no	Optional. A percentage of the cluster's CPU capacity. Can be from 10% to 80%. When a cluster's CPU utilization exceeds the target that you have set, Bigtable immediately adds nodes to the cluster. When CPU utilization is substantially lower than the target, Bigtable removes nodes. If not set will default to 50%.
dedicatedServingEndpoint?	object	no	Required. If true, expose the IndexEndpoint via private service connect.
encryptionSpec?	object	no	Required. Resource name of the Cloud KMS key used to protect the resource. The Cloud KMS key must be in the same region as the resource. It must have the format `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`.
labels?	record	no	Optional. The labels with user-defined metadata to organize your FeatureOnlineStore. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information on and examples of labels. No more than 64 user labels can be associated with one FeatureOnlineStore(System labels are excluded)." System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable.
name?	string	no	Identifier. Name of the FeatureOnlineStore. Format: `projects/{project}/locations/{location}/featureOnlineStores/{featureOnlineStore}`
optimized?	object	no	Optimized storage type
featureOnlineStoreId?	string	no	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?	string	no	The location for this resource (e.g., 'us', 'us-central1', 'europe-west1')

fn create()

Create a featureOnlineStores

fn get(identifier: string)

Get a featureOnlineStores

Argument	Type	Required	Description
identifier	string	yes	The name of the featureOnlineStores

fn update()

Update featureOnlineStores attributes

fn delete(identifier: string)

Delete the featureOnlineStores

Argument	Type	Required	Description
identifier	string	yes	The name of the featureOnlineStores

fn sync()

Sync featureOnlineStores state from GCP

fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)

List featureOnlineStores resources

Argument	Type	Required	Description
filter?	string	no	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".
orderBy?	string	no	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`
pageSize?	number	no	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.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

fn get_iam_policy()

get iam policy

fn set_iam_policy(policy?: any)

set iam policy

Argument	Type	Required	Description
policy?	any	no

fn test_iam_permissions()

test iam permissions

featureonlinestores_featureviews.tsv2026.05.26.1

Global Arguments

Argument	Type	Required	Description
bigQuerySource?	object	no	Required. Columns to construct entity_id / row keys.
bigtableMetadata?	object	no	Output only. The Bigtable App Profile to use for reading from Bigtable.
featureRegistrySource?	object	no	Required. Identifier of the feature group.
indexConfig?	object	no	Configuration options for using brute force search.
labels?	record	no	Optional. The labels with user-defined metadata to organize your FeatureViews. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information on and examples of labels. No more than 64 user labels can be associated with one FeatureOnlineStore(System labels are excluded)." System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable.
name?	string	no	Identifier. Name of the FeatureView. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}`
optimizedConfig?	object	no	Immutable. The maximum number of replicas that may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale to that many replicas is guaranteed (barring service outages). If traffic increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, a no upper bound for scaling under heavy traffic will be assume, though Vertex AI may be unable to scale beyond certain replica number.
serviceAgentType?	enum	no	Optional. Service agent type used during data sync. By default, the Vertex AI Service Agent is used. When using an IAM Policy to isolate this FeatureView within a project, a separate service account should be provisioned by setting this field to `SERVICE_AGENT_TYPE_FEATURE_VIEW`. This will generate a separate service account to access the BigQuery source table.
syncConfig?	object	no	Optional. If true, syncs the FeatureView in a continuous manner to Online Store.
vertexRagSource?	object	no	Optional. The RAG corpus id corresponding to this FeatureView.
featureViewId?	string	no	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.
runSyncImmediately?	string	no	Immutable. If set to true, one on demand sync will be run immediately, regardless whether the FeatureView.sync_config is configured or not.
location?	string	no	The location for this resource (e.g., 'us', 'us-central1', 'europe-west1')

fn create()

Create a featureViews

fn get(identifier: string)

Get a featureViews

Argument	Type	Required	Description
identifier	string	yes	The name of the featureViews

fn update()

Update featureViews attributes

fn delete(identifier: string)

Delete the featureViews

Argument	Type	Required	Description
identifier	string	yes	The name of the featureViews

fn sync()

Sync featureViews state from GCP

fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)

List featureViews resources

Argument	Type	Required	Description
filter?	string	no	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.
orderBy?	string	no	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`
pageSize?	number	no	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.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

fn direct_write(dataKeyAndFeatureValues?: any)

direct write

Argument	Type	Required	Description
dataKeyAndFeatureValues?	any	no

fn fetch_feature_values(dataFormat?: any, dataKey?: any)

fetch feature values

Argument	Type	Required	Description
dataFormat?	any	no
dataKey?	any	no

fn generate_fetch_access_token()

generate fetch access token

fn get_iam_policy()

get iam policy

fn search_nearest_entities(query?: any, returnFullEntity?: any)

search nearest entities

Argument	Type	Required	Description
query?	any	no
returnFullEntity?	any	no

fn set_iam_policy(policy?: any)

set iam policy

Argument	Type	Required	Description
policy?	any	no

fn action_sync()

sync

fn test_iam_permissions()

test iam permissions

featureonlinestores_featureviews_featureviewsyncs.tsv2026.05.26.1

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
location?	string	no	The location for this resource (e.g., 'us', 'us-central1', 'europe-west1')

fn get(identifier: string)

Get a featureViewSyncs

Argument	Type	Required	Description
identifier	string	yes	The name of the featureViewSyncs

fn sync()

Sync featureViewSyncs state from GCP

fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)

List featureViewSyncs resources

Argument	Type	Required	Description
filter?	string	no	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.
orderBy?	string	no	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`
pageSize?	number	no	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.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

featurestores.tsv2026.05.26.1

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
encryptionSpec?	object	no	Required. Resource name of the Cloud KMS key used to protect the resource. The Cloud KMS key must be in the same region as the resource. It must have the format `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`.
labels?	record	no	Optional. The labels with user-defined metadata to organize your Featurestore. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information on and examples of labels. No more than 64 user labels can be associated with one Featurestore(System labels are excluded)." System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable.
onlineServingConfig?	object	no	The number of nodes for the online store. The number of nodes doesn't scale automatically, but you can manually update the number of nodes. If set to 0, the featurestore will not have an online store and cannot be used for online serving.
onlineStorageTtlDays?	number	no	Optional. TTL in days for feature values that will be stored in online serving storage. The Feature Store online storage periodically removes obsolete feature values older than `online_storage_ttl_days` since the feature generation time. Note that `online_storage_ttl_days` should be less than or equal to `offline_storage_ttl_days` for each EntityType under a featurestore. If not set, default to 4000 days
featurestoreId?	string	no	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?	string	no	The location for this resource (e.g., 'us', 'us-central1', 'europe-west1')

fn create()

Create a featurestores

fn get(identifier: string)

Get a featurestores

Argument	Type	Required	Description
identifier	string	yes	The name of the featurestores

fn update()

Update featurestores attributes

fn delete(identifier: string)

Delete the featurestores

Argument	Type	Required	Description
identifier	string	yes	The name of the featurestores

fn sync()

Sync featurestores state from GCP

fn list(filter?: string, orderBy?: string, pageSize?: number, readMask?: string, maxPages?: number)

List featurestores resources

Argument	Type	Required	Description
filter?	string	no	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".
orderBy?	string	no	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`
pageSize?	number	no	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.
readMask?	string	no	Mask specifying which fields to read.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

fn batch_read_feature_values(bigqueryReadInstances?: any, csvReadInstances?: any, destination?: any, entityTypeSpecs?: any, passThroughFields?: any, startTime?: any)

batch read feature values

Argument	Type	Required
bigqueryReadInstances?	any	no
csvReadInstances?	any	no
destination?	any	no
entityTypeSpecs?	any	no
passThroughFields?	any	no
startTime?	any	no

fn get_iam_policy()

get iam policy

fn search_features()

search features

fn set_iam_policy(policy?: any)

set iam policy

Argument	Type	Required	Description
policy?	any	no

fn test_iam_permissions()

test iam permissions

featurestores_entitytypes.tsv2026.05.26.1

Global Arguments

Argument	Type	Required	Description
description?	string	no	Optional. Description of the EntityType.
labels?	record	no	Optional. The labels with user-defined metadata to organize your EntityTypes. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information on and examples of labels. No more than 64 user labels can be associated with one EntityType (System labels are excluded)." System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable.
monitoringConfig?	object	no	Specify a threshold value that can trigger the alert. 1. For categorical feature, the distribution distance is calculated by L-inifinity norm. 2. For numerical feature, the distribution distance is calculated by Jensen–Shannon divergence. Each feature must have a non-zero threshold if they need to be monitored. Otherwise no alert will be triggered for that feature.
name?	string	no	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.
offlineStorageTtlDays?	number	no	Optional. Config for data retention policy in offline storage. TTL in days for feature values that will be stored in offline storage. The Feature Store offline storage periodically removes obsolete feature values older than `offline_storage_ttl_days` since the feature generation time. If unset (or explicitly set to 0), default to 4000 days TTL.
entityTypeId?	string	no	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?	string	no	The location for this resource (e.g., 'us', 'us-central1', 'europe-west1')

fn create()

Create a entityTypes

fn get(identifier: string)

Get a entityTypes

Argument	Type	Required	Description
identifier	string	yes	The name of the entityTypes

fn update()

Update entityTypes attributes

fn delete(identifier: string)

Delete the entityTypes

Argument	Type	Required	Description
identifier	string	yes	The name of the entityTypes

fn sync()

Sync entityTypes state from GCP

fn list(filter?: string, orderBy?: string, pageSize?: number, readMask?: string, maxPages?: number)

List entityTypes resources

Argument	Type	Required	Description
filter?	string	no	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.
orderBy?	string	no	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`
pageSize?	number	no	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.
readMask?	string	no	Mask specifying which fields to read.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

fn export_feature_values(destination?: any, featureSelector?: any, fullExport?: any, settings?: any, snapshotExport?: any)

export feature values

Argument	Type	Required
destination?	any	no
featureSelector?	any	no
fullExport?	any	no
settings?	any	no
snapshotExport?	any	no

fn get_iam_policy()

get iam policy

fn import_feature_values(avroSource?: any, bigquerySource?: any, csvSource?: any, disableIngestionAnalysis?: any, disableOnlineServing?: any, entityIdField?: any, featureSpecs?: any, featureTime?: any, featureTimeField?: any, workerCount?: any)

import feature values

Argument	Type	Required
avroSource?	any	no
bigquerySource?	any	no
csvSource?	any	no
disableIngestionAnalysis?	any	no
disableOnlineServing?	any	no
entityIdField?	any	no
featureSpecs?	any	no
featureTime?	any	no
featureTimeField?	any	no
workerCount?	any	no

fn read_feature_values(entityId?: any, featureSelector?: any)

read feature values

Argument	Type	Required	Description
entityId?	any	no
featureSelector?	any	no

fn set_iam_policy(policy?: any)

set iam policy

Argument	Type	Required	Description
policy?	any	no

fn streaming_read_feature_values(entityIds?: any, featureSelector?: any)

streaming read feature values

Argument	Type	Required	Description
entityIds?	any	no
featureSelector?	any	no

fn test_iam_permissions()

test iam permissions

fn write_feature_values(payloads?: any)

write feature values

Argument	Type	Required	Description
payloads?	any	no

featurestores_entitytypes_features.tsv2026.05.26.1

Global Arguments

Argument	Type	Required	Description
description?	string	no	Description of the Feature.
disableMonitoring?	boolean	no	Optional. Only applicable for Vertex AI Feature Store (Legacy). If not set, use the monitoring_config defined for the EntityType this Feature belongs to. Only Features with type (Feature.ValueType) BOOL, STRING, DOUBLE or INT64 can enable monitoring. If set to true, all types of data monitoring are disabled despite the config on EntityType.
labels?	record	no	Optional. The labels with user-defined metadata to organize your Features. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information on and examples of labels. No more than 64 user labels can be associated with one Feature (System labels are excluded)." System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable.
name?	string	no	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.
pointOfContact?	string	no	Entity responsible for maintaining this feature. Can be comma separated list of email addresses or URIs.
valueType?	enum	no	Immutable. Only applicable for Vertex AI Feature Store (Legacy). Type of Feature value.
versionColumnName?	string	no	Only applicable for Vertex AI Feature Store. The name of the BigQuery Table/View column hosting data for this version. If no value is provided, will use feature_id.
featureId?	string	no	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?	string	no	The location for this resource (e.g., 'us', 'us-central1', 'europe-west1')

fn create()

Create a features

fn get(identifier: string)

Get a features

Argument	Type	Required	Description
identifier	string	yes	The name of the features

fn update()

Update features attributes

fn delete(identifier: string)

Delete the features

Argument	Type	Required	Description
identifier	string	yes	The name of the features

fn sync()

Sync features state from GCP

fn list(filter?: string, latestStatsCount?: number, orderBy?: string, pageSize?: number, readMask?: string, maxPages?: number)

List features resources

Argument	Type	Required	Description
filter?	string	no	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.
latestStatsCount?	number	no	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.
orderBy?	string	no	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`
pageSize?	number	no	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.
readMask?	string	no	Mask specifying which fields to read.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

fn batch_create(requests?: any)

batch create

Argument	Type	Required	Description
requests?	any	no

hyperparametertuningjobs.tsv2026.05.26.1

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
displayName?	string	no	Required. The display name of the HyperparameterTuningJob. The name can be up to 128 characters long and can consist of any UTF-8 characters.
encryptionSpec?	object	no	Required. Resource name of the Cloud KMS key used to protect the resource. The Cloud KMS key must be in the same region as the resource. It must have the format `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`.
error?	object	no	The status code, which should be an enum value of google.rpc.Code.
labels?	record	no	The labels with user-defined metadata to organize HyperparameterTuningJobs. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels.
maxFailedTrialCount?	number	no	The number of failed Trials that need to be seen before failing the HyperparameterTuningJob. If set to 0, Vertex AI decides how many Trials must fail before the whole job fails.
maxTrialCount?	number	no	Required. The desired total number of Trials.
parallelTrialCount?	number	no	Required. The desired number of Trials to run in parallel.
studySpec?	object	no	The search algorithm specified for the Study.
trialJobSpec?	object	no	Required. Google Cloud Storage URI to output directory. If the uri doesn't end with '/', a '/' will be automatically appended. The directory is created if it doesn't exist.
location?	string	no	The location for this resource (e.g., 'us', 'us-central1', 'europe-west1')

fn create()

Create a hyperparameterTuningJobs

fn get(identifier: string)

Get a hyperparameterTuningJobs

Argument	Type	Required	Description
identifier	string	yes	The name of the hyperparameterTuningJobs

fn delete(identifier: string)

Delete the hyperparameterTuningJobs

Argument	Type	Required	Description
identifier	string	yes	The name of the hyperparameterTuningJobs

fn sync()

Sync hyperparameterTuningJobs state from GCP

fn list(filter?: string, pageSize?: number, readMask?: string, maxPages?: number)

List hyperparameterTuningJobs resources

Argument	Type	Required	Description
filter?	string	no	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:*`
pageSize?	number	no	The standard list page size.
readMask?	string	no	Mask specifying which fields to read.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

fn cancel()

cancel

indexendpoints.tsv2026.05.26.1

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
description?	string	no	The description of the IndexEndpoint.
displayName?	string	no	Required. The display name of the IndexEndpoint. The name can be up to 128 characters long and can consist of any UTF-8 characters.
encryptionSpec?	object	no	Required. Resource name of the Cloud KMS key used to protect the resource. The Cloud KMS key must be in the same region as the resource. It must have the format `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`.
labels?	record	no	The labels with user-defined metadata to organize your IndexEndpoints. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels.
network?	string	no	Optional. The full name of the Google Compute Engine [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks) to which the IndexEndpoint should be peered. Private services access must already be configured for the network. If left unspecified, the Endpoint is not peered with any network. network and private_service_connect_config are mutually exclusive. [Format](https://cloud.google.com/compute/docs/reference/rest/v1/networks/insert): `projects/{project}/global/networks/{network}`. Where {project} is a project number, as in '12345', and {network} is network name.
privateServiceConnectConfig?	object	no	Required. If true, expose the IndexEndpoint via private service connect.
publicEndpointEnabled?	boolean	no	Optional. If true, the deployed index will be accessible through public endpoint.
location?	string	no	The location for this resource (e.g., 'us', 'us-central1', 'europe-west1')

fn create()

Create a indexEndpoints

fn get(identifier: string)

Get a indexEndpoints

Argument	Type	Required	Description
identifier	string	yes	The name of the indexEndpoints

fn update()

Update indexEndpoints attributes

fn delete(identifier: string)

Delete the indexEndpoints

Argument	Type	Required	Description
identifier	string	yes	The name of the indexEndpoints

fn sync()

Sync indexEndpoints state from GCP

fn list(filter?: string, pageSize?: number, readMask?: string, maxPages?: number)

List indexEndpoints resources

Argument	Type	Required	Description
filter?	string	no	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"`
pageSize?	number	no	Optional. The standard list page size.
readMask?	string	no	Optional. Mask specifying which fields to read.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

fn deploy_index(deployedIndex?: any)

deploy index

Argument	Type	Required	Description
deployedIndex?	any	no

fn find_neighbors(deployedIndexId?: any, queries?: any, returnFullDatapoint?: any)

find neighbors

Argument	Type	Required
deployedIndexId?	any	no
queries?	any	no
returnFullDatapoint?	any	no

fn mutate_deployed_index(automaticResources?: any, createTime?: any, dedicatedResources?: any, deployedIndexAuthConfig?: any, deploymentGroup?: any, deploymentTier?: any, displayName?: any, enableAccessLogging?: any, enableDatapointUpsertLogging?: any, id?: any, index?: any, indexSyncTime?: any, privateEndpoints?: any, pscAutomationConfigs?: any, reservedIpRanges?: any)

mutate deployed index

Argument	Type	Required
automaticResources?	any	no
createTime?	any	no
dedicatedResources?	any	no
deployedIndexAuthConfig?	any	no
deploymentGroup?	any	no
deploymentTier?	any	no
displayName?	any	no
enableAccessLogging?	any	no
enableDatapointUpsertLogging?	any	no
id?	any	no
index?	any	no
indexSyncTime?	any	no
privateEndpoints?	any	no
pscAutomationConfigs?	any	no
reservedIpRanges?	any	no

fn read_index_datapoints(deployedIndexId?: any, ids?: any)

read index datapoints

Argument	Type	Required	Description
deployedIndexId?	any	no
ids?	any	no

fn undeploy_index(deployedIndexId?: any)

undeploy index

Argument	Type	Required	Description
deployedIndexId?	any	no

indexes.tsv2026.05.26.1

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
description?	string	no	The description of the Index.
displayName?	string	no	Required. The display name of the Index. The name can be up to 128 characters long and can consist of any UTF-8 characters.
encryptionSpec?	object	no	Required. Resource name of the Cloud KMS key used to protect the resource. The Cloud KMS key must be in the same region as the resource. It must have the format `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`.
indexStats?	object	no	Output only. The number of shards in the Index.
indexUpdateMethod?	enum	no	Immutable. The update method to use with this Index. If not set, BATCH_UPDATE will be used by default.
labels?	record	no	The labels with user-defined metadata to organize your Indexes. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels.
metadata?	string	no	An additional information about the Index; the schema of the metadata can be found in metadata_schema.
metadataSchemaUri?	string	no	Immutable. Points to a YAML file stored on Google Cloud Storage describing additional information about the Index, that is specific to it. Unset if the Index does not have any additional information. The schema is defined as an OpenAPI 3.0.2 [Schema Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). Note: The URI given on output will be immutable and probably different, including the URI scheme, than the one given on input. The output URI will point to a location where the user only has a read access.
location?	string	no	The location for this resource (e.g., 'us', 'us-central1', 'europe-west1')

fn create()

Create a indexes

fn get(identifier: string)

Get a indexes

Argument	Type	Required	Description
identifier	string	yes	The name of the indexes

fn update()

Update indexes attributes

fn delete(identifier: string)

Delete the indexes

Argument	Type	Required	Description
identifier	string	yes	The name of the indexes

fn sync()

Sync indexes state from GCP

fn list(filter?: string, pageSize?: number, readMask?: string, maxPages?: number)

List indexes resources

Argument	Type	Required	Description
filter?	string	no	The standard list filter.
pageSize?	number	no	The standard list page size.
readMask?	string	no	Mask specifying which fields to read.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

fn upsert_datapoints(datapoints?: any, updateMask?: any)

upsert datapoints

Argument	Type	Required	Description
datapoints?	any	no
updateMask?	any	no

locations.tsv2026.05.26.1

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)

fn get(identifier: string)

Get a locations

Argument	Type	Required	Description
identifier	string	yes	The name of the locations

fn sync()

Sync locations state from GCP

fn list(extraLocationTypes?: string, filter?: string, pageSize?: number, maxPages?: number)

List locations resources

Argument	Type	Required	Description
extraLocationTypes?	string	no	Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage.
filter?	string	no	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).
pageSize?	number	no	The maximum number of results to return. If not set, the service selects a default.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

fn ask_contexts(query?: any, tools?: any)

ask contexts

Argument	Type	Required	Description
query?	any	no
tools?	any	no

fn async_retrieve_contexts(query?: any, tools?: any)

async retrieve contexts

Argument	Type	Required	Description
query?	any	no
tools?	any	no

fn augment_prompt(contents?: any, model?: any, vertexRagStore?: any)

augment prompt

Argument	Type	Required
contents?	any	no
model?	any	no
vertexRagStore?	any	no

fn corroborate_content(content?: any, facts?: any, parameters?: any)

corroborate content

Argument	Type	Required
content?	any	no
facts?	any	no
parameters?	any	no

fn deploy(deployConfig?: any, endpointConfig?: any, huggingFaceModelId?: any, modelConfig?: any, publisherModelName?: any)

deploy

Argument	Type	Required
deployConfig?	any	no
endpointConfig?	any	no
huggingFaceModelId?	any	no
modelConfig?	any	no
publisherModelName?	any	no

fn evaluate_dataset(autoraterConfig?: any, dataset?: any, location?: any, metrics?: any, outputConfig?: any)

evaluate dataset

Argument	Type	Required
autoraterConfig?	any	no
dataset?	any	no
location?	any	no
metrics?	any	no
outputConfig?	any	no

fn evaluate_instances(autoraterConfig?: any, bleuInput?: any, coherenceInput?: any, cometInput?: any, exactMatchInput?: any, fluencyInput?: any, fulfillmentInput?: any, groundednessInput?: any, instance?: any, location?: any, metricSources?: any, metrics?: any, metricxInput?: any, pairwiseMetricInput?: any, pairwiseQuestionAnsweringQualityInput?: any, pairwiseSummarizationQualityInput?: any, pointwiseMetricInput?: any, questionAnsweringCorrectnessInput?: any, questionAnsweringHelpfulnessInput?: any, questionAnsweringQualityInput?: any, questionAnsweringRelevanceInput?: any, rougeInput?: any, rubricBasedInstructionFollowingInput?: any, safetyInput?: any, summarizationHelpfulnessInput?: any, summarizationQualityInput?: any, summarizationVerbosityInput?: any, toolCallValidInput?: any, toolNameMatchInput?: any, toolParameterKeyMatchInput?: any, toolParameterKvMatchInput?: any, trajectoryAnyOrderMatchInput?: any, trajectoryExactMatchInput?: any, trajectoryInOrderMatchInput?: any, trajectoryPrecisionInput?: any, trajectoryRecallInput?: any, trajectorySingleToolUseInput?: any)

evaluate instances

Argument	Type	Required
autoraterConfig?	any	no
bleuInput?	any	no
coherenceInput?	any	no
cometInput?	any	no
exactMatchInput?	any	no
fluencyInput?	any	no
fulfillmentInput?	any	no
groundednessInput?	any	no
instance?	any	no
location?	any	no
metricSources?	any	no
metrics?	any	no
metricxInput?	any	no
pairwiseMetricInput?	any	no
pairwiseQuestionAnsweringQualityInput?	any	no
pairwiseSummarizationQualityInput?	any	no
pointwiseMetricInput?	any	no
questionAnsweringCorrectnessInput?	any	no
questionAnsweringHelpfulnessInput?	any	no
questionAnsweringQualityInput?	any	no
questionAnsweringRelevanceInput?	any	no
rougeInput?	any	no
rubricBasedInstructionFollowingInput?	any	no
safetyInput?	any	no
summarizationHelpfulnessInput?	any	no
summarizationQualityInput?	any	no
summarizationVerbosityInput?	any	no
toolCallValidInput?	any	no
toolNameMatchInput?	any	no
toolParameterKeyMatchInput?	any	no
toolParameterKvMatchInput?	any	no
trajectoryAnyOrderMatchInput?	any	no
trajectoryExactMatchInput?	any	no
trajectoryInOrderMatchInput?	any	no
trajectoryPrecisionInput?	any	no
trajectoryRecallInput?	any	no
trajectorySingleToolUseInput?	any	no

fn generate_instance_rubrics(agentConfig?: any, contents?: any, location?: any, metricResourceName?: any, predefinedRubricGenerationSpec?: any, rubricGenerationSpec?: any)

generate instance rubrics

Argument	Type	Required
agentConfig?	any	no
contents?	any	no
location?	any	no
metricResourceName?	any	no
predefinedRubricGenerationSpec?	any	no
rubricGenerationSpec?	any	no

fn generate_synthetic_data(count?: any, examples?: any, outputFieldSpecs?: any, taskDescription?: any)

generate synthetic data

Argument	Type	Required
count?	any	no
examples?	any	no
outputFieldSpecs?	any	no
taskDescription?	any	no

fn get_rag_engine_config()

get rag engine config

fn retrieve_contexts(query?: any, tools?: any)

retrieve contexts

Argument	Type	Required	Description
query?	any	no
tools?	any	no

fn update_rag_engine_config(name?: any, ragManagedDbConfig?: any)

update rag engine config

Argument	Type	Required	Description
name?	any	no
ragManagedDbConfig?	any	no

metadatastores.tsv2026.05.26.1

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
dataplexConfig?	object	no	Optional. Whether or not Data Lineage synchronization is enabled for Vertex Pipelines.
description?	string	no	Description of the MetadataStore.
encryptionSpec?	object	no	Required. Resource name of the Cloud KMS key used to protect the resource. The Cloud KMS key must be in the same region as the resource. It must have the format `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`.
state?	object	no	The disk utilization of the MetadataStore in bytes.
metadataStoreId?	string	no	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?	string	no	The location for this resource (e.g., 'us', 'us-central1', 'europe-west1')

fn create()

Create a metadataStores

fn get(identifier: string)

Get a metadataStores

Argument	Type	Required	Description
identifier	string	yes	The name of the metadataStores

fn delete(identifier: string)

Delete the metadataStores

Argument	Type	Required	Description
identifier	string	yes	The name of the metadataStores

fn sync()

Sync metadataStores state from GCP

fn list(pageSize?: number, maxPages?: number)

List metadataStores resources

Argument	Type	Required	Description
pageSize?	number	no	The maximum number of Metadata Stores to return. The service may return fewer. Must be in range 1-100, inclusive. Defaults to 100.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

metadatastores_artifacts.tsv2026.05.26.1

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
description?	string	no	Description of the Artifact
displayName?	string	no	User provided display name of the Artifact. May be up to 128 Unicode characters.
labels?	record	no	The labels with user-defined metadata to organize your Artifacts. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one Artifact (System labels are excluded).
metadata?	record	no	Properties of the Artifact. Top level metadata keys' heading and trailing spaces will be trimmed. The size of this field should not exceed 200KB.
schemaTitle?	string	no	The title of the schema describing the metadata. Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store.
schemaVersion?	string	no	The version of the schema in schema_name to use. Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store.
state?	enum	no	The state of this Artifact. This is a property of the Artifact, and does not imply or capture any ongoing process. This property is managed by clients (such as Vertex AI Pipelines), and the system does not prescribe or check the validity of state transitions.
uri?	string	no	The uniform resource identifier of the artifact file. May be empty if there is no actual artifact file.
artifactId?	string	no	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?	string	no	The location for this resource (e.g., 'us', 'us-central1', 'europe-west1')

fn create()

Create a artifacts

fn get(identifier: string)

Get a artifacts

Argument	Type	Required	Description
identifier	string	yes	The name of the artifacts

fn update()

Update artifacts attributes

fn delete(identifier: string)

Delete the artifacts

Argument	Type	Required	Description
identifier	string	yes	The name of the artifacts

fn sync()

Sync artifacts state from GCP

fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)

List artifacts resources

Argument	Type	Required	Description
filter?	string	no	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`.
orderBy?	string	no	How the list of messages is ordered. Specify the values to order by and an ordering operation. The default sorting order is ascending. To specify descending order for a field, users append a " desc" suffix; for example: "foo desc, bar". Subfields are specified with a `.` character, such as foo.bar. see https://google.aip.dev/132#ordering for more details.
pageSize?	number	no	The maximum number of Artifacts to return. The service may return fewer. Must be in range 1-100, inclusive. Defaults to 100.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

fn purge(filter?: any, force?: any)

purge

Argument	Type	Required	Description
filter?	any	no
force?	any	no

fn query_artifact_lineage_subgraph()

query artifact lineage subgraph

metadatastores_contexts.tsv2026.05.26.1

Global Arguments

Argument	Type	Required	Description
description?	string	no	Description of the Context
displayName?	string	no	User provided display name of the Context. May be up to 128 Unicode characters.
labels?	record	no	The labels with user-defined metadata to organize your Contexts. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one Context (System labels are excluded).
metadata?	record	no	Properties of the Context. Top level metadata keys' heading and trailing spaces will be trimmed. The size of this field should not exceed 200KB.
name?	string	no	Immutable. The resource name of the Context.
schemaTitle?	string	no	The title of the schema describing the metadata. Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store.
schemaVersion?	string	no	The version of the schema in schema_name to use. Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store.
contextId?	string	no	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?	string	no	The location for this resource (e.g., 'us', 'us-central1', 'europe-west1')

fn create()

Create a contexts

fn get(identifier: string)

Get a contexts

Argument	Type	Required	Description
identifier	string	yes	The name of the contexts

fn update()

Update contexts attributes

fn delete(identifier: string)

Delete the contexts

Argument	Type	Required	Description
identifier	string	yes	The name of the contexts

fn sync()

Sync contexts state from GCP

fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)

List contexts resources

Argument	Type	Required	Description
filter?	string	no	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`.
orderBy?	string	no	How the list of messages is ordered. Specify the values to order by and an ordering operation. The default sorting order is ascending. To specify descending order for a field, users append a " desc" suffix; for example: "foo desc, bar". Subfields are specified with a `.` character, such as foo.bar. see https://google.aip.dev/132#ordering for more details.
pageSize?	number	no	The maximum number of Contexts to return. The service may return fewer. Must be in range 1-100, inclusive. Defaults to 100.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

fn add_context_artifacts_and_executions(artifacts?: any, executions?: any)

add context artifacts and executions

Argument	Type	Required	Description
artifacts?	any	no
executions?	any	no

fn add_context_children(childContexts?: any)

add context children

Argument	Type	Required	Description
childContexts?	any	no

fn purge(filter?: any, force?: any)

purge

Argument	Type	Required	Description
filter?	any	no
force?	any	no

fn query_context_lineage_subgraph()

query context lineage subgraph

metadatastores_executions.tsv2026.05.26.1

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
description?	string	no	Description of the Execution
displayName?	string	no	User provided display name of the Execution. May be up to 128 Unicode characters.
labels?	record	no	The labels with user-defined metadata to organize your Executions. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one Execution (System labels are excluded).
metadata?	record	no	Properties of the Execution. Top level metadata keys' heading and trailing spaces will be trimmed. The size of this field should not exceed 200KB.
schemaTitle?	string	no	The title of the schema describing the metadata. Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store.
schemaVersion?	string	no	The version of the schema in `schema_title` to use. Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store.
state?	enum	no	The state of this Execution. This is a property of the Execution, and does not imply or capture any ongoing process. This property is managed by clients (such as Vertex AI Pipelines) and the system does not prescribe or check the validity of state transitions.
executionId?	string	no	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?	string	no	The location for this resource (e.g., 'us', 'us-central1', 'europe-west1')

fn create(waitForReady?: boolean)

Create a executions

Argument	Type	Required	Description
waitForReady?	boolean	no	Wait for the resource to reach a ready state after creation (default: true)

fn get(identifier: string)

Get a executions

Argument	Type	Required	Description
identifier	string	yes	The name of the executions

fn update(waitForReady?: boolean)

Update executions attributes

Argument	Type	Required	Description
waitForReady?	boolean	no	Wait for the resource to reach a ready state after update (default: true)

fn delete(identifier: string)

Delete the executions

Argument	Type	Required	Description
identifier	string	yes	The name of the executions

fn sync()

Sync executions state from GCP

fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)

List executions resources

Argument	Type	Required	Description
filter?	string	no	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`.
orderBy?	string	no	How the list of messages is ordered. Specify the values to order by and an ordering operation. The default sorting order is ascending. To specify descending order for a field, users append a " desc" suffix; for example: "foo desc, bar". Subfields are specified with a `.` character, such as foo.bar. see https://google.aip.dev/132#ordering for more details.
pageSize?	number	no	The maximum number of Executions to return. The service may return fewer. Must be in range 1-100, inclusive. Defaults to 100.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

fn add_execution_events(events?: any)

add execution events

Argument	Type	Required	Description
events?	any	no

fn purge(filter?: any, force?: any)

purge

Argument	Type	Required	Description
filter?	any	no
force?	any	no

fn query_execution_inputs_and_outputs()

query execution inputs and outputs

metadatastores_metadataschemas.tsv2026.05.26.1

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
description?	string	no	Description of the Metadata Schema
schema?	string	no	Required. The raw YAML string representation of the MetadataSchema. The combination of [MetadataSchema.version] and the schema name given by `title` in [MetadataSchema.schema] must be unique within a MetadataStore. The schema is defined as an OpenAPI 3.0.2 [MetadataSchema Object](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#schemaObject)
schemaType?	enum	no	The type of the MetadataSchema. This is a property that identifies which metadata types will use the MetadataSchema.
schemaVersion?	string	no	The version of the MetadataSchema. The version's format must match the following regular expression: `^[0-9]+.+.+$`, which would allow to order/compare different versions. Example: 1.0.0, 1.0.1, etc.
metadataSchemaId?	string	no	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?	string	no	The location for this resource (e.g., 'us', 'us-central1', 'europe-west1')

fn create()

Create a metadataSchemas

fn get(identifier: string)

Get a metadataSchemas

Argument	Type	Required	Description
identifier	string	yes	The name of the metadataSchemas

fn sync()

Sync metadataSchemas state from GCP

fn list(filter?: string, pageSize?: number, maxPages?: number)

List metadataSchemas resources

Argument	Type	Required	Description
filter?	string	no	A query to filter available MetadataSchemas for matching results.
pageSize?	number	no	The maximum number of MetadataSchemas to return. The service may return fewer. Must be in range 1-100, inclusive. Defaults to 100.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

modeldeploymentmonitoringjobs.tsv2026.05.26.1

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
analysisInstanceSchemaUri?	string	no	YAML schema file uri describing the format of a single instance that you want Tensorflow Data Validation (TFDV) to analyze. If this field is empty, all the feature data types are inferred from predict_instance_schema_uri, meaning that TFDV will use the data in the exact format(data type) as prediction request/response. If there are any data type differences between predict instance and TFDV instance, this field can be used to override the schema. For models trained with Vertex AI, this field must be set as all the fields in predict instance formatted as string.
displayName?	string	no	Required. The user-defined name of the ModelDeploymentMonitoringJob. The name can be up to 128 characters long and can consist of any UTF-8 characters. Display name of a ModelDeploymentMonitoringJob.
enableMonitoringPipelineLogs?	boolean	no	If true, the scheduled monitoring pipeline logs are sent to Google Cloud Logging, including pipeline status and anomalies detected. Please note the logs incur cost, which are subject to [Cloud Logging pricing](https://cloud.google.com/logging#pricing).
encryptionSpec?	object	no	Required. Resource name of the Cloud KMS key used to protect the resource. The Cloud KMS key must be in the same region as the resource. It must have the format `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`.
endpoint?	string	no	Required. Endpoint resource name. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`
error?	object	no	The status code, which should be an enum value of google.rpc.Code.
labels?	record	no	The labels with user-defined metadata to organize your ModelDeploymentMonitoringJob. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels.
latestMonitoringPipelineMetadata?	object	no	The time that most recent monitoring pipelines that is related to this run.
logTtl?	string	no	The TTL of BigQuery tables in user projects which stores logs. A day is the basic unit of the TTL and we take the ceil of TTL/86400(a day). e.g. { second: 3600} indicates ttl = 1 day.
loggingSamplingStrategy?	object	no	Sample rate (0, 1]
modelDeploymentMonitoringObjectiveConfigs?	array	no	The DeployedModel ID of the objective config.
modelDeploymentMonitoringScheduleConfig?	object	no	Required. The model monitoring job scheduling interval. It will be rounded up to next full hour. This defines how often the monitoring jobs are triggered.
modelMonitoringAlertConfig?	object	no	The email addresses to send the alert.
predictInstanceSchemaUri?	string	no	YAML schema file uri describing the format of a single instance, which are given to format this Endpoint's prediction (and explanation). If not set, we will generate predict schema from collected predict requests.
samplePredictInstance?	string	no	Sample Predict instance, same format as PredictRequest.instances, this can be set as a replacement of ModelDeploymentMonitoringJob.predict_instance_schema_uri. If not set, we will generate predict schema from collected predict requests.
statsAnomaliesBaseDirectory?	object	no	Required. Google Cloud Storage URI to output directory. If the uri doesn't end with '/', a '/' will be automatically appended. The directory is created if it doesn't exist.
location?	string	no	The location for this resource (e.g., 'us', 'us-central1', 'europe-west1')

fn create()

Create a modelDeploymentMonitoringJobs

fn get(identifier: string)

Get a modelDeploymentMonitoringJobs

Argument	Type	Required	Description
identifier	string	yes	The name of the modelDeploymentMonitoringJobs

fn update()

Update modelDeploymentMonitoringJobs attributes

fn delete(identifier: string)

Delete the modelDeploymentMonitoringJobs

Argument	Type	Required	Description
identifier	string	yes	The name of the modelDeploymentMonitoringJobs

fn sync()

Sync modelDeploymentMonitoringJobs state from GCP

fn list(filter?: string, pageSize?: number, readMask?: string, maxPages?: number)

List modelDeploymentMonitoringJobs resources

Argument	Type	Required	Description
filter?	string	no	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:*`
pageSize?	number	no	The standard list page size.
readMask?	string	no	Mask specifying which fields to read
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

fn pause()

pause

fn resume()

resume

fn search_model_deployment_monitoring_stats_anomalies(deployedModelId?: any, endTime?: any, featureDisplayName?: any, objectives?: any, pageSize?: any, pageToken?: any, startTime?: any)

search model deployment monitoring stats anomalies

Argument	Type	Required
deployedModelId?	any	no
endTime?	any	no
featureDisplayName?	any	no
objectives?	any	no
pageSize?	any	no
pageToken?	any	no
startTime?	any	no

models.tsv2026.05.26.1

Global Arguments

Argument	Type	Required	Description
artifactUri?	string	no	Immutable. The path to the directory containing the Model artifact and any of its supporting files. Not required for AutoML Models.
baseModelSource?	object	no	Required. The public base model URI.
checkpoints?	array	no	The ID of the checkpoint.
containerSpec?	object	no	Immutable. Specifies arguments for the command that runs when the container starts. This overrides the container's [`CMD`](https://docs.docker.com/engine/reference/builder/#cmd). Specify this field as an array of executable and arguments, similar to a Docker `CMD`'s \"default parameters\" form. If you don't specify this field but do specify the command field, then the command from the `command` field runs without any additional arguments. See the [Kubernetes documentation about how the `command` and `args` fields interact with a container's `ENTRYPOINT` and `CMD`](https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#notes). If you don't specify this field and don't specify the `command` field, then the container's [`ENTRYPOINT`](https://docs.docker.com/engine/reference/builder/#cmd) and `CMD` determine what runs based on their default behavior. See the Docker documentation about [how `CMD` and `ENTRYPOINT` interact](https://docs.docker.com/engine/reference/builder/#understand-how-cmd-and-entrypoint-interact). In this field, you can reference [environment variables set by Vertex AI](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables) and environment variables set in the env field. You cannot reference environment variables set in the Docker image. In order for environment variables to be expanded, reference them by using the following syntax: $( VARIABLE_NAME) Note that this differs from Bash variable expansion, which does not use parentheses. If a variable cannot be resolved, the reference in the input string is used unchanged. To avoid variable expansion, you can escape this syntax with `$$`; for example: $$(VARIABLE_NAME) This field corresponds to the `args` field of the Kubernetes Containers [v1 core API](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core).
createTime?	string	no	Output only. Timestamp when this Model was uploaded into Vertex AI.
dataStats?	object	no	Number of Annotations that are used for evaluating this Model. If the Model is evaluated multiple times, this will be the number of test Annotations used by the first evaluation. If the Model is not evaluated, the number is 0.
defaultCheckpointId?	string	no	The default checkpoint id of a model version.
deployedModels?	array	no	Immutable. The ID of the Checkpoint deployed in the DeployedModel.
description?	string	no	The description of the Model.
displayName?	string	no	Required. The display name of the Model. The name can be up to 128 characters long and can consist of any UTF-8 characters.
encryptionSpec?	object	no	Required. Resource name of the Cloud KMS key used to protect the resource. The Cloud KMS key must be in the same region as the resource. It must have the format `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`.
etag?	string	no	Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
explanationSpec?	object	no	Points to a YAML file stored on Google Cloud Storage describing the format of the feature attributions. The schema is defined as an OpenAPI 3.0.2 [Schema Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). AutoML tabular Models always have this field populated by Vertex AI. Note: The URI given on output may be different, including the URI scheme, than the one given on input. The output URI will point to a location where the user only has a read access.
labels?	record	no	The labels with user-defined metadata to organize your Models. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels.
metadata?	string	no	Immutable. An additional information about the Model; the schema of the metadata can be found in metadata_schema. Unset if the Model does not have any additional information.
metadataArtifact?	string	no	Output only. The resource name of the Artifact that was created in MetadataStore when creating the Model. The Artifact resource name pattern is `projects/{project}/locations/{location}/metadataStores/{metadata_store}/artifacts/{artifact}`.
metadataSchemaUri?	string	no	Immutable. Points to a YAML file stored on Google Cloud Storage describing additional information about the Model, that is specific to it. Unset if the Model does not have any additional information. The schema is defined as an OpenAPI 3.0.2 [Schema Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). AutoML Models always have this field populated by Vertex AI, if no additional metadata is needed, this field is set to an empty string. Note: The URI given on output will be immutable and probably different, including the URI scheme, than the one given on input. The output URI will point to a location where the user only has a read access.
modelSourceInfo?	object	no	If this Model is copy of another Model. If true then source_type pertains to the original.
name?	string	no	Identifier. The resource name of the Model.
originalModelInfo?	object	no	Output only. The resource name of the Model this Model is a copy of, including the revision. Format: `projects/{project}/locations/{location}/models/{model_id}@{version_id}`
pipelineJob?	string	no	Optional. This field is populated if the model is produced by a pipeline job.
predictSchemata?	object	no	Immutable. Points to a YAML file stored on Google Cloud Storage describing the format of a single instance, which are used in PredictRequest.instances, ExplainRequest.instances and BatchPredictionJob.input_config. The schema is defined as an OpenAPI 3.0.2 [Schema Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). AutoML Models always have this field populated by Vertex AI. Note: The URI given on output will be immutable and probably different, including the URI scheme, than the one given on input. The output URI will point to a location where the user only has a read access.
satisfiesPzi?	boolean	no	Output only. Reserved for future use.
satisfiesPzs?	boolean	no	Output only. Reserved for future use.
supportedDeploymentResourcesTypes?	array	no	Output only. When this Model is deployed, its prediction resources are described by the `prediction_resources` field of the Endpoint.deployed_models object. Because not all Models support all resource configuration types, the configuration types this Model supports are listed here. If no configuration types are listed, the Model cannot be deployed to an Endpoint and does not support online predictions (PredictionService.Predict or PredictionService.Explain). Such a Model can serve predictions by using a BatchPredictionJob, if it has at least one entry each in supported_input_storage_formats and supported_output_storage_formats.
supportedExportFormats?	array	no	Output only. The content of this Model that may be exported.
supportedInputStorageFormats?	array	no	Output only. The formats this Model supports in BatchPredictionJob.input_config. If PredictSchemata.instance_schema_uri exists, the instances should be given as per that schema. The possible formats are: * `jsonl` The JSON Lines format, where each instance is a single line. Uses GcsSource. * `csv` The CSV format, where each instance is a single comma-separated line. The first line in the file is the header, containing comma-separated field names. Uses GcsSource. * `tf-record` The TFRecord format, where each instance is a single record in tfrecord syntax. Uses GcsSource. * `tf-record-gzip` Similar to `tf-record`, but the file is gzipped. Uses GcsSource. * `bigquery` Each instance is a single row in BigQuery. Uses BigQuerySource. * `file-list` Each line of the file is the location of an instance to process, uses `gcs_source` field of the InputConfig object. If this Model doesn't support any of these formats it means it cannot be used with a BatchPredictionJob. However, if it has supported_deployment_resources_types, it could serve online predictions by using PredictionService.Predict or PredictionService.Explain.
supportedOutputStorageFormats?	array	no	Output only. The formats this Model supports in BatchPredictionJob.output_config. If both PredictSchemata.instance_schema_uri and PredictSchemata.prediction_schema_uri exist, the predictions are returned together with their instances. In other words, the prediction has the original instance data first, followed by the actual prediction content (as per the schema). The possible formats are: * `jsonl` The JSON Lines format, where each prediction is a single line. Uses GcsDestination. * `csv` The CSV format, where each prediction is a single comma-separated line. The first line in the file is the header, containing comma-separated field names. Uses GcsDestination. * `bigquery` Each prediction is a single row in a BigQuery table, uses BigQueryDestination. If this Model doesn't support any of these formats it means it cannot be used with a BatchPredictionJob. However, if it has supported_deployment_resources_types, it could serve online predictions by using PredictionService.Predict or PredictionService.Explain.
trainingPipeline?	string	no	Output only. The resource name of the TrainingPipeline that uploaded this Model, if any.
updateTime?	string	no	Output only. Timestamp when this Model was most recently updated.
versionAliases?	array	no	User provided version aliases so that a model version can be referenced via alias (i.e. `projects/{project}/locations/{location}/models/{model_id}@{version_alias}` instead of auto-generated version id (i.e. `projects/{project}/locations/{location}/models/{model_id}@{version_id})`. The format is a-z{0,126}[a-z0-9] to distinguish from version_id. A default version alias will be created for the first version of the model, and there must be exactly one default version alias for a model.
versionCreateTime?	string	no	Output only. Timestamp when this version was created.
versionDescription?	string	no	The description of this version.
versionId?	string	no	Output only. Immutable. The version ID of the model. A new version is committed when a new model version is uploaded or trained under an existing model id. It is an auto-incrementing decimal number in string representation.
versionUpdateTime?	string	no	Output only. Timestamp when this version was most recently updated.
location?	string	no	The location for this resource (e.g., 'us', 'us-central1', 'europe-west1')

fn get(identifier: string)

Get a models

Argument	Type	Required	Description
identifier	string	yes	The name of the models

fn update()

Update models attributes

fn delete(identifier: string)

Delete the models

Argument	Type	Required	Description
identifier	string	yes	The name of the models

fn sync()

Sync models state from GCP

fn list(filter?: string, orderBy?: string, pageSize?: number, readMask?: string, maxPages?: number)

List models resources

Argument	Type	Required	Description
filter?	string	no	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"`
orderBy?	string	no	A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `display_name` * `create_time` * `update_time` Example: `display_name, create_time desc`.
pageSize?	number	no	The standard list page size.
readMask?	string	no	Mask specifying which fields to read.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

fn copy(customServiceAccount?: any, encryptionSpec?: any, modelId?: any, parentModel?: any, sourceModel?: any)

copy

Argument	Type	Required
customServiceAccount?	any	no
encryptionSpec?	any	no
modelId?	any	no
parentModel?	any	no
sourceModel?	any	no

fn export(outputConfig?: any)

export

Argument	Type	Required	Description
outputConfig?	any	no

fn get_iam_policy()

get iam policy

fn list_checkpoints()

list checkpoints

fn list_versions()

list versions

fn merge_version_aliases(versionAliases?: any)

merge version aliases

Argument	Type	Required	Description
versionAliases?	any	no

fn set_iam_policy(policy?: any)

set iam policy

Argument	Type	Required	Description
policy?	any	no

fn test_iam_permissions()

test iam permissions

fn update_explanation_dataset(examples?: any)

update explanation dataset

Argument	Type	Required	Description
examples?	any	no

fn upload(model?: any, modelId?: any, parentModel?: any, serviceAccount?: any)

upload

Argument	Type	Required
model?	any	no
modelId?	any	no
parentModel?	any	no
serviceAccount?	any	no

models_evaluations.tsv2026.05.26.1

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
location?	string	no	The location for this resource (e.g., 'us', 'us-central1', 'europe-west1')

fn get(identifier: string)

Get a evaluations

Argument	Type	Required	Description
identifier	string	yes	The name of the evaluations

fn sync()

Sync evaluations state from GCP

fn list(filter?: string, pageSize?: number, readMask?: string, maxPages?: number)

List evaluations resources

Argument	Type	Required	Description
filter?	string	no	The standard list filter.
pageSize?	number	no	The standard list page size.
readMask?	string	no	Mask specifying which fields to read.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

fn import(modelEvaluation?: any)

import

Argument	Type	Required	Description
modelEvaluation?	any	no

models_evaluations_slices.tsv2026.05.26.1

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
location?	string	no	The location for this resource (e.g., 'us', 'us-central1', 'europe-west1')

fn get(identifier: string)

Get a slices

Argument	Type	Required	Description
identifier	string	yes	The name of the slices

fn sync()

Sync slices state from GCP

fn list(filter?: string, pageSize?: number, readMask?: string, maxPages?: number)

List slices resources

Argument	Type	Required	Description
filter?	string	no	The standard list filter. * `slice.dimension` - for =.
pageSize?	number	no	The standard list page size.
readMask?	string	no	Mask specifying which fields to read.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

fn batch_import(evaluatedAnnotations?: any)

batch import

Argument	Type	Required	Description
evaluatedAnnotations?	any	no

nasjobs.tsv2026.05.26.1

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
displayName?	string	no	Required. The display name of the NasJob. The name can be up to 128 characters long and can consist of any UTF-8 characters.
encryptionSpec?	object	no	Required. Resource name of the Cloud KMS key used to protect the resource. The Cloud KMS key must be in the same region as the resource. It must have the format `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`.
error?	object	no	The status code, which should be an enum value of google.rpc.Code.
labels?	record	no	The labels with user-defined metadata to organize NasJobs. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels.
nasJobOutput?	object	no	Output only. Time when the NasTrial's status changed to `SUCCEEDED` or `INFEASIBLE`.
nasJobSpec?	object	no	Required. The optimization goal of the metric.
location?	string	no	The location for this resource (e.g., 'us', 'us-central1', 'europe-west1')

fn create()

Create a nasJobs

fn get(identifier: string)

Get a nasJobs

Argument	Type	Required	Description
identifier	string	yes	The name of the nasJobs

fn delete(identifier: string)

Delete the nasJobs

Argument	Type	Required	Description
identifier	string	yes	The name of the nasJobs

fn sync()

Sync nasJobs state from GCP

fn list(filter?: string, pageSize?: number, readMask?: string, maxPages?: number)

List nasJobs resources

Argument	Type	Required	Description
filter?	string	no	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:*`
pageSize?	number	no	The standard list page size.
readMask?	string	no	Mask specifying which fields to read.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

fn cancel()

cancel

nasjobs_nastrialdetails.tsv2026.05.26.1

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
location?	string	no	The location for this resource (e.g., 'us', 'us-central1', 'europe-west1')

fn get(identifier: string)

Get a nasTrialDetails

Argument	Type	Required	Description
identifier	string	yes	The name of the nasTrialDetails

fn sync()

Sync nasTrialDetails state from GCP

fn list(pageSize?: number, maxPages?: number)

List nasTrialDetails resources

Argument	Type	Required	Description
pageSize?	number	no	The standard list page size.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

notebookexecutionjobs.tsv2026.05.31.1

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
customEnvironmentSpec?	object	no	The number of accelerators to attach to the machine. For accelerator optimized machine types (https://cloud.google.com/compute/docs/accelerator-optimized-machines), One may set the accelerator_count from 1 to N for machine with N GPUs. If accelerator_count is less than or equal to N / 2, Vertex will co-schedule the replicas of the model into the same VM to save cost. For example, if the machine type is a3-highgpu-8g, which has 8 H100 GPUs, one can set accelerator_count to 1 to 8. If accelerator_count is 1, 2, 3, or 4, Vertex will co-schedule 8, 4, 2, or 2 replicas of the model into the same VM to save cost. When co-scheduling, CPU, memory and storage on the VM will be distributed to replicas on the VM. For example, one can expect a co-scheduled replica requesting 2 GPUs out of a 8-GPU VM will receive 25% of the CPU, memory and storage of the VM. Note that the feature is not compatible with multihost_gpu_node_count. When multihost_gpu_node_count is set, the co-scheduling will not be enabled.
dataformRepositorySource?	object	no	The commit SHA to read repository with. If unset, the file will be read at HEAD.
directNotebookSource?	object	no	The base64-encoded contents of the input notebook file.
displayName?	string	no	The display name of the NotebookExecutionJob. The name can be up to 128 characters long and can consist of any UTF-8 characters.
encryptionSpec?	object	no	Required. Resource name of the Cloud KMS key used to protect the resource. The Cloud KMS key must be in the same region as the resource. It must have the format `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`.
executionTimeout?	string	no	Max running time of the execution job in seconds (default 86400s / 24 hrs).
executionUser?	string	no	The user email to run the execution as. Only supported by Colab runtimes.
gcsNotebookSource?	object	no	The version of the Cloud Storage object to read. If unset, the current version of the object is read. See https://cloud.google.com/storage/docs/metadata#generation-number.
gcsOutputUri?	string	no	The Cloud Storage location to upload the result to. Format: `gs://bucket-name`
kernelName?	string	no	The name of the kernel to use during notebook execution. If unset, the default kernel is used.
labels?	record	no	The labels with user-defined metadata to organize NotebookExecutionJobs. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable.
notebookRuntimeTemplateResourceName?	string	no	The NotebookRuntimeTemplate to source compute configuration from.
scheduleResourceName?	string	no	The Schedule resource name if this job is triggered by one. Format: `projects/{project_id}/locations/{location}/schedules/{schedule_id}`
serviceAccount?	string	no	The service account to run the execution as.
status?	object	no	The status code, which should be an enum value of google.rpc.Code.
workbenchRuntime?	object	no	Configuration for a Workbench Instances-based environment.
notebookExecutionJobId?	string	no	Optional. User specified ID for the NotebookExecutionJob.
location?	string	no	The location for this resource (e.g., 'us', 'us-central1', 'europe-west1')

fn create()

Create a notebookExecutionJobs

fn get(identifier: string)

Get a notebookExecutionJobs

Argument	Type	Required	Description
identifier	string	yes	The name of the notebookExecutionJobs

fn delete(identifier: string)

Delete the notebookExecutionJobs

Argument	Type	Required	Description
identifier	string	yes	The name of the notebookExecutionJobs

fn sync()

Sync notebookExecutionJobs state from GCP

fn list(filter?: string, orderBy?: string, pageSize?: number, view?: string, maxPages?: number)

List notebookExecutionJobs resources

Argument	Type	Required	Description
filter?	string	no	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"`
orderBy?	string	no	Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `display_name` * `create_time` * `update_time` Example: `display_name, create_time desc`.
pageSize?	number	no	Optional. The standard list page size.
view?	string	no	Optional. The NotebookExecutionJob view. Defaults to BASIC.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

notebookruntimes.tsv2026.05.26.1

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
location?	string	no	The location for this resource (e.g., 'us', 'us-central1', 'europe-west1')

fn get(identifier: string)

Get a notebookRuntimes

Argument	Type	Required	Description
identifier	string	yes	The name of the notebookRuntimes

fn delete(identifier: string)

Delete the notebookRuntimes

Argument	Type	Required	Description
identifier	string	yes	The name of the notebookRuntimes

fn sync()

Sync notebookRuntimes state from GCP

fn list(filter?: string, orderBy?: string, pageSize?: number, readMask?: string, maxPages?: number)

List notebookRuntimes resources

Argument	Type	Required	Description
filter?	string	no	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`
orderBy?	string	no	Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `display_name` * `create_time` * `update_time` Example: `display_name, create_time desc`.
pageSize?	number	no	Optional. The standard list page size.
readMask?	string	no	Optional. Mask specifying which fields to read.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

fn assign(notebookRuntime?: any, notebookRuntimeId?: any, notebookRuntimeTemplate?: any)

assign

Argument	Type	Required
notebookRuntime?	any	no
notebookRuntimeId?	any	no
notebookRuntimeTemplate?	any	no

fn start()

start

fn stop()

stop

fn upgrade()

upgrade

notebookruntimetemplates.tsv2026.05.31.1

Global Arguments

Argument	Type	Required	Description
dataPersistentDiskSpec?	object	no	Size in GB of the disk (default is 100GB).
description?	string	no	The description of the NotebookRuntimeTemplate.
displayName?	string	no	Required. The display name of the NotebookRuntimeTemplate. The name can be up to 128 characters long and can consist of any UTF-8 characters.
encryptionSpec?	object	no	Required. Resource name of the Cloud KMS key used to protect the resource. The Cloud KMS key must be in the same region as the resource. It must have the format `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`.
eucConfig?	object	no	Output only. Whether ActAs check is bypassed for service account attached to the VM. If false, we need ActAs check for the default Compute Engine Service account. When a Runtime is created, a VM is allocated using Default Compute Engine Service Account. Any user requesting to use this Runtime requires Service Account User (ActAs) permission over this SA. If true, Runtime owner is using EUC and does not require the above permission as VM no longer use default Compute Engine SA, but a P4SA.
idleShutdownConfig?	object	no	Whether Idle Shutdown is disabled in this NotebookRuntimeTemplate.
labels?	record	no	The labels with user-defined metadata to organize the NotebookRuntimeTemplates. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels.
machineSpec?	object	no	The number of accelerators to attach to the machine. For accelerator optimized machine types (https://cloud.google.com/compute/docs/accelerator-optimized-machines), One may set the accelerator_count from 1 to N for machine with N GPUs. If accelerator_count is less than or equal to N / 2, Vertex will co-schedule the replicas of the model into the same VM to save cost. For example, if the machine type is a3-highgpu-8g, which has 8 H100 GPUs, one can set accelerator_count to 1 to 8. If accelerator_count is 1, 2, 3, or 4, Vertex will co-schedule 8, 4, 2, or 2 replicas of the model into the same VM to save cost. When co-scheduling, CPU, memory and storage on the VM will be distributed to replicas on the VM. For example, one can expect a co-scheduled replica requesting 2 GPUs out of a 8-GPU VM will receive 25% of the CPU, memory and storage of the VM. Note that the feature is not compatible with multihost_gpu_node_count. When multihost_gpu_node_count is set, the co-scheduling will not be enabled.
name?	string	no	The resource name of the NotebookRuntimeTemplate.
networkSpec?	object	no	Whether to enable public internet access. Default false.
networkTags?	array	no	Optional. The Compute Engine tags to add to runtime (see [Tagging instances](https://cloud.google.com/vpc/docs/add-remove-network-tags)).
notebookRuntimeType?	enum	no	Optional. Immutable. The type of the notebook runtime template.
reservationAffinity?	object	no	Required. Specifies the type of reservation from which this instance can consume resources: RESERVATION_ANY (default), RESERVATION_SPECIFIC, or RESERVATION_NONE. See Consuming reserved instances for examples.
shieldedVmConfig?	object	no	Defines whether the instance has [Secure Boot](https://cloud.google.com/compute/shielded-vm/docs/shielded-vm#secure-boot) enabled. Secure Boot helps ensure that the system only runs authentic software by verifying the digital signature of all boot components, and halting the boot process if signature verification fails.
softwareConfig?	object	no	Output only. A human-readable description of the specified colab image release, populated by the system. Example: "Python 3.10", "Latest - current Python 3.11"
notebookRuntimeTemplateId?	string	no	Optional. User specified ID for the notebook runtime template.
location?	string	no	The location for this resource (e.g., 'us', 'us-central1', 'europe-west1')

fn create()

Create a notebookRuntimeTemplates

fn get(identifier: string)

Get a notebookRuntimeTemplates

Argument	Type	Required	Description
identifier	string	yes	The name of the notebookRuntimeTemplates

fn update()

Update notebookRuntimeTemplates attributes

fn delete(identifier: string)

Delete the notebookRuntimeTemplates

Argument	Type	Required	Description
identifier	string	yes	The name of the notebookRuntimeTemplates

fn sync()

Sync notebookRuntimeTemplates state from GCP

fn list(filter?: string, orderBy?: string, pageSize?: number, readMask?: string, maxPages?: number)

List notebookRuntimeTemplates resources

Argument	Type	Required	Description
filter?	string	no	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`
orderBy?	string	no	Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `display_name` * `create_time` * `update_time` Example: `display_name, create_time desc`.
pageSize?	number	no	Optional. The standard list page size.
readMask?	string	no	Optional. Mask specifying which fields to read.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

fn get_iam_policy()

get iam policy

fn set_iam_policy(policy?: any)

set iam policy

Argument	Type	Required	Description
policy?	any	no

fn test_iam_permissions()

test iam permissions

persistentresources.tsv2026.05.26.1

Global Arguments

Argument	Type	Required	Description
displayName?	string	no	Optional. The display name of the PersistentResource. The name can be up to 128 characters long and can consist of any UTF-8 characters.
encryptionSpec?	object	no	Required. Resource name of the Cloud KMS key used to protect the resource. The Cloud KMS key must be in the same region as the resource. It must have the format `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`.
error?	object	no	The status code, which should be an enum value of google.rpc.Code.
labels?	record	no	Optional. The labels with user-defined metadata to organize PersistentResource. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels.
name?	string	no	Immutable. Resource name of a PersistentResource.
network?	string	no	Optional. The full name of the Compute Engine [network](/compute/docs/networks-and-firewalls#networks) to peered with Vertex AI to host the persistent resources. For example, `projects/12345/global/networks/myVPC`. [Format](/compute/docs/reference/rest/v1/networks/insert) is of the form `projects/{project}/global/networks/{network}`. Where {project} is a project number, as in `12345`, and {network} is a network name. To specify this field, you must have already [configured VPC Network Peering for Vertex AI](https://cloud.google.com/vertex-ai/docs/general/vpc-peering). If this field is left unspecified, the resources aren't peered with any network.
pscInterfaceConfig?	object	no	Required. The DNS name suffix of the zone being peered to, e.g., "my-internal-domain.corp.". Must end with a dot.
reservedIpRanges?	array	no	Optional. A list of names for the reserved IP ranges under the VPC network that can be used for this persistent resource. If set, we will deploy the persistent resource within the provided IP ranges. Otherwise, the persistent resource is deployed to any IP ranges under the provided VPC network. Example: ['vertex-ai-ip-range'].
resourcePools?	array	no	Optional. max replicas in the node pool, must be ≥ replica_count and > min_replica_count or will throw error
resourceRuntime?	object	no	Output only. URIs for user to connect to the Cluster. Example: { "RAY_HEAD_NODE_INTERNAL_IP": "head-node-IP:10001" "RAY_DASHBOARD_URI": "ray-dashboard-address:8888" }
resourceRuntimeSpec?	object	no	Optional. This will be used to indicate which resource pool will serve as the Ray head node(the first node within that pool). Will use the machine from the first workerpool as the head node by default if this field isn't set.
persistentResourceId?	string	no	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?	string	no	The location for this resource (e.g., 'us', 'us-central1', 'europe-west1')

fn create(waitForReady?: boolean)

Create a persistentResources

Argument	Type	Required	Description
waitForReady?	boolean	no	Wait for the resource to reach a ready state after creation (default: true)

fn get(identifier: string)

Get a persistentResources

Argument	Type	Required	Description
identifier	string	yes	The name of the persistentResources

fn update(waitForReady?: boolean)

Update persistentResources attributes

Argument	Type	Required	Description
waitForReady?	boolean	no	Wait for the resource to reach a ready state after update (default: true)

fn delete(identifier: string)

Delete the persistentResources

Argument	Type	Required	Description
identifier	string	yes	The name of the persistentResources

fn sync()

Sync persistentResources state from GCP

fn list(pageSize?: number, maxPages?: number)

List persistentResources resources

Argument	Type	Required	Description
pageSize?	number	no	Optional. The standard list page size.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

fn reboot()

reboot

pipelinejobs.tsv2026.05.26.1

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
displayName?	string	no	The display name of the Pipeline. The name can be up to 128 characters long and can consist of any UTF-8 characters.
encryptionSpec?	object	no	Required. Resource name of the Cloud KMS key used to protect the resource. The Cloud KMS key must be in the same region as the resource. It must have the format `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`.
error?	object	no	The status code, which should be an enum value of google.rpc.Code.
jobDetail?	object	no	Output only. Timestamp when this Context was created.
labels?	record	no	The labels with user-defined metadata to organize PipelineJob. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels. Note there is some reserved label key for Vertex AI Pipelines. - `vertex-ai-pipelines-run-billing-id`, user set value will get overrided.
network?	string	no	The full name of the Compute Engine [network](/compute/docs/networks-and-firewalls#networks) to which the Pipeline Job's workload should be peered. For example, `projects/12345/global/networks/myVPC`. [Format](/compute/docs/reference/rest/v1/networks/insert) is of the form `projects/{project}/global/networks/{network}`. Where {project} is a project number, as in `12345`, and {network} is a network name. Private services access must already be configured for the network. Pipeline job will apply the network configuration to the Google Cloud resources being launched, if applied, such as Vertex AI Training or Dataflow job. If left unspecified, the workload is not peered with any network.
pipelineSpec?	record	no	A compiled definition of a pipeline, represented as a `JSON` object. Defines the structure of the pipeline, including its components, tasks, and parameters. This specification is generated by compiling a pipeline function defined in `Python` using the `Kubeflow Pipelines SDK`.
preflightValidations?	boolean	no	Optional. Whether to do component level validations before job creation.
pscInterfaceConfig?	object	no	Required. The DNS name suffix of the zone being peered to, e.g., "my-internal-domain.corp.". Must end with a dot.
reservedIpRanges?	array	no	A list of names for the reserved ip ranges under the VPC network that can be used for this Pipeline Job's workload. If set, we will deploy the Pipeline Job's workload within the provided ip ranges. Otherwise, the job will be deployed to any ip ranges under the provided VPC network. Example: ['vertex-ai-ip-range'].
runtimeConfig?	object	no	Represents the failure policy of a pipeline. Currently, the default of a pipeline is that the pipeline will continue to run until no more tasks can be executed, also known as PIPELINE_FAILURE_POLICY_FAIL_SLOW. However, if a pipeline is set to PIPELINE_FAILURE_POLICY_FAIL_FAST, it will stop scheduling any new tasks when a task has failed. Any scheduled tasks will continue to completion.
serviceAccount?	string	no	The service account that the pipeline workload runs as. If not specified, the Compute Engine default service account in the project will be used. See https://cloud.google.com/compute/docs/access/service-accounts#default_service_account Users starting the pipeline must have the `iam.serviceAccounts.actAs` permission on this service account.
templateMetadata?	object	no	The version_name in artifact registry. Will always be presented in output if the PipelineJob.template_uri is from supported template registry. Format is "sha256:abcdef123456...".
templateUri?	string	no	A template uri from where the PipelineJob.pipeline_spec, if empty, will be downloaded. Currently, only uri from Vertex Template Registry & Gallery is supported. Reference to https://cloud.google.com/vertex-ai/docs/pipelines/create-pipeline-template.
pipelineJobId?	string	no	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?	string	no	The location for this resource (e.g., 'us', 'us-central1', 'europe-west1')

fn create()

Create a pipelineJobs

fn get(identifier: string)

Get a pipelineJobs

Argument	Type	Required	Description
identifier	string	yes	The name of the pipelineJobs

fn delete(identifier: string)

Delete the pipelineJobs

Argument	Type	Required	Description
identifier	string	yes	The name of the pipelineJobs

fn sync()

Sync pipelineJobs state from GCP

fn list(filter?: string, orderBy?: string, pageSize?: number, readMask?: string, maxPages?: number)

List pipelineJobs resources

Argument	Type	Required	Description
filter?	string	no	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".
orderBy?	string	no	A comma-separated list of fields to order by. The default sort order is in ascending order. Use "desc" after a field name for descending. You can have multiple order_by fields provided e.g. "create_time desc, end_time", "end_time, start_time, update_time" For example, using "create_time desc, end_time" will order results by create time in descending order, and if there are multiple jobs having the same create time, order them by the end time in ascending order. if order_by is not specified, it will order by default order is create time in descending order. Supported fields: * `create_time` * `update_time` * `end_time` * `start_time`
pageSize?	number	no	The standard list page size.
readMask?	string	no	Mask specifying which fields to read.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

fn batch_cancel(names?: any)

batch cancel

Argument	Type	Required	Description
names?	any	no

fn batch_delete(names?: any)

batch delete

Argument	Type	Required	Description
names?	any	no

fn cancel(names?: any)

cancel

Argument	Type	Required	Description
names?	any	no

publishers_models.tsv2026.05.26.1

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)

fn get(identifier: string)

Get a models

Argument	Type	Required	Description
identifier	string	yes	The name of the models

fn sync()

Sync models state from GCP

fn compute_tokens(contents?: any, instances?: any, model?: any)

compute tokens

Argument	Type	Required
contents?	any	no
instances?	any	no
model?	any	no

fn count_tokens(contents?: any, generationConfig?: any, instances?: any, model?: any, systemInstruction?: any, tools?: any)

count tokens

Argument	Type	Required
contents?	any	no
generationConfig?	any	no
instances?	any	no
model?	any	no
systemInstruction?	any	no
tools?	any	no

fn fetch_predict_operation(operationName?: any)

fetch predict operation

Argument	Type	Required	Description
operationName?	any	no

fn generate_content(cachedContent?: any, contents?: any, generationConfig?: any, labels?: any, modelArmorConfig?: any, safetySettings?: any, systemInstruction?: any, toolConfig?: any, tools?: any)

generate content

Argument	Type	Required
cachedContent?	any	no
contents?	any	no
generationConfig?	any	no
labels?	any	no
modelArmorConfig?	any	no
safetySettings?	any	no
systemInstruction?	any	no
toolConfig?	any	no
tools?	any	no

fn predict(instances?: any, labels?: any, parameters?: any)

predict

Argument	Type	Required
instances?	any	no
labels?	any	no
parameters?	any	no

fn predict_long_running(instances?: any, labels?: any, parameters?: any)

predict long running

Argument	Type	Required
instances?	any	no
labels?	any	no
parameters?	any	no

stream generate content

Argument	Type	Required
cachedContent?	any	no
contents?	any	no
generationConfig?	any	no
labels?	any	no
modelArmorConfig?	any	no
safetySettings?	any	no
systemInstruction?	any	no
toolConfig?	any	no
tools?	any	no

ragcorpora.tsv2026.05.26.1

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
corpusStatus?	object	no	Output only. Only when the `state` field is ERROR.
description?	string	no	Optional. The description of the RagCorpus.
displayName?	string	no	Required. The display name of the RagCorpus. The name can be up to 128 characters long and can consist of any UTF-8 characters.
encryptionSpec?	object	no	Required. Resource name of the Cloud KMS key used to protect the resource. The Cloud KMS key must be in the same region as the resource. It must have the format `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`.
vectorDbConfig?	object	no	Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version}
vertexAiSearchConfig?	object	no	Vertex AI Search Serving Config resource full name. For example, `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/servingConfigs/{serving_config}` or `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/servingConfigs/{serving_config}`.
location?	string	no	The location for this resource (e.g., 'us', 'us-central1', 'europe-west1')

fn create()

Create a ragCorpora

fn get(identifier: string)

Get a ragCorpora

Argument	Type	Required	Description
identifier	string	yes	The name of the ragCorpora

fn update()

Update ragCorpora attributes

fn delete(identifier: string)

Delete the ragCorpora

Argument	Type	Required	Description
identifier	string	yes	The name of the ragCorpora

fn sync()

Sync ragCorpora state from GCP

fn list(pageSize?: number, maxPages?: number)

List ragCorpora resources

Argument	Type	Required	Description
pageSize?	number	no	Optional. The standard list page size. The maximum value is 100. If not specified, a default value of 100 will be used.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

ragcorpora_ragfiles.tsv2026.05.26.1

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
location?	string	no	The location for this resource (e.g., 'us', 'us-central1', 'europe-west1')

fn get(identifier: string)

Get a ragFiles

Argument	Type	Required	Description
identifier	string	yes	The name of the ragFiles

fn delete(identifier: string)

Delete the ragFiles

Argument	Type	Required	Description
identifier	string	yes	The name of the ragFiles

fn sync()

Sync ragFiles state from GCP

fn list(pageSize?: number, maxPages?: number)

List ragFiles resources

Argument	Type	Required	Description
pageSize?	number	no	Optional. The standard list page size. The maximum value is 100. If not specified, a default value of 100 will be used.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

fn import(importRagFilesConfig?: any)

import

Argument	Type	Required	Description
importRagFilesConfig?	any	no

reasoningengines.tsv2026.05.26.1

Global Arguments

Argument	Type	Required	Description
contextSpec?	object	no	Optional. Represents the maximum number of revisions to consider for each candidate memory. If not set, then the default value (1) will be used, which means that only the latest revision will be considered.
description?	string	no	Optional. The description of the ReasoningEngine.
displayName?	string	no	Required. The display name of the ReasoningEngine.
encryptionSpec?	object	no	Required. Resource name of the Cloud KMS key used to protect the resource. The Cloud KMS key must be in the same region as the resource. It must have the format `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`.
labels?	record	no	Labels for the ReasoningEngine.
name?	string	no	Identifier. The resource name of the ReasoningEngine. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`
spec?	object	no	Optional. The OSS agent framework used to develop the agent. Currently supported values: "google-adk", "langchain", "langgraph", "ag2", "llama-index", "custom".
location?	string	no	The location for this resource (e.g., 'us', 'us-central1', 'europe-west1')

fn create()

Create a reasoningEngines

fn get(identifier: string)

Get a reasoningEngines

Argument	Type	Required	Description
identifier	string	yes	The name of the reasoningEngines

fn update()

Update reasoningEngines attributes

fn delete(identifier: string)

Delete the reasoningEngines

Argument	Type	Required	Description
identifier	string	yes	The name of the reasoningEngines

fn sync()

Sync reasoningEngines state from GCP

fn list(filter?: string, pageSize?: number, maxPages?: number)

List reasoningEngines resources

Argument	Type	Required	Description
filter?	string	no	Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160).
pageSize?	number	no	Optional. The standard list page size.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

fn async_query(inputGcsUri?: any, outputGcsUri?: any)

async query

Argument	Type	Required	Description
inputGcsUri?	any	no
outputGcsUri?	any	no

fn cancel_async_query(operationName?: any)

cancel async query

Argument	Type	Required	Description
operationName?	any	no

fn execute_code(inputs?: any)

execute code

Argument	Type	Required	Description
inputs?	any	no

fn get_iam_policy()

get iam policy

fn query(inputGcsUri?: any, outputGcsUri?: any)

query

Argument	Type	Required	Description
inputGcsUri?	any	no
outputGcsUri?	any	no

fn set_iam_policy(policy?: any)

set iam policy

Argument	Type	Required	Description
policy?	any	no

fn stream_query(classMethod?: any, input?: any)

stream query

Argument	Type	Required	Description
classMethod?	any	no
input?	any	no

fn test_iam_permissions()

test iam permissions

reasoningengines_memories.tsv2026.05.26.1

Global Arguments

Argument	Type	Required	Description
description?	string	no	Optional. Represents the description of the Memory.
disableMemoryRevisions?	boolean	no	Optional. Input only. Indicates whether no revision will be created for this request.
displayName?	string	no	Optional. Represents the display name of the Memory.
expireTime?	string	no	Optional. Represents the timestamp of when this resource is considered expired. This is always provided on output when `expiration` is set on input, regardless of whether `expire_time` or `ttl` was provided.
fact?	string	no	Optional. Represents semantic knowledge extracted from the source content.
metadata?	record	no	Represents a boolean value.
name?	string	no	Identifier. Represents the resource name of the Memory. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}`
revisionExpireTime?	string	no	Optional. Input only. Represents the timestamp of when the revision is considered expired. If not set, the memory revision will be kept until manually deleted.
revisionLabels?	record	no	Optional. Input only. Represents the labels to apply to the Memory Revision created as a result of this request.
revisionTtl?	string	no	Optional. Input only. Represents the TTL for the revision. The expiration time is computed: now + TTL.
scope?	record	no	Required. Immutable. Represents the scope of the Memory. Memories are isolated within their scope. The scope is defined when creating or generating memories. Scope values cannot contain the wildcard character '*'.
topics?	array	no	Optional. Represents the custom memory topic label.
ttl?	string	no	Optional. Input only. Represents the TTL for this resource. The expiration time is computed: now + TTL.
memoryId?	string	no	Optional. The user defined ID to use for memory, which will become the final component of the memory resource name. If not provided, Vertex AI will generate a value for this ID. This value may be up to 63 characters, and valid characters are `[a-z0-9-]`. The first character must be a letter, and the last character must be a letter or number.
location?	string	no	The location for this resource (e.g., 'us', 'us-central1', 'europe-west1')

fn create()

Create a memories

fn get(identifier: string)

Get a memories

Argument	Type	Required	Description
identifier	string	yes	The name of the memories

fn update()

Update memories attributes

fn delete(identifier: string)

Delete the memories

Argument	Type	Required	Description
identifier	string	yes	The name of the memories

fn sync()

Sync memories state from GCP

fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)

List memories resources

Argument	Type	Required	Description
filter?	string	no	Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160). Supported fields: * `scope` (as a JSON string with equality match only) * `topics` (i.e. `topics.custom_memory_topic_label: "example topic" OR topics.managed_memory_topic: USER_PREFERENCES`)
orderBy?	string	no	Optional. The standard list order by string. If not specified, the default order is `create_time desc`. If specified, the default sorting order of provided fields is ascending. More detail in [AIP-132](https://google.aip.dev/132). Supported fields: * `create_time` * `update_time`
pageSize?	number	no	Optional. The standard list page size.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

fn generate(allowedTopics?: any, directContentsSource?: any, directMemoriesSource?: any, disableConsolidation?: any, disableMemoryRevisions?: any, metadata?: any, metadataMergeStrategy?: any, revisionExpireTime?: any, revisionLabels?: any, revisionTtl?: any, scope?: any, vertexSessionSource?: any)

generate

Argument	Type	Required
allowedTopics?	any	no
directContentsSource?	any	no
directMemoriesSource?	any	no
disableConsolidation?	any	no
disableMemoryRevisions?	any	no
metadata?	any	no
metadataMergeStrategy?	any	no
revisionExpireTime?	any	no
revisionLabels?	any	no
revisionTtl?	any	no
scope?	any	no
vertexSessionSource?	any	no

fn purge(filter?: any, filterGroups?: any, force?: any)

purge

Argument	Type	Required
filter?	any	no
filterGroups?	any	no
force?	any	no

fn retrieve(filter?: any, filterGroups?: any, memoryTypes?: any, scope?: any, similaritySearchParams?: any, simpleRetrievalParams?: any)

retrieve

Argument	Type	Required
filter?	any	no
filterGroups?	any	no
memoryTypes?	any	no
scope?	any	no
similaritySearchParams?	any	no
simpleRetrievalParams?	any	no

fn rollback(targetRevisionId?: any)

rollback

Argument	Type	Required	Description
targetRevisionId?	any	no

reasoningengines_memories_revisions.tsv2026.05.26.1

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
location?	string	no	The location for this resource (e.g., 'us', 'us-central1', 'europe-west1')

fn get(identifier: string)

Get a revisions

Argument	Type	Required	Description
identifier	string	yes	The name of the revisions

fn sync()

Sync revisions state from GCP

fn list(filter?: string, pageSize?: number, maxPages?: number)

List revisions resources

Argument	Type	Required	Description
filter?	string	no	Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160). Supported fields (equality match only): * `labels`
pageSize?	number	no	Optional. The standard list page size.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

reasoningengines_sandboxenvironments.tsv2026.05.26.1

Global Arguments

Argument	Type	Required	Description
connectionInfo?	object	no	Output only. The hostname of the load balancer.
displayName?	string	no	Required. The display name of the SandboxEnvironment.
expireTime?	string	no	Optional. Timestamp in UTC of when this SandboxEnvironment is considered expired. This is always provided on output, regardless of what `expiration` was sent on input.
name?	string	no	Identifier. The name of the SandboxEnvironment.
owner?	string	no	Optional. Owner information for this sandbox environment. A Sandbox can only be restored from a snapshot that belongs to the same owner. If not set, sandbox will be created as the default owner.
sandboxEnvironmentSnapshot?	string	no	Optional. The resource name of the SandboxEnvironmentSnapshot to use for creating this SandboxEnvironment. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironmentSnapshots/{sandbox_environment_snapshot}`
sandboxEnvironmentTemplate?	string	no	Optional. The name of the SandboxEnvironmentTemplate specified in the parent Agent Engine resource that this SandboxEnvironment is created from.
spec?	object	no	The coding language supported in this environment.
ttl?	string	no	Optional. Input only. The TTL for the sandbox environment. The expiration time is computed: now + TTL.
location?	string	no	The location for this resource (e.g., 'us', 'us-central1', 'europe-west1')

fn create()

Create a sandboxEnvironments

fn get(identifier: string)

Get a sandboxEnvironments

Argument	Type	Required	Description
identifier	string	yes	The name of the sandboxEnvironments

fn delete(identifier: string)

Delete the sandboxEnvironments

Argument	Type	Required	Description
identifier	string	yes	The name of the sandboxEnvironments

fn sync()

Sync sandboxEnvironments state from GCP

fn list(filter?: string, pageSize?: number, maxPages?: number)

List sandboxEnvironments resources

Argument	Type	Required	Description
filter?	string	no	Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160).
pageSize?	number	no	Optional. The maximum number of SandboxEnvironments to return. The service may return fewer than this value. If unspecified, at most 100 SandboxEnvironments will be returned.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

fn execute(identifier: string)

execute

Argument	Type	Required	Description
identifier	string	yes	The name of the sandboxEnvironments

fn snapshot(createTime?: any, displayName?: any, expireTime?: any, name?: any, owner?: any, parentSnapshot?: any, postSnapshotAction?: any, sizeBytes?: any, sourceSandboxEnvironment?: any, ttl?: any, updateTime?: any)

snapshot

Argument	Type	Required
createTime?	any	no
displayName?	any	no
expireTime?	any	no
name?	any	no
owner?	any	no
parentSnapshot?	any	no
postSnapshotAction?	any	no
sizeBytes?	any	no
sourceSandboxEnvironment?	any	no
ttl?	any	no
updateTime?	any	no

reasoningengines_sandboxenvironmentsnapshots.tsv2026.05.26.1

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
location?	string	no	The location for this resource (e.g., 'us', 'us-central1', 'europe-west1')

fn get(identifier: string)

Get a sandboxEnvironmentSnapshots

Argument	Type	Required	Description
identifier	string	yes	The name of the sandboxEnvironmentSnapshots

fn delete(identifier: string)

Delete the sandboxEnvironmentSnapshots

Argument	Type	Required	Description
identifier	string	yes	The name of the sandboxEnvironmentSnapshots

fn sync()

Sync sandboxEnvironmentSnapshots state from GCP

fn list(filter?: string, pageSize?: number, maxPages?: number)

List sandboxEnvironmentSnapshots resources

Argument	Type	Required	Description
filter?	string	no	Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160).
pageSize?	number	no	Optional. The maximum number of SandboxEnvironmentSnapshots to return. The service may return fewer than this value. If unspecified, at most 100 SandboxEnvironmentSnapshots will be returned. Values above 100 will be coerced to 100.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

reasoningengines_sandboxenvironmenttemplates.tsv2026.05.31.1

Global Arguments

Argument	Type	Required	Description
customContainerEnvironment?	object	no	Required. The Artifact Registry Docker image URI (e.g., us-central1-docker.pkg.dev/my-project/my-repo/my-image:tag) of the container image that is to be run on each worker replica.
defaultContainerEnvironment?	object	no	Required. The category of the default container image.
displayName?	string	no	Required. The display name of the SandboxEnvironmentTemplate.
egressControlConfig?	object	no	Optional. Whether to allow internet access.
name?	string	no	Identifier. The resource name of the SandboxEnvironmentTemplate. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironmentTemplates/{sandbox_environment_template}`
location?	string	no	The location for this resource (e.g., 'us', 'us-central1', 'europe-west1')

fn create(waitForReady?: boolean)

Create a sandboxEnvironmentTemplates

Argument	Type	Required	Description
waitForReady?	boolean	no	Wait for the resource to reach a ready state after creation (default: true)

fn get(identifier: string)

Get a sandboxEnvironmentTemplates

Argument	Type	Required	Description
identifier	string	yes	The name of the sandboxEnvironmentTemplates

fn delete(identifier: string)

Delete the sandboxEnvironmentTemplates

Argument	Type	Required	Description
identifier	string	yes	The name of the sandboxEnvironmentTemplates

fn sync()

Sync sandboxEnvironmentTemplates state from GCP

fn list(filter?: string, pageSize?: number, maxPages?: number)

List sandboxEnvironmentTemplates resources

Argument	Type	Required	Description
filter?	string	no	Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160).
pageSize?	number	no	Optional. The maximum number of SandboxEnvironmentTemplates to return. The service may return fewer than this value. If unspecified, at most 100 SandboxEnvironmentTemplates will be returned.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

reasoningengines_sessions.tsv2026.05.26.1

Global Arguments

Argument	Type	Required	Description
displayName?	string	no	Optional. The display name of the session.
expireTime?	string	no	Optional. Timestamp of when this session is considered expired. This is always provided on output, regardless of what was sent on input. The minimum value is 24 hours from the time of creation.
labels?	record	no	The labels with user-defined metadata to organize your Sessions. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels.
name?	string	no	Identifier. The resource name of the session. Format: 'projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}'.
sessionState?	record	no	Optional. Session specific memory which stores key conversation points.
ttl?	string	no	Optional. Input only. The TTL for this session. The minimum value is 24 hours.
userId?	string	no	Required. Immutable. String id provided by the user
sessionId?	string	no	Optional. The user defined ID to use for session, which will become the final component of the session resource name. If not provided, Vertex AI will generate a value for this ID. This value may be up to 63 characters, and valid characters are `[a-z0-9-]`. The first and last characters must be a letter or number.
location?	string	no	The location for this resource (e.g., 'us', 'us-central1', 'europe-west1')

fn create()

Create a sessions

fn get(identifier: string)

Get a sessions

Argument	Type	Required	Description
identifier	string	yes	The name of the sessions

fn update()

Update sessions attributes

fn delete(identifier: string)

Delete the sessions

Argument	Type	Required	Description
identifier	string	yes	The name of the sessions

fn sync()

Sync sessions state from GCP

fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)

List sessions resources

Argument	Type	Required	Description
filter?	string	no	Optional. The standard list filter. Supported fields: * `display_name` * `user_id` * `labels` Example: `display_name="abc"`, `user_id="123"`, `labels.key="value"`.
orderBy?	string	no	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` Example: `create_time desc`.
pageSize?	number	no	Optional. The maximum number of sessions to return. The service may return fewer than this value. If unspecified, the default page size is 100. Values greater than 100 will be capped at 100.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

fn append_event(actions?: any, author?: any, content?: any, errorCode?: any, errorMessage?: any, eventMetadata?: any, invocationId?: any, name?: any, rawEvent?: any, timestamp?: any)

append event

Argument	Type	Required
actions?	any	no
author?	any	no
content?	any	no
errorCode?	any	no
errorMessage?	any	no
eventMetadata?	any	no
invocationId?	any	no
name?	any	no
rawEvent?	any	no
timestamp?	any	no

reasoningengines_sessions_events.tsv2026.05.26.1

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
location?	string	no	The location for this resource (e.g., 'us', 'us-central1', 'europe-west1')

fn get(identifier: string)

Get a events

Argument	Type	Required	Description
identifier	string	yes	The name of the events

fn sync()

Sync events state from GCP

fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)

List events resources

Argument	Type	Required	Description
filter?	string	no	Optional. The standard list filter. Supported fields: * `timestamp` range (i.e. `timestamp>="2025-01-31T11:30:00-04:00"` where the timestamp is in RFC 3339 format) More detail in [AIP-160](https://google.aip.dev/160).
orderBy?	string	no	Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `timestamp` Example: `timestamp desc`.
pageSize?	number	no	Optional. The maximum number of events to return. The service may return fewer than this value. If unspecified, at most 100 events will be returned. These events are ordered by timestamp in ascending order.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

schedules.tsv2026.05.31.1

Global Arguments

Argument	Type	Required	Description
allowQueueing?	boolean	no	Optional. Whether new scheduled runs can be queued when max_concurrent_runs limit is reached. If set to true, new runs will be queued instead of skipped. Default to false.
createNotebookExecutionJobRequest?	object	no	Output only. Timestamp when this NotebookExecutionJob was created.
createPipelineJobRequest?	object	no	Required. The resource name of the Location to create the PipelineJob in. Format: `projects/{project}/locations/{location}`
cron?	string	no	Cron schedule (https://en.wikipedia.org/wiki/Cron) to launch scheduled runs. To explicitly set a timezone to the cron tab, apply a prefix in the cron tab: "CRON_TZ=${IANA_TIME_ZONE}" or "TZ=${IANA_TIME_ZONE}". The ${IANA_TIME_ZONE} may only be a valid string from IANA time zone database. For example, "CRON_TZ=America/New_York 1 * * * ", or "TZ=America/New_York 1 * * *".
displayName?	string	no	Required. User provided name of the Schedule. The name can be up to 128 characters long and can consist of any UTF-8 characters.
endTime?	string	no	Optional. Timestamp after which no new runs can be scheduled. If specified, The schedule will be completed when either end_time is reached or when scheduled_run_count >= max_run_count. If not specified, new runs will keep getting scheduled until this Schedule is paused or deleted. Already scheduled runs will be allowed to complete. Unset if not specified.
lastScheduledRunResponse?	object	no	The response of the scheduled run.
maxConcurrentActiveRunCount?	string	no	Optional. Specifies the maximum number of active runs that can be executed concurrently for this Schedule. This limits the number of runs that can be in a non-terminal state at the same time. Currently, this field is only supported for requests of type CreatePipelineJobRequest.
maxConcurrentRunCount?	string	no	Required. Maximum number of runs that can be started concurrently for this Schedule. This is the limit for starting the scheduled requests and not the execution of the operations/jobs created by the requests (if applicable).
maxRunCount?	string	no	Optional. Maximum run count of the schedule. If specified, The schedule will be completed when either started_run_count >= max_run_count or when end_time is reached. If not specified, new runs will keep getting scheduled until this Schedule is paused or deleted. Already scheduled runs will be allowed to complete. Unset if not specified.
name?	string	no	Immutable. The resource name of the Schedule.
startTime?	string	no	Optional. Timestamp after which the first run can be scheduled. Default to Schedule create time if not specified.
location?	string	no	The location for this resource (e.g., 'us', 'us-central1', 'europe-west1')

fn create(waitForReady?: boolean)

Create a schedules

Argument	Type	Required	Description
waitForReady?	boolean	no	Wait for the resource to reach a ready state after creation (default: true)

fn get(identifier: string)

Get a schedules

Argument	Type	Required	Description
identifier	string	yes	The name of the schedules

fn update(waitForReady?: boolean)

Update schedules attributes

Argument	Type	Required	Description
waitForReady?	boolean	no	Wait for the resource to reach a ready state after update (default: true)

fn delete(identifier: string)

Delete the schedules

Argument	Type	Required	Description
identifier	string	yes	The name of the schedules

fn sync()

Sync schedules state from GCP

fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)

List schedules resources

Argument	Type	Required	Description
filter?	string	no	Lists the Schedules that match the filter expression. The following fields are supported: * `display_name`: Supports `=`, `!=` comparisons, and `:` wildcard. * `state`: Supports `=` and `!=` comparisons. * `request`: Supports existence of the check. (e.g. `create_pipeline_job_request:` --> Schedule has create_pipeline_job_request). `create_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be in RFC 3339 format. * `start_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be in RFC 3339 format. * `end_time`: Supports `=`, `!=`, `<`, `>`, `<=`, `>=` comparisons and `:` existence check. Values must be in RFC 3339 format. `next_run_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be in RFC 3339 format. Filter expressions can be combined together using logical operators (`NOT`, `AND` & `OR`). The syntax to define filter expression is based on https://google.aip.dev/160. Examples: * `state="ACTIVE" AND display_name:"my_schedule_"` `NOT display_name="my_schedule"` * `create_time>"2021-05-18T00:00:00Z"` * `end_time>"2021-05-18T00:00:00Z" OR NOT end_time:` `create_pipeline_job_request:*`
orderBy?	string	no	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`
pageSize?	number	no	The standard list page size. Default to 100 if not specified.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

fn pause()

pause

fn resume(catchUp?: any)

resume

Argument	Type	Required	Description
catchUp?	any	no

specialistpools.tsv2026.05.26.1

Global Arguments

Argument	Type	Required	Description
displayName?	string	no	Required. The user-defined name of the SpecialistPool. The name can be up to 128 characters long and can consist of any UTF-8 characters. This field should be unique on project-level.
name?	string	no	Required. The resource name of the SpecialistPool.
specialistManagerEmails?	array	no	The email addresses of the managers in the SpecialistPool.
specialistWorkerEmails?	array	no	The email addresses of workers in the SpecialistPool.
location?	string	no	The location for this resource (e.g., 'us', 'us-central1', 'europe-west1')

fn create()

Create a specialistPools

fn get(identifier: string)

Get a specialistPools

Argument	Type	Required	Description
identifier	string	yes	The name of the specialistPools

fn update()

Update specialistPools attributes

fn delete(identifier: string)

Delete the specialistPools

Argument	Type	Required	Description
identifier	string	yes	The name of the specialistPools

fn sync()

Sync specialistPools state from GCP

fn list(pageSize?: number, readMask?: string, maxPages?: number)

List specialistPools resources

Argument	Type	Required	Description
pageSize?	number	no	The standard list page size.
readMask?	string	no	Mask specifying which fields to read. FieldMask represents a set of
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

studies.tsv2026.05.26.1

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
displayName?	string	no	Required. Describes the Study, default value is empty string.
studySpec?	object	no	The search algorithm specified for the Study.
location?	string	no	The location for this resource (e.g., 'us', 'us-central1', 'europe-west1')

fn create(waitForReady?: boolean)

Create a studies

Argument	Type	Required	Description
waitForReady?	boolean	no	Wait for the resource to reach a ready state after creation (default: true)

fn get(identifier: string)

Get a studies

Argument	Type	Required	Description
identifier	string	yes	The name of the studies

fn delete(identifier: string)

Delete the studies

Argument	Type	Required	Description
identifier	string	yes	The name of the studies

fn sync()

Sync studies state from GCP

fn list(pageSize?: number, maxPages?: number)

List studies resources

Argument	Type	Required	Description
pageSize?	number	no	Optional. The maximum number of studies to return per "page" of results. If unspecified, service will pick an appropriate default.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

fn lookup(displayName?: any)

lookup

Argument	Type	Required	Description
displayName?	any	no

studies_trials.tsv2026.05.26.1

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
finalMeasurement?	object	no	Output only. Time that the Trial has been running at the point of this Measurement.
location?	string	no	The location for this resource (e.g., 'us', 'us-central1', 'europe-west1')

fn create(waitForReady?: boolean)

Create a trials

Argument	Type	Required	Description
waitForReady?	boolean	no	Wait for the resource to reach a ready state after creation (default: true)

fn get(identifier: string)

Get a trials

Argument	Type	Required	Description
identifier	string	yes	The name of the trials

fn delete(identifier: string)

Delete the trials

Argument	Type	Required	Description
identifier	string	yes	The name of the trials

fn sync()

Sync trials state from GCP

fn list(pageSize?: number, maxPages?: number)

List trials resources

Argument	Type	Required	Description
pageSize?	number	no	Optional. The number of Trials to retrieve per "page" of results. If unspecified, the service will pick an appropriate default.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

fn add_trial_measurement(measurement?: any)

add trial measurement

Argument	Type	Required	Description
measurement?	any	no

fn check_trial_early_stopping_state()

check trial early stopping state

fn complete(finalMeasurement?: any, infeasibleReason?: any, trialInfeasible?: any)

complete

Argument	Type	Required
finalMeasurement?	any	no
infeasibleReason?	any	no
trialInfeasible?	any	no

fn list_optimal_trials()

list optimal trials

fn stop()

stop

fn suggest(clientId?: any, contexts?: any, suggestionCount?: any)

suggest

Argument	Type	Required
clientId?	any	no
contexts?	any	no
suggestionCount?	any	no

tensorboards.tsv2026.05.26.1

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
description?	string	no	Description of this Tensorboard.
displayName?	string	no	Required. User provided name of this Tensorboard.
encryptionSpec?	object	no	Required. Resource name of the Cloud KMS key used to protect the resource. The Cloud KMS key must be in the same region as the resource. It must have the format `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`.
isDefault?	boolean	no	Used to indicate if the TensorBoard instance is the default one. Each project & region can have at most one default TensorBoard instance. Creation of a default TensorBoard instance and updating an existing TensorBoard instance to be default will mark all other TensorBoard instances (if any) as non default.
labels?	record	no	The labels with user-defined metadata to organize your Tensorboards. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one Tensorboard (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable.
location?	string	no	The location for this resource (e.g., 'us', 'us-central1', 'europe-west1')

fn create()

Create a tensorboards

fn get(identifier: string)

Get a tensorboards

Argument	Type	Required	Description
identifier	string	yes	The name of the tensorboards

fn update()

Update tensorboards attributes

fn delete(identifier: string)

Delete the tensorboards

Argument	Type	Required	Description
identifier	string	yes	The name of the tensorboards

fn sync()

Sync tensorboards state from GCP

fn list(filter?: string, orderBy?: string, pageSize?: number, readMask?: string, maxPages?: number)

List tensorboards resources

Argument	Type	Required	Description
filter?	string	no	Lists the Tensorboards that match the filter expression.
orderBy?	string	no	Field to use to sort the list.
pageSize?	number	no	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.
readMask?	string	no	Mask specifying which fields to read.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

fn batch_read()

batch read

fn read_size()

read size

fn read_usage()

read usage

tensorboards_experiments.tsv2026.05.26.1

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
description?	string	no	Description of this TensorboardExperiment.
displayName?	string	no	User provided name of this TensorboardExperiment.
source?	string	no	Immutable. Source of the TensorboardExperiment. Example: a custom training job.
tensorboardExperimentId?	string	no	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?	string	no	The location for this resource (e.g., 'us', 'us-central1', 'europe-west1')

fn create()

Create a experiments

fn get(identifier: string)

Get a experiments

Argument	Type	Required	Description
identifier	string	yes	The name of the experiments

fn update()

Update experiments attributes

fn delete(identifier: string)

Delete the experiments

Argument	Type	Required	Description
identifier	string	yes	The name of the experiments

fn sync()

Sync experiments state from GCP

fn list(filter?: string, orderBy?: string, pageSize?: number, readMask?: string, maxPages?: number)

List experiments resources

Argument	Type	Required	Description
filter?	string	no	Lists the TensorboardExperiments that match the filter expression.
orderBy?	string	no	Field to use to sort the list.
pageSize?	number	no	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.
readMask?	string	no	Mask specifying which fields to read.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

fn batch_create(requests?: any)

batch create

Argument	Type	Required	Description
requests?	any	no

fn write(writeRunDataRequests?: any)

write

Argument	Type	Required	Description
writeRunDataRequests?	any	no

tensorboards_experiments_runs.tsv2026.05.26.1

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
description?	string	no	Description of this TensorboardRun.
displayName?	string	no	Required. User provided name of this TensorboardRun. This value must be unique among all TensorboardRuns belonging to the same parent TensorboardExperiment.
labels?	record	no	The labels with user-defined metadata to organize your TensorboardRuns. This field will be used to filter and visualize Runs in the Tensorboard UI. For example, a Vertex AI training job can set a label aiplatform.googleapis.com/training_job_id=xxxxx to all the runs created within that job. An end user can set a label experiment_id=xxxxx for all the runs produced in a Jupyter notebook. These runs can be grouped by a label value and visualized together in the Tensorboard UI. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one TensorboardRun (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable.
tensorboardRunId?	string	no	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?	string	no	The location for this resource (e.g., 'us', 'us-central1', 'europe-west1')

fn create()

Create a runs

fn get(identifier: string)

Get a runs

Argument	Type	Required	Description
identifier	string	yes	The name of the runs

fn update()

Update runs attributes

fn delete(identifier: string)

Delete the runs

Argument	Type	Required	Description
identifier	string	yes	The name of the runs

fn sync()

Sync runs state from GCP

fn list(filter?: string, orderBy?: string, pageSize?: number, readMask?: string, maxPages?: number)

List runs resources

Argument	Type	Required	Description
filter?	string	no	Lists the TensorboardRuns that match the filter expression.
orderBy?	string	no	Field to use to sort the list.
pageSize?	number	no	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.
readMask?	string	no	Mask specifying which fields to read.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

fn batch_create(requests?: any)

batch create

Argument	Type	Required	Description
requests?	any	no

fn write(tensorboardRun?: any, timeSeriesData?: any)

write

Argument	Type	Required	Description
tensorboardRun?	any	no
timeSeriesData?	any	no

tensorboards_experiments_runs_timeseries.tsv2026.05.26.1

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
description?	string	no	Description of this TensorboardTimeSeries.
displayName?	string	no	Required. User provided name of this TensorboardTimeSeries. This value should be unique among all TensorboardTimeSeries resources belonging to the same TensorboardRun resource (parent resource).
metadata?	object	no	Output only. The largest blob sequence length (number of blobs) of all data points in this time series, if its ValueType is BLOB_SEQUENCE.
pluginData?	string	no	Data of the current plugin, with the size limited to 65KB.
pluginName?	string	no	Immutable. Name of the plugin this time series pertain to. Such as Scalar, Tensor, Blob
valueType?	enum	no	Required. Immutable. Type of TensorboardTimeSeries value.
tensorboardTimeSeriesId?	string	no	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?	string	no	The location for this resource (e.g., 'us', 'us-central1', 'europe-west1')

fn create()

Create a timeSeries

fn get(identifier: string)

Get a timeSeries

Argument	Type	Required	Description
identifier	string	yes	The name of the timeSeries

fn update()

Update timeSeries attributes

fn delete(identifier: string)

Delete the timeSeries

Argument	Type	Required	Description
identifier	string	yes	The name of the timeSeries

fn sync()

Sync timeSeries state from GCP

fn list(filter?: string, orderBy?: string, pageSize?: number, readMask?: string, maxPages?: number)

List timeSeries resources

Argument	Type	Required	Description
filter?	string	no	Lists the TensorboardTimeSeries that match the filter expression.
orderBy?	string	no	Field to use to sort the list.
pageSize?	number	no	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.
readMask?	string	no	Mask specifying which fields to read.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

fn export_tensorboard_time_series(filter?: any, orderBy?: any, pageSize?: any, pageToken?: any)

export tensorboard time series

Argument	Type	Required
filter?	any	no
orderBy?	any	no
pageSize?	any	no
pageToken?	any	no

fn read()

read

fn read_blob_data()

read blob data

trainingpipelines.tsv2026.05.26.1

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
displayName?	string	no	Required. The user-defined name of this TrainingPipeline.
encryptionSpec?	object	no	Required. Resource name of the Cloud KMS key used to protect the resource. The Cloud KMS key must be in the same region as the resource. It must have the format `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`.
error?	object	no	The status code, which should be an enum value of google.rpc.Code.
inputDataConfig?	object	no	Applicable only to custom training with Datasets that have DataItems and Annotations. Cloud Storage URI that points to a YAML file describing the annotation schema. The schema is defined as an OpenAPI 3.0.2 [Schema Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). The schema files that can be used here are found in gs://google-cloud-aiplatform/schema/dataset/annotation/, note that the chosen schema must be consistent with metadata of the Dataset specified by dataset_id. Only Annotations that both match this schema and belong to DataItems not ignored by the split method are used in respectively training, validation or test role, depending on the role of the DataItem they are on. When used in conjunction with annotations_filter, the Annotations used for training are filtered by both annotations_filter and annotation_schema_uri.
labels?	record	no	The labels with user-defined metadata to organize TrainingPipelines. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels.
modelId?	string	no	Optional. The ID to use for the uploaded Model, which will become the final component of the model resource name. This value may be up to 63 characters, and valid characters are `[a-z0-9_-]`. The first character cannot be a number or hyphen.
modelToUpload?	object	no	Immutable. The path to the directory containing the Model artifact and any of its supporting files. Not required for AutoML Models.
parentModel?	string	no	Optional. When specify this field, the `model_to_upload` will not be uploaded as a new model, instead, it will become a new version of this `parent_model`.
trainingTaskDefinition?	string	no	Required. A Google Cloud Storage path to the YAML file that defines the training task which is responsible for producing the model artifact, and may also include additional auxiliary work. The definition files that can be used here are found in gs://google-cloud-aiplatform/schema/trainingjob/definition/. Note: The URI given on output will be immutable and probably different, including the URI scheme, than the one given on input. The output URI will point to a location where the user only has a read access.
trainingTaskInputs?	string	no	Required. The training task's parameter(s), as specified in the training_task_definition's `inputs`.
location?	string	no	The location for this resource (e.g., 'us', 'us-central1', 'europe-west1')

fn create()

Create a trainingPipelines

fn get(identifier: string)

Get a trainingPipelines

Argument	Type	Required	Description
identifier	string	yes	The name of the trainingPipelines

fn delete(identifier: string)

Delete the trainingPipelines

Argument	Type	Required	Description
identifier	string	yes	The name of the trainingPipelines

fn sync()

Sync trainingPipelines state from GCP

fn list(filter?: string, pageSize?: number, readMask?: string, maxPages?: number)

List trainingPipelines resources

Argument	Type	Required	Description
filter?	string	no	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"`
pageSize?	number	no	The standard list page size.
readMask?	string	no	Mask specifying which fields to read.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

fn cancel()

cancel

tuningjobs.tsv2026.05.27.1

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
baseModel?	string	no	The base model that is being tuned. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/tuning#supported_models).
description?	string	no	Optional. The description of the TuningJob.
encryptionSpec?	object	no	Required. Resource name of the Cloud KMS key used to protect the resource. The Cloud KMS key must be in the same region as the resource. It must have the format `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`.
error?	object	no	The status code, which should be an enum value of google.rpc.Code.
labels?	record	no	Optional. The labels with user-defined metadata to organize TuningJob and generated resources such as Model and Endpoint. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels.
preTunedModel?	object	no	Output only. The name of the base model this PreTunedModel was tuned from.
preferenceOptimizationSpec?	object	no	Optional. If set to true, disable intermediate checkpoints for Preference Optimization and only the last checkpoint will be exported. Otherwise, enable intermediate checkpoints for Preference Optimization. Default is false.
serviceAccount?	string	no	The service account that the tuningJob workload runs as. If not specified, the Vertex AI Secure Fine-Tuned Service Agent in the project will be used. See https://cloud.google.com/iam/docs/service-agents#vertex-ai-secure-fine-tuning-service-agent Users starting the pipeline must have the `iam.serviceAccounts.actAs` permission on this service account.
supervisedTuningSpec?	object	no	Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers//models/` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`
tunedModel?	object	no	The ID of the checkpoint.
tunedModelDisplayName?	string	no	Optional. The display name of the TunedModel. The name can be up to 128 characters long and can consist of any UTF-8 characters. For continuous tuning, tuned_model_display_name will by default use the same display name as the pre-tuned model. If a new display name is provided, the tuning job will create a new model instead of a new version.
tuningDataStats?	object	no	Output only. A partial sample of the indices (starting from 1) of the dropped examples.
location?	string	no	The location for this resource (e.g., 'us', 'us-central1', 'europe-west1')

fn create()

Create a tuningJobs

fn get(identifier: string)

Get a tuningJobs

Argument	Type	Required	Description
identifier	string	yes	The name of the tuningJobs

fn sync()

Sync tuningJobs state from GCP

fn list(filter?: string, pageSize?: number, maxPages?: number)

List tuningJobs resources

Argument	Type	Required	Description
filter?	string	no	Optional. The standard list filter.
pageSize?	number	no	Optional. The standard list page size.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

fn cancel()

cancel

fn rebase_tuned_model(artifactDestination?: any, deployToSameEndpoint?: any, tunedModelRef?: any, tuningJob?: any)

rebase tuned model

Argument	Type	Required
artifactDestination?	any	no
deployToSameEndpoint?	any	no
tunedModelRef?	any	no
tuningJob?	any	no

04Previous Versions19

2026.05.27.1May 27, 2026

Updated: evaluationruns, tuningjobs

2026.05.26.1May 26, 2026

Added: reasoningengines_sandboxenvironmentsnapshots, reasoningengines_sandboxenvironmenttemplates
Updated: batchpredictionjobs, datasets, datasets_datasetversions, locations, cachedcontents, customjobs, datalabelingjobs, datasets_annotationspecs, datasets_dataitems, datasets_dataitems_annotations, datasets_savedqueries, deploymentresourcepools, endpoints, evaluationitems, evaluationruns, evaluationsets, featuregroups, featuregroups_features, featureonlinestores, featureonlinestores_featureviews, featureonlinestores_featureviews_featureviewsyncs, featurestores, featurestores_entitytypes, featurestores_entitytypes_features, hyperparametertuningjobs, indexendpoints, indexes, metadatastores, metadatastores_artifacts, metadatastores_contexts, metadatastores_executions, metadatastores_metadataschemas, modeldeploymentmonitoringjobs, models, models_evaluations, models_evaluations_slices, nasjobs, nasjobs_nastrialdetails, notebookexecutionjobs, notebookruntimetemplates, notebookruntimes, persistentresources, pipelinejobs, ragcorpora, ragcorpora_ragfiles, reasoningengines, reasoningengines_memories, reasoningengines_memories_revisions, reasoningengines_sandboxenvironments, reasoningengines_sessions, reasoningengines_sessions_events, schedules, specialistpools, studies, studies_trials, tensorboards, tensorboards_experiments, tensorboards_experiments_runs, tensorboards_experiments_runs_timeseries, trainingpipelines, tuningjobs, publishers_models

2026.05.25.2May 25, 2026

Updated: batchpredictionjobs, datasets

Modified 1 models

2026.05.24.1May 24, 2026

Updated: batchpredictionjobs, datasets, datasets_datasetversions, locations, cachedcontents, customjobs, datalabelingjobs, datasets_annotationspecs, datasets_dataitems, datasets_dataitems_annotations, datasets_savedqueries, deploymentresourcepools, endpoints, evaluationitems, evaluationruns, evaluationsets, featuregroups, featuregroups_features, featureonlinestores, featureonlinestores_featureviews, featureonlinestores_featureviews_featureviewsyncs, featurestores, featurestores_entitytypes, featurestores_entitytypes_features, hyperparametertuningjobs, indexendpoints, indexes, metadatastores, metadatastores_artifacts, metadatastores_contexts, metadatastores_executions, metadatastores_metadataschemas, modeldeploymentmonitoringjobs, models, models_evaluations, models_evaluations_slices, nasjobs, nasjobs_nastrialdetails, notebookexecutionjobs, notebookruntimetemplates, notebookruntimes, persistentresources, pipelinejobs, ragcorpora, ragcorpora_ragfiles, reasoningengines, reasoningengines_memories, reasoningengines_memories_revisions, reasoningengines_sandboxenvironmentsnapshots, reasoningengines_sandboxenvironmenttemplates, reasoningengines_sandboxenvironments, reasoningengines_sessions, reasoningengines_sessions_events, schedules, specialistpools, studies, studies_trials, tensorboards, tensorboards_experiments, tensorboards_experiments_runs, tensorboards_experiments_runs_timeseries, trainingpipelines, tuningjobs, publishers_models

2026.05.21.2May 21, 2026

Updated: batchpredictionjobs, datasets, datasets_datasetversions, locations, cachedcontents, customjobs, datalabelingjobs, datasets_annotationspecs, datasets_dataitems, datasets_dataitems_annotations, datasets_savedqueries, deploymentresourcepools, endpoints, evaluationitems, evaluationruns, evaluationsets, featuregroups, featuregroups_features, featureonlinestores, featureonlinestores_featureviews, featureonlinestores_featureviews_featureviewsyncs, featurestores, featurestores_entitytypes, featurestores_entitytypes_features, hyperparametertuningjobs, indexendpoints, indexes, metadatastores, metadatastores_artifacts, metadatastores_contexts, metadatastores_executions, metadatastores_metadataschemas, modeldeploymentmonitoringjobs, models, models_evaluations, models_evaluations_slices, nasjobs, nasjobs_nastrialdetails, notebookexecutionjobs, notebookruntimetemplates, notebookruntimes, persistentresources, pipelinejobs, ragcorpora, ragcorpora_ragfiles, reasoningengines, reasoningengines_memories, reasoningengines_memories_revisions, reasoningengines_sandboxenvironmentsnapshots, reasoningengines_sandboxenvironmenttemplates, reasoningengines_sandboxenvironments, reasoningengines_sessions, reasoningengines_sessions_events, schedules, specialistpools, studies, studies_trials, tensorboards, tensorboards_experiments, tensorboards_experiments_runs, tensorboards_experiments_runs_timeseries, trainingpipelines, tuningjobs, publishers_models

2026.05.21.1May 21, 2026

2026.05.20.1May 20, 2026

Added: reasoningengines_sandboxenvironmentsnapshots, reasoningengines_sandboxenvironmenttemplates
Updated: batchpredictionjobs, datasets, datasets_datasetversions, locations, cachedcontents, customjobs, datalabelingjobs, datasets_annotationspecs, datasets_dataitems, datasets_dataitems_annotations, datasets_savedqueries, deploymentresourcepools, endpoints, evaluationitems, evaluationruns, evaluationsets, featuregroups, featuregroups_features, featureonlinestores, featureonlinestores_featureviews, featureonlinestores_featureviews_featureviewsyncs, featurestores, featurestores_entitytypes, featurestores_entitytypes_features, hyperparametertuningjobs, indexendpoints, indexes, metadatastores, metadatastores_artifacts, metadatastores_contexts, metadatastores_executions, metadatastores_metadataschemas, modeldeploymentmonitoringjobs, models, models_evaluations, models_evaluations_slices, nasjobs, nasjobs_nastrialdetails, notebookexecutionjobs, notebookruntimetemplates, notebookruntimes, persistentresources, pipelinejobs, ragcorpora, ragcorpora_ragfiles, reasoningengines, reasoningengines_memories, reasoningengines_memories_revisions, reasoningengines_sandboxenvironments, reasoningengines_sessions, reasoningengines_sessions_events, schedules, specialistpools, studies, studies_trials, tensorboards, tensorboards_experiments, tensorboards_experiments_runs, tensorboards_experiments_runs_timeseries, trainingpipelines, tuningjobs, publishers_models

2026.05.19.2May 19, 2026

2026.05.19.1May 19, 2026

2026.05.18.2May 18, 2026

2026.05.14.1May 14, 2026

Updated: cachedcontents, evaluationruns, reasoningengines, reasoningengines_sandboxenvironments

2026.05.09.1May 9, 2026

Updated: reasoningengines, reasoningengines_sandboxenvironments

2026.05.02.1May 2, 2026

Updated: batchpredictionjobs, datasets, datasets_datasetversions, locations, cachedcontents, customjobs, datalabelingjobs, datasets_annotationspecs, datasets_dataitems, datasets_dataitems_annotations, datasets_savedqueries, deploymentresourcepools, endpoints, evaluationitems, evaluationruns, evaluationsets, featuregroups, featuregroups_features, featureonlinestores, featureonlinestores_featureviews, featureonlinestores_featureviews_featureviewsyncs, featurestores, featurestores_entitytypes, featurestores_entitytypes_features, hyperparametertuningjobs, indexendpoints, indexes, metadatastores, metadatastores_artifacts, metadatastores_contexts, metadatastores_executions, metadatastores_metadataschemas, modeldeploymentmonitoringjobs, models, models_evaluations, models_evaluations_slices, nasjobs, nasjobs_nastrialdetails, notebookexecutionjobs, notebookruntimetemplates, notebookruntimes, persistentresources, pipelinejobs, ragcorpora, ragcorpora_ragfiles, reasoningengines, reasoningengines_memories, reasoningengines_memories_revisions, reasoningengines_sandboxenvironmentsnapshots, reasoningengines_sandboxenvironmenttemplates, reasoningengines_sandboxenvironments, reasoningengines_sessions, reasoningengines_sessions_events, schedules, specialistpools, studies, studies_trials, tensorboards, tensorboards_experiments, tensorboards_experiments_runs, tensorboards_experiments_runs_timeseries, trainingpipelines, tuningjobs, publishers_models

Modified 1 models

2026.04.23.1Apr 23, 2026

Modified 1 models

2026.04.15.1Apr 15, 2026

Updated: evaluationruns, reasoningengines, reasoningengines_sandboxenvironmenttemplates, reasoningengines_sandboxenvironments, tuningjobs

2026.04.11.1Apr 11, 2026

Added: reasoningengines_sandboxenvironmentsnapshots, reasoningengines_sandboxenvironmenttemplates
Updated: evaluationruns, reasoningengines, reasoningengines_memories, reasoningengines_memories_revisions, reasoningengines_sandboxenvironments, tuningjobs

Modified 1 models

2026.04.05.1Apr 5, 2026

Updated: reasoningengines_memories

2026.04.04.1Apr 4, 2026

Updated: batchpredictionjobs, cachedcontents, customjobs, deploymentresourcepools, endpoints, evaluationitems, evaluationruns, hyperparametertuningjobs, indexendpoints, modeldeploymentmonitoringjobs, models, models_evaluations, nasjobs, persistentresources, pipelinejobs, ragcorpora_ragfiles, reasoningengines, reasoningengines_sessions_events, schedules, studies, trainingpipelines, tuningjobs, publishers_models

2026.04.03.3Apr 3, 2026

Updated: batchpredictionjobs, datasets, datasets_datasetversions, locations, cachedcontents, customjobs, datalabelingjobs, datasets_annotationspecs, datasets_dataitems, datasets_dataitems_annotations, datasets_savedqueries, deploymentresourcepools, endpoints, evaluationitems, evaluationruns, evaluationsets, featuregroups, featuregroups_features, featureonlinestores, featureonlinestores_featureviews, featureonlinestores_featureviews_featureviewsyncs, featurestores, featurestores_entitytypes, featurestores_entitytypes_features, hyperparametertuningjobs, indexendpoints, indexes, metadatastores, metadatastores_artifacts, metadatastores_contexts, metadatastores_executions, metadatastores_metadataschemas, modeldeploymentmonitoringjobs, models, models_evaluations, models_evaluations_slices, nasjobs, nasjobs_nastrialdetails, notebookexecutionjobs, notebookruntimetemplates, notebookruntimes, persistentresources, pipelinejobs, ragcorpora, ragcorpora_ragfiles, reasoningengines, reasoningengines_memories, reasoningengines_memories_revisions, reasoningengines_sandboxenvironments, reasoningengines_sessions, reasoningengines_sessions_events, schedules, specialistpools, studies, studies_trials, tensorboards, tensorboards_experiments, tensorboards_experiments_runs, tensorboards_experiments_runs_timeseries, trainingpipelines, tuningjobs, publishers_models

05Stats

100 / 100

Downloads

Archive size

1.2 MB

Verified by Swamp

Has README or module doc2/2earned
README has a code example1/1earned
README is substantive1/1earned
Most symbols documented1/1earned
No slow types1/1earned
Dependencies pass trust audit2/2earned
Has description1/1earned
Platform support declared (or universal)2/2earned
License declared1/1earned
Verified public repository2/2earned

Repository

https://github.com/systeminit/swamp-extensions

06Platforms

linux · x86_64 linux · aarch64 macOS · x86_64 macOS · aarch64

07Labels

#gcp #google-cloud #aiplatform #cloud #infrastructure