File: //snap/google-cloud-cli/current/lib/surface/runtime_config/configs/waiters/list.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.
"""The configs waiters list command."""
from __future__ import absolute_import
from __future__ import division
from __future__ import unicode_literals
from apitools.base.py import list_pager
from googlecloudsdk.api_lib.runtime_config import util
from googlecloudsdk.calliope import base
from googlecloudsdk.command_lib.runtime_config import flags
class List(base.ListCommand):
"""List waiter resources within a configuration.
This command lists the waiter resources within a specified configuration.
"""
DEFAULT_PAGE_SIZE = 100
detailed_help = {
'EXAMPLES': """
To list all waiters within the configuration named "my-config", run:
$ {command} --config-name=my-config
The --filter parameter can be used to filter results based on content.
For example, to list all waiters with names that begin with 'foo',
run:
$ {command} --config-name=my-config --filter='name=foo*'
""",
}
@staticmethod
def Args(parser):
"""Args is called by calliope to gather arguments for this command.
Args:
parser: An argparse parser that you can use to add arguments that go
on the command line after this command. Positional arguments are
allowed.
"""
flags.AddRequiredConfigFlag(parser)
parser.display_info.AddFormat(
'table(name, createTime.date(), waiter_status(), error.message)')
def Run(self, args):
"""Run 'runtime-configs waiters list'.
Args:
args: argparse.Namespace, The arguments that this command was invoked
with.
Yields:
The list of waiters.
Raises:
HttpException: An http error response was received while executing api
request.
"""
waiter_client = util.WaiterClient()
messages = util.Messages()
config_resource = util.ParseConfigName(util.ConfigName(args))
request = messages.RuntimeconfigProjectsConfigsWaitersListRequest(
parent=config_resource.RelativeName(),
)
page_size = args.page_size or self.DEFAULT_PAGE_SIZE
results = list_pager.YieldFromList(
waiter_client, request, field='waiters',
batch_size_attribute='pageSize', limit=args.limit,
batch_size=page_size
)
for result in results:
yield util.FormatWaiter(result)