File: //snap/google-cloud-cli/394/lib/surface/ai/indexes/describe.py
# -*- coding: utf-8 -*- #
# Copyright 2021 Google LLC. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
"""Vertex AI indexes describe command."""
from __future__ import absolute_import
from __future__ import division
from __future__ import unicode_literals
from googlecloudsdk.api_lib.ai.indexes import client
from googlecloudsdk.calliope import base
from googlecloudsdk.command_lib.ai import constants
from googlecloudsdk.command_lib.ai import endpoint_util
from googlecloudsdk.command_lib.ai import flags
@base.ReleaseTracks(base.ReleaseTrack.GA)
class DescribeV1(base.DescribeCommand):
"""Gets detailed index information about the given index id.
## EXAMPLES
Describe an index `123` of project `example` in region `us-central1`, run:
$ {command} 123 --project=example --region=us-central1
"""
@staticmethod
def Args(parser):
flags.AddIndexResourceArg(parser, 'to describe')
def _Run(self, args, version):
index_ref = args.CONCEPTS.index.Parse()
region = index_ref.AsDict()['locationsId']
with endpoint_util.AiplatformEndpointOverrides(version, region=region):
return client.IndexesClient(version=version).Get(index_ref)
def Run(self, args):
return self._Run(args, constants.GA_VERSION)
@base.ReleaseTracks(base.ReleaseTrack.ALPHA, base.ReleaseTrack.BETA)
class DescribeV1Beta1(DescribeV1):
"""Gets detailed index information about the given index id.
## EXAMPLES
Describe an index `123` of project `example` in region `us-central1`, run:
$ {command} 123 --project=example --region=us-central1
"""
def Run(self, args):
return self._Run(args, constants.BETA_VERSION)