HEX
Server: Apache/2.4.65 (Ubuntu)
System: Linux ielts-store-v2 6.8.0-1036-gcp #38~22.04.1-Ubuntu SMP Thu Aug 14 01:19:18 UTC 2025 x86_64
User: root (0)
PHP: 7.2.34-54+ubuntu20.04.1+deb.sury.org+1
Disabled: pcntl_alarm,pcntl_fork,pcntl_waitpid,pcntl_wait,pcntl_wifexited,pcntl_wifstopped,pcntl_wifsignaled,pcntl_wifcontinued,pcntl_wexitstatus,pcntl_wtermsig,pcntl_wstopsig,pcntl_signal,pcntl_signal_get_handler,pcntl_signal_dispatch,pcntl_get_last_error,pcntl_strerror,pcntl_sigprocmask,pcntl_sigwaitinfo,pcntl_sigtimedwait,pcntl_exec,pcntl_getpriority,pcntl_setpriority,pcntl_async_signals,
Upload Files
File: //snap/google-cloud-cli/394/lib/surface/compute/health_checks/list.py
# -*- 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.
"""Command for listing health checks."""

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

from googlecloudsdk.api_lib.compute import base_classes
from googlecloudsdk.api_lib.compute import lister
from googlecloudsdk.calliope import base
from googlecloudsdk.command_lib.compute.health_checks import exceptions


@base.UniverseCompatible
@base.ReleaseTracks(base.ReleaseTrack.BETA, base.ReleaseTrack.GA)
class List(base.ListCommand):
  """List health checks in GA."""

  messages = None

  @staticmethod
  def Args(parser):
    lister.AddMultiScopeListerFlags(parser, regional=True, global_=True)

    parser.add_argument(
        '--protocol',
        help="""\
        If protocol is specified, only health checks for that protocol are
        listed, and protocol-specific columns are added to the output. By
        default, health checks for all protocols are listed.
        """)

  def _ConvertProtocolArgsToProtocolEnumName(self, args):
    return args.protocol.upper()

  def _ConvertProtocolArgToValue(self, args):
    # Get the dictionary that maps strings to numbers, e.g. "HTTP" to 0.
    protocol_dict = self.messages.HealthCheck.TypeValueValuesEnum.to_dict()
    return protocol_dict.get(self._ConvertProtocolArgsToProtocolEnumName(args))

  def _ProtocolAllowlist(self):
    # Returns a list of allowlisted protocols.
    return [
        self.messages.HealthCheck.TypeValueValuesEnum.GRPC.number,
        self.messages.HealthCheck.TypeValueValuesEnum.HTTP.number,
        self.messages.HealthCheck.TypeValueValuesEnum.HTTPS.number,
        self.messages.HealthCheck.TypeValueValuesEnum.HTTP2.number,
        self.messages.HealthCheck.TypeValueValuesEnum.TCP.number,
        self.messages.HealthCheck.TypeValueValuesEnum.SSL.number
    ]

  def _GetValidColumns(self, args):
    """Returns a list of valid columns."""
    # Start with the columns that apply to all protocols.
    columns = [
        'name:label=NAME', 'region.basename():label=REGION',
        'type:label=PROTOCOL'
    ]

    # Add protocol-specific columns. Note that we only need to worry about
    # protocols that were allowlisted in our GetResources method below.
    if args.protocol is not None:
      protocol_value = self._ConvertProtocolArgToValue(args)
      if (protocol_value ==
          self.messages.HealthCheck.TypeValueValuesEnum.GRPC.number):
        columns.extend([
            'grpcHealthCheck.port:label=PORT',
            'grpcHealthCheck.grpcServiceName:label=GRPC_SERVICE_NAME'
        ])
      elif (protocol_value ==
            self.messages.HealthCheck.TypeValueValuesEnum.HTTP.number):
        columns.extend(['httpHealthCheck.host:label=HOST',
                        'httpHealthCheck.port:label=PORT',
                        'httpHealthCheck.requestPath:label=REQUEST_PATH',
                        'httpHealthCheck.proxyHeader:label=PROXY_HEADER'])
      elif (protocol_value ==
            self.messages.HealthCheck.TypeValueValuesEnum.HTTPS.number):
        columns.extend(['httpsHealthCheck.host:label=HOST',
                        'httpsHealthCheck.port:label=PORT',
                        'httpsHealthCheck.requestPath:label=REQUEST_PATH',
                        'httpsHealthCheck.proxyHeader:label=PROXY_HEADER'])
      elif (protocol_value ==
            self.messages.HealthCheck.TypeValueValuesEnum.HTTP2.number):
        columns.extend(['http2HealthCheck.host:label=HOST',
                        'http2HealthCheck.port:label=PORT',
                        'http2HealthCheck.requestPath:label=REQUEST_PATH',
                        'http2HealthCheck.proxyHeader:label=PROXY_HEADER'])
      elif (protocol_value ==
            self.messages.HealthCheck.TypeValueValuesEnum.TCP.number):
        columns.extend(['tcpHealthCheck.port:label=PORT',
                        'tcpHealthCheck.request:label=REQUEST',
                        'tcpHealthCheck.response:label=RESPONSE',
                        'tcpHealthCheck.proxyHeader:label=PROXY_HEADER'])
      elif (protocol_value ==
            self.messages.HealthCheck.TypeValueValuesEnum.SSL.number):
        columns.extend(['sslHealthCheck.port:label=PORT',
                        'sslHealthCheck.request:label=REQUEST',
                        'sslHealthCheck.response:label=RESPONSE',
                        'sslHealthCheck.proxyHeader:label=PROXY_HEADER'])

    return columns

  def Collection(self):
    """Override the default collection from the base class."""
    return None

  def Run(self, args):
    holder = base_classes.ComputeApiHolder(self.ReleaseTrack())
    client = holder.client
    self.messages = client.messages
    if args.protocol is not None:
      self._validateProtocol(args)
    if not args.IsSpecified('format') and not args.uri:
      args.format = self._Format(args)

    request_data = lister.ParseMultiScopeFlags(args, holder.resources)

    list_implementation = lister.MultiScopeLister(
        client,
        regional_service=client.apitools_client.regionHealthChecks,
        global_service=client.apitools_client.healthChecks,
        aggregation_service=client.apitools_client.healthChecks,
    )

    items = lister.Invoke(request_data, list_implementation)
    if args.protocol is None:
      return items

    # Filter the resources that do not match the specified protocol.
    health_checks = []
    for health_check in items:
      if health_check['type'] == self._ConvertProtocolArgsToProtocolEnumName(
          args
      ):
        health_checks.append(health_check)
    return health_checks

  def _validateProtocol(self, args):
    protocol_value = self._ConvertProtocolArgToValue(args)
    if protocol_value not in self._ProtocolAllowlist():
      raise exceptions.ArgumentError(
          'Invalid health check protocol ' + args.protocol + '.'
      )

  def _Format(self, args):
    columns = self._GetValidColumns(args)
    return 'table[]({columns})'.format(columns=','.join(columns))

  @property
  def service(self):
    return self.compute.healthChecks

  @property
  def resource_type(self):
    return 'healthChecks'

  @property
  def global_service(self):
    """The service used to list global resources."""
    return self.compute.healthChecks

  @property
  def regional_service(self):
    """The service used to list regional resources."""
    return self.compute.regionHealthChecks

  @property
  def zonal_service(self):
    """The service used to list regional resources."""
    return None

  @property
  def aggregation_service(self):
    """The service used to get aggregated list of resources."""
    return self.compute.healthChecks

  def GetResources(self, args, errors):
    health_checks = super(List, self).GetResources(args, errors)

    # If a protocol is specified, check that it is one we support, and convert
    # it to a number.
    protocol_value = None
    if args.protocol is not None:
      protocol_value = self._ConvertProtocolArgToValue(args)
      if protocol_value not in self._ProtocolAllowlist():
        raise exceptions.ArgumentError('Invalid health check protocol ' +
                                       args.protocol + '.')

    for health_check in health_checks:
      if (protocol_value is None or
          health_check['type'] == args.protocol.upper()):
        yield health_check


@base.ReleaseTracks(base.ReleaseTrack.ALPHA)
class ListAlpha(List):
  """List health checks in Alpha."""

  def _ProtocolAllowlist(self):
    # Returns a list of Allowlisted protocols.
    allowlist = super(ListAlpha, self)._ProtocolAllowlist()
    allowlist.append(
        self.messages.HealthCheck.TypeValueValuesEnum.GRPC_WITH_TLS.number
    )
    return allowlist

  def _ConvertProtocolArgsToProtocolEnumName(self, args):
    return args.protocol.upper().replace('-', '_')

  def _Format(self, args):
    columns = super(ListAlpha, self)._GetValidColumns(args)
    if args.protocol is not None:
      protocol_value = self._ConvertProtocolArgToValue(args)
      if (protocol_value ==
          self.messages.HealthCheck.TypeValueValuesEnum.UDP.number):
        columns.extend([
            'udpHealthCheck.port:label=PORT',
            'udpHealthCheck.request:label=REQUEST',
            'udpHealthCheck.response:label=RESPONSE'
        ])
      elif (
          protocol_value
          == self.messages.HealthCheck.TypeValueValuesEnum.GRPC_WITH_TLS.number
      ):
        columns.extend([
            'grpcTlsHealthCheck.port:label=PORT',
            'grpcTlsHealthCheck.grpcServiceName:label=GRPC_SERVICE_NAME',
        ])

    return 'table[]({columns})'.format(columns=','.join(columns))


List.detailed_help = base_classes.GetGlobalListerHelp('health checks')
ListAlpha.detailed_help = base_classes.GetGlobalListerHelp('health checks')