File: //snap/google-cloud-cli/current/lib/surface/pubsub/snapshots/create.py
# -*- coding: utf-8 -*- #
# Copyright 2016 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.
"""Cloud Pub/Sub snapshots create command."""
from __future__ import absolute_import
from __future__ import division
from __future__ import unicode_literals
from apitools.base.py import exceptions as api_ex
from googlecloudsdk.api_lib.pubsub import snapshots
from googlecloudsdk.api_lib.util import exceptions
from googlecloudsdk.calliope import base
from googlecloudsdk.command_lib.pubsub import flags
from googlecloudsdk.command_lib.pubsub import util
from googlecloudsdk.command_lib.util.args import labels_util
from googlecloudsdk.core import log
@base.DefaultUniverseOnly
@base.ReleaseTracks(base.ReleaseTrack.GA, base.ReleaseTrack.BETA)
class Create(base.CreateCommand):
"""Creates one or more Cloud Pub/Sub snapshots."""
@staticmethod
def Args(parser):
"""Registers flags for this command."""
parser.add_argument(
'snapshot', nargs='+', help='One or more snapshot names to create.')
parser.add_argument(
'--subscription',
required=True,
help=('The subscription whose backlog the snapshot retains. '
' Specifically, the created snapshot is guaranteed to retain a)'
' The existing backlog on the subscription, i.e., the set of'
' messages in the subscription that are unacknowledged upon the'
' successful completion of the create snapshot request, b) Any'
' messages published to the subscription\'s topic following the'
' successful creation of the snapshot.'))
parser.add_argument(
'--subscription-project',
default='',
help=('The name of the project the provided subscription belongs to.'
' If not set, it defaults to the currently selected'
' cloud project.'))
labels_util.AddCreateLabelsFlags(parser)
def Run(self, args):
"""This is what gets called when the user runs this command.
Args:
args: an argparse namespace. All the arguments that were provided to this
command invocation.
Yields:
A serialized object (dict) describing the results of the operation.
This description fits the Resource described in the ResourceRegistry under
'pubsub.projects.snapshots'.
Raises:
util.RequestFailedError: if any of the requests to the API failed.
"""
client = snapshots.SnapshotsClient()
subscription_ref = util.ParseSubscription(args.subscription,
args.subscription_project)
labels = labels_util.ParseCreateArgs(
args, client.messages.CreateSnapshotRequest.LabelsValue)
tags = flags.GetTagsMessage(
args, client.messages.CreateSnapshotRequest.TagsValue
)
failed = []
for snapshot_name in args.snapshot:
snapshot_ref = util.ParseSnapshot(snapshot_name)
try:
result = client.Create(
snapshot_ref, subscription_ref, labels=labels, tags=tags
)
except api_ex.HttpError as error:
exc = exceptions.HttpException(error)
log.CreatedResource(
snapshot_ref.RelativeName(),
kind='snapshot',
failed=util.CreateFailureErrorMessage(exc.payload.status_message),
)
failed.append(snapshot_name)
continue
result = util.SnapshotDisplayDict(result)
log.CreatedResource(snapshot_ref.RelativeName(), kind='snapshot')
yield result
if failed:
raise util.RequestsFailedError(failed, 'create')
@base.ReleaseTracks(base.ReleaseTrack.ALPHA)
class CreateAlpha(Create):
"""Creates one or more Cloud Pub/Sub snapshots."""
@staticmethod
def Args(parser):
super(CreateAlpha, CreateAlpha).Args(parser)
flags.AddTagsFlag(parser)