File: //snap/google-cloud-cli/current/lib/surface/spanner/databases/sessions/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.
"""Command for spanner sessions list."""
from __future__ import absolute_import
from __future__ import division
from __future__ import unicode_literals
import textwrap
from googlecloudsdk.api_lib.spanner import database_sessions
from googlecloudsdk.calliope import base
from googlecloudsdk.command_lib.spanner import resource_args
class List(base.ListCommand):
"""List the Cloud Spanner sessions contained within the given database."""
detailed_help = {
'EXAMPLES':
textwrap.dedent("""\
To list the sessions for a given Cloud Spanner database, run:
$ {command} --instance=my-instance-id --database=my-database-id
"""),
}
@staticmethod
def Args(parser):
"""See base class."""
resource_args.AddDatabaseResourceArg(
parser, 'in which to list sessions', positional=False)
parser.add_argument(
'--server-filter',
required=False,
help=
'An expression for filtering the results of the request on the server. '
'Filter rules are case insensitive. The fields eligible for filtering '
'are: * labels.key where key is the name of a label.')
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:
Some value that we want to have printed later.
"""
return database_sessions.List(args.CONCEPTS.database.Parse(),
args.server_filter)