# -*- coding: utf-8 -*- #
# Copyright 2019 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.

"""'logging views list' command."""

from __future__ import absolute_import
from __future__ import division
from __future__ import unicode_literals

from googlecloudsdk.api_lib.logging import util
from googlecloudsdk.calliope import base

DETAILED_HELP = {
    'DESCRIPTION': """
        Lists the available locations for Cloud Logging.
    """,
    'EXAMPLES': """
     To list the available locations, run:

        $ {command}
    """,
}


@base.UniverseCompatible
class List(base.ListCommand):
  """List the availables location."""

  @staticmethod
  def Args(parser):
    """Register flags for this command."""

    util.AddParentArgs(parser, 'locations to list')
    parser.display_info.AddFormat('table(locationId)')

  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:
      The list of locations.
    """
    result = util.GetClient().projects_locations.List(
        util.GetMessages().LoggingProjectsLocationsListRequest(
            name=util.GetParentFromArgs(args)))

    for location in result.locations:
      yield location

List.detailed_help = DETAILED_HELP
