File: //snap/google-cloud-cli/current/lib/surface/secrets/versions/describe.py
# -*- coding: utf-8 -*- #
# Copyright 2019 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.
"""Describe metadata about the secret version."""
from __future__ import absolute_import
from __future__ import division
from __future__ import unicode_literals
from googlecloudsdk.api_lib.secrets import api as secrets_api
from googlecloudsdk.calliope import base
from googlecloudsdk.calliope import parser_arguments
from googlecloudsdk.calliope import parser_extensions
from googlecloudsdk.command_lib.secrets import args as secrets_args
@base.DefaultUniverseOnly
@base.ReleaseTracks(base.ReleaseTrack.GA)
class Describe(base.DescribeCommand):
r"""Describe metadata about the secret version.
Describe a secret version's metadata. This command does not include the
secret version's secret data.
## EXAMPLES
Describe version '123' of the secret named 'my-secret':
$ {command} 123 --secret=my-secret
"""
@staticmethod
def Args(parser: parser_arguments.ArgumentInterceptor):
"""Args is called by calliope to gather arguments for secrets versions describe command.
Args:
parser: An argparse parser that you can use to add arguments that will be
available to this command.
"""
secrets_args.AddVersionOrAlias(
parser, purpose='to describe', positional=True, required=True)
secrets_args.AddLocation(parser, purpose='to describe secret', hidden=False)
def Run(self, args):
api_version = secrets_api.GetApiFromTrack(self.ReleaseTrack())
version_ref = args.CONCEPTS.version.Parse()
return secrets_api.Versions(api_version=api_version).Get(
version_ref, secret_location=args.location
)
@base.DefaultUniverseOnly
@base.ReleaseTracks(base.ReleaseTrack.BETA)
class DescribeBeta(base.DescribeCommand):
r"""Describe metadata about the secret version.
Describe a secret version's metadata. This command does not include the
secret version's secret data.
## EXAMPLES
Describe version '123' of the secret named 'my-secret':
$ {command} 123 --secret=my-secret
"""
@staticmethod
def Args(parser):
secrets_args.AddVersionOrAlias(
parser, purpose='to describe', positional=True, required=True)
secrets_args.AddLocation(parser, purpose='to describe secret', hidden=False)
def Run(self, args: parser_extensions.Namespace) -> secrets_api.Versions:
"""Run is called by calliope to implement the secret versions describe command.
Args:
args: an argparse namespace, all the arguments that were provided to this
command invocation.
Returns:
API call to invoke secret version describe.
"""
api_version = secrets_api.GetApiFromTrack(self.ReleaseTrack())
version_ref = args.CONCEPTS.version.Parse()
return secrets_api.Versions(api_version=api_version).Get(
version_ref, secret_location=args.location
)