File: //snap/google-cloud-cli/current/lib/surface/storage/batch_operations/jobs/describe.py
# -*- coding: utf-8 -*- #
# Copyright 2024 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.
"""Implementation of describe command for batch operations jobs."""
from __future__ import absolute_import
from __future__ import division
from __future__ import unicode_literals
from googlecloudsdk.api_lib.storage import storage_batch_operations_api
from googlecloudsdk.calliope import base
from googlecloudsdk.command_lib.storage.batch_operations.jobs import resource_args
@base.DefaultUniverseOnly
class Describe(base.DescribeCommand):
"""Describe a batch-operations job."""
detailed_help = {
"DESCRIPTION": """
Describe the batch operation job.
""",
"EXAMPLES": """
To describe a batch job with the name `my-job`:
$ {command} my-job
To describe the same batch job with fully specified name:
$ {command} projects/my-project/locations/global/jobs/my-job
""",
}
@staticmethod
def Args(parser):
resource_args.add_batch_job_resource_arg(parser, "to describe")
def Run(self, args):
job_ref = args.CONCEPTS.batch_job.Parse()
return (
storage_batch_operations_api.StorageBatchOperationsApi().get_batch_job(
job_ref.RelativeName()
)
)