109 lines
4.1 KiB
Python
109 lines
4.1 KiB
Python
# -*- coding: utf-8 -*- #
|
|
# Copyright 2015 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 subscription modify 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 subscriptions
|
|
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 resource_args
|
|
from googlecloudsdk.command_lib.pubsub import util
|
|
from googlecloudsdk.core import log
|
|
from googlecloudsdk.core import properties
|
|
|
|
|
|
@base.Deprecate(
|
|
is_removed=False,
|
|
warning='This command has been renamed. Please use '
|
|
'`modify-message-ack-deadline` instead.')
|
|
@base.ReleaseTracks(base.ReleaseTrack.BETA, base.ReleaseTrack.ALPHA)
|
|
class ModifyAckDeadline(base.Command):
|
|
"""Modifies the ACK deadline for a specific Cloud Pub/Sub message.
|
|
|
|
This method is useful to indicate that more time is needed to process a
|
|
message by the subscriber, or to make the message available for
|
|
redelivery if the processing was interrupted.
|
|
"""
|
|
|
|
@staticmethod
|
|
def Args(parser):
|
|
resource_args.AddSubscriptionResourceArg(parser, 'messages belong to.')
|
|
flags.AddAckIdFlag(parser, 'modify the deadline for.', add_deprecated=True)
|
|
flags.AddAckDeadlineFlag(parser, required=True)
|
|
|
|
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.
|
|
|
|
Returns:
|
|
Display dictionary with information about the new ACK deadline seconds
|
|
for the given subscription and ackId.
|
|
"""
|
|
client = subscriptions.SubscriptionsClient()
|
|
|
|
subscription_ref = args.CONCEPTS.subscription.Parse()
|
|
ack_ids = flags.ParseAckIdsArgs(args)
|
|
result = None
|
|
ack_ids_and_failure_reasons = {}
|
|
try:
|
|
result = client.ModifyAckDeadline(subscription_ref, ack_ids,
|
|
args.ack_deadline)
|
|
except api_ex.HttpError as error:
|
|
exc = exceptions.HttpException(error)
|
|
ack_ids_and_failure_reasons = util.ParseExactlyOnceErrorInfo(
|
|
exc.payload.details)
|
|
# If the failure doesn't have more information (specifically for exactly
|
|
# once related failures), re-raise the exception.
|
|
if not ack_ids_and_failure_reasons:
|
|
raise
|
|
|
|
failed_ack_ids = [ack['AckId'] for ack in ack_ids_and_failure_reasons]
|
|
successfully_processed_ack_ids = [
|
|
ack_id for ack_id in ack_ids if ack_id not in failed_ack_ids
|
|
]
|
|
|
|
log.status.Print('Set ackDeadlineSeconds to [{0}] for messages with ackId '
|
|
'[{1}]] for subscription [{2}]'.format(
|
|
args.ack_deadline,
|
|
','.join(successfully_processed_ack_ids),
|
|
subscription_ref.RelativeName()))
|
|
if failed_ack_ids:
|
|
log.status.Print(
|
|
'Set ackDeadlineSeconds to [{0}] for messages with ackId '
|
|
'[{1}]] failed for subscription [{2}]'.format(
|
|
args.ack_deadline, ','.join(failed_ack_ids),
|
|
subscription_ref.RelativeName()))
|
|
if ack_ids_and_failure_reasons:
|
|
return ack_ids_and_failure_reasons
|
|
|
|
legacy_output = properties.VALUES.pubsub.legacy_output.GetBool()
|
|
if legacy_output:
|
|
result = {
|
|
'subscriptionId': subscription_ref.RelativeName(),
|
|
'ackId': ack_ids,
|
|
'ackDeadlineSeconds': args.ack_deadline
|
|
}
|
|
|
|
return result
|