NAME

gcloud beta ai index-endpoints update - update an Vertex AI index endpoint

SYNOPSIS

gcloud beta ai index-endpoints update (INDEX_ENDPOINT : --region=REGION) [--description=DESCRIPTION] [--display-name=DISPLAY_NAME] [--update-labels=[KEY=VALUE,...]] [--clear-labels | --remove-labels=[KEY,...]] [GCLOUD_WIDE_FLAG ...]

EXAMPLES

To update display name of index endpoint 123 under project example in region us-central1, run:

$ gcloud beta ai index-endpoints update --display-name=new-name \ --project=example --region=us-central1

POSITIONAL ARGUMENTS

Index endpoint resource - The index endpoint to update. The arguments in this

group can be used to specify the attributes of this resource. (NOTE) Some attributes are not given arguments in this group but can be set in other ways. To set the project attribute:

—

provide the argument index_endpoint on the command line with a fully specified name;

—

provide the argument --project on the command line;

—

set the property core/project.

This must be specified.

INDEX_ENDPOINT

ID of the index_endpoint or fully qualified identifier for the index_endpoint. To set the name attribute:

• provide the argument index_endpoint on the command line.

This positional argument must be specified if any of the other arguments in this group are specified.

--region=REGION

Cloud region for the index_endpoint. To set the region attribute:

• provide the argument index_endpoint on the command line with a fully specified name;

• provide the argument --region on the command line;

• set the property ai/region;

• choose one from the prompted list of available regions.

FLAGS

--description=DESCRIPTION

Description of the index endpoint.

--display-name=DISPLAY_NAME

Display name of the index endpoint.

--update-labels=[KEY=VALUE,...]

List of label KEY=VALUE pairs to update. If a label exists, its value is modified. Otherwise, a new label is created.

Keys must start with a lowercase character and contain only hyphens (-), underscores (_), lowercase characters, and numbers. Values must contain only hyphens (-), underscores (_), lowercase characters, and numbers.

At most one of these can be specified:

--clear-labels

Remove all labels. If --update-labels is also specified then --clear-labels is applied first.

For example, to remove all labels:

$ gcloud beta ai index-endpoints update --clear-labels

To remove all existing labels and create two new labels, foo and baz:

$ gcloud beta ai index-endpoints update --clear-labels \ --update-labels foo=bar,baz=qux

--remove-labels=[KEY,...]

List of label keys to remove. If a label does not exist it is silently ignored. If --update-labels is also specified then --update-labels is applied first.

GCLOUD WIDE FLAGS

These flags are available to all commands: --access-token-file, --account, --billing-project, --configuration, --flags-file, --flatten, --format, --help, --impersonate-service-account, --log-http, --project, --quiet, --trace-token, --user-output-enabled, --verbosity.

Run $ gcloud help for details.

NOTES

This command is currently in beta and might change without notice. These variants are also available:

$ gcloud ai index-endpoints update

$ gcloud alpha ai index-endpoints update