# -*- coding: utf-8 -*- #
# Copyright 2014 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.
"""Common functions and classes for dealing with managed instances groups."""


import json
import random
import re
import string
import sys
import types

from apitools.base.protorpclite import protojson
from apitools.base.py import encoding
from apitools.base.py import list_pager
from googlecloudsdk.api_lib.compute import exceptions
from googlecloudsdk.api_lib.compute import instance_utils
from googlecloudsdk.api_lib.compute import lister
from googlecloudsdk.api_lib.compute import path_simplifier
from googlecloudsdk.api_lib.compute import request_helper
from googlecloudsdk.api_lib.compute import utils
from googlecloudsdk.calliope import arg_parsers
from googlecloudsdk.calliope import base
from googlecloudsdk.calliope import exceptions as calliope_exceptions
from googlecloudsdk.calliope import parser_extensions
from googlecloudsdk.calliope.exceptions import InvalidArgumentException
from googlecloudsdk.command_lib.compute import flags as compute_flags
from googlecloudsdk.command_lib.compute.managed_instance_groups import auto_healing_utils
from googlecloudsdk.command_lib.compute.managed_instance_groups import update_instances_utils
from googlecloudsdk.command_lib.util.apis import arg_utils
from googlecloudsdk.core import log
from googlecloudsdk.core import properties
from googlecloudsdk.core.console import console_io
import six
from six.moves import range  # pylint: disable=redefined-builtin


_ALLOWED_UTILIZATION_TARGET_TYPES = [
    'DELTA_PER_MINUTE',
    'DELTA_PER_SECOND',
    'GAUGE',
]

_ALLOWED_UTILIZATION_TARGET_TYPES_LOWER = [
    'delta-per-minute',
    'delta-per-second',
    'gauge',
]

ARGS_CONFLICTING_WITH_AUTOSCALING_FILE_BETA = [
    'max_num_replicas',
    'cool_down_period',
    'custom_metric_utilization',
    'description',
    'min_num_replicas',
    'scale_based_on_cpu',
    'scale_based_on_load_balancing',
    'target_cpu_utilization',
    'target_load_balancing_utilization',
    'stabilization_period',
]

ARGS_CONFLICTING_WITH_AUTOSCALING_FILE_ALPHA = (
    ARGS_CONFLICTING_WITH_AUTOSCALING_FILE_BETA
)


_MAX_AUTOSCALER_NAME_LENGTH = 63
# 4 character chosen from between lowercase letters and numbers give >1.6M
# possibilities with no more than 100 Autoscalers in one Zone and Project
# so probability that adding an autoscaler will fail because of name conflict
# is about 6e-5.
_NUM_RANDOM_CHARACTERS_IN_AS_NAME = 4


class Error(exceptions.Error):
  """Base exception for managed instance group exceptions."""


class ResourceNotFoundException(Error):
  """The user tries to get/use/update resource which does not exist."""


class InvalidArgumentError(exceptions.Error):
  """The user provides invalid arguments."""


class ResourceAlreadyExistsException(Error):
  """The user tries to create resource which already exists."""


class ResourceCannotBeResolvedException(Error):
  """The user uses invalid / partial name to resolve URI for the resource."""


def AddAutoscalerArgs(parser, autoscaling_file_enabled=False, patch_args=False):
  """Adds commandline arguments to parser."""
  parser.add_argument(
      '--cool-down-period',
      type=arg_parsers.Duration(),
      help=(
          'The number of seconds that your application takes to initialize on a'
          ' VM instance. This is referred to as the [initialization'
          ' period](https://cloud.google.com/compute/docs/autoscaler#cool_down_period).'
          ' Specifying an accurate initialization period improves autoscaler'
          ' decisions. For example, when scaling out, the autoscaler ignores'
          ' data from VMs that are still initializing because those VMs might'
          ' not yet represent normal usage of your application. The default'
          ' initialization period is 60 seconds. See $ gcloud topic datetimes'
          ' for information on duration formats. Initialization periods might'
          ' vary because of numerous factors. We recommend that you test how'
          ' long your application may take to initialize. To do this, create a'
          " VM and time your application's startup process."
      ),
  )
  parser.add_argument(
      '--stabilization-period',
      type=arg_parsers.Duration(),
      help=(
          'The number of seconds that the autoscaler waits for load'
          ' stabilization before making scale-in decisions. For more'
          ' information,'
          ' see [stabilization'
          ' period](https://cloud.google.com/compute/docs/autoscaler#stabilization_period).'
      ),
  )
  parser.add_argument('--description', help='Notes about Autoscaler.')
  AddMinMaxControl(parser, max_required=not autoscaling_file_enabled)
  parser.add_argument(
      '--scale-based-on-cpu',
      action='store_true',
      help='Autoscaler will be based on CPU utilization.',
  )
  parser.add_argument(
      '--scale-based-on-load-balancing',
      action='store_true',
      help='Use autoscaling based on load balancing utilization.',
  )
  parser.add_argument(
      '--target-cpu-utilization',
      type=arg_parsers.BoundedFloat(0.0, 1.0),
      help=(
          'Autoscaler aims to maintain CPU utilization at '
          'target level (0.0 to 1.0).'
      ),
  )
  parser.add_argument(
      '--target-load-balancing-utilization',
      type=arg_parsers.BoundedFloat(0.0, None),
      help=(
          'Autoscaler aims to maintain the load balancing '
          'utilization level (greater than 0.0).'
      ),
  )
  custom_metric_utilization_help = """\
Adds a target metric value for the Autoscaler to use.

*metric*::: Protocol-free URL of a Google Cloud Monitoring metric.

*utilization-target*::: Value of the metric Autoscaler aims to
  maintain (greater than 0.0).

*utilization-target-type*::: How target is expressed. Valid values: {0}.

Mutually exclusive with `--update-stackdriver-metric`.
""".format(', '.join(_ALLOWED_UTILIZATION_TARGET_TYPES))
  parser.add_argument(
      '--custom-metric-utilization',
      type=arg_parsers.ArgDict(
          spec={
              'metric': str,
              'utilization-target': float,
              'utilization-target-type': str,
          },
      ),
      action='append',
      help=custom_metric_utilization_help,
  )

  if autoscaling_file_enabled:
    parser.add_argument(
        '--autoscaling-file',
        metavar='PATH',
        help=(
            'Path of the file from which autoscaling configuration will be '
            'loaded. This flag allows you to atomically setup complex '
            'autoscalers.'
        ),
    )
  parser.add_argument(
      '--remove-stackdriver-metric',
      metavar='METRIC',
      help=(
          'Stackdriver metric to remove from autoscaling configuration. '
          'If the metric is the only input used for autoscaling the '
          'command will fail.'
      ),
  )
  parser.add_argument(
      '--update-stackdriver-metric',
      metavar='METRIC',
      help=(
          'Stackdriver metric to use as an input for autoscaling. '
          'When using this flag, the target value of the metric must also be '
          'specified by using the following flags: '
          '`--stackdriver-metric-single-instance-assignment` or '
          '`--stackdriver-metric-utilization-target` and '
          '`--stackdriver-metric-utilization-target-type`. '
          'Mutually exclusive with `--custom-metric-utilization`.'
      ),
  )
  parser.add_argument(
      '--stackdriver-metric-filter',
      metavar='FILTER',
      help=(
          'Expression for filtering samples used to autoscale, see '
          'https://cloud.google.com/monitoring/api/v3/filters.'
      ),
  )
  parser.add_argument(
      '--stackdriver-metric-utilization-target',
      metavar='TARGET',
      type=float,
      help=(
          'Value of the metric Autoscaler aims to maintain. When '
          'specifying this flag you must also provide '
          '`--stackdriver-metric-utilization-target-type`. Mutually '
          'exclusive with '
          '`--stackdriver-metric-single-instance-assignment` and '
          '`--custom-metric-utilization`.'
      ),
  )

  parser.add_argument(
      '--stackdriver-metric-utilization-target-type',
      metavar='TARGET_TYPE',
      choices=_ALLOWED_UTILIZATION_TARGET_TYPES_LOWER,
      help=(
          'Value of the metric Autoscaler aims to maintain. When '
          'specifying this flag you must also provide '
          '`--stackdriver-metric-utilization-target`. Mutually '
          'exclusive with '
          '`--stackdriver-metric-single-instance-assignment` and '
          '`--custom-metric-utilization`.'
      ),
  )
  parser.add_argument(
      '--stackdriver-metric-single-instance-assignment',
      metavar='ASSIGNMENT',
      type=float,
      help=(
          'Value that indicates the amount of work that each instance is '
          'expected to handle. Autoscaler maintains enough VMs by dividing '
          'the available work by this value. Mutually exclusive with '
          '`-stackdriver-metric-utilization-target-type`, '
          '`-stackdriver-metric-utilization-target-type`, and '
          '`--custom-metric-utilization`.'
      ),
  )

  GetModeFlag().AddToParser(parser)

  AddScaleInControlFlag(parser)

  AddScheduledAutoscaling(parser, patch_args)


def AddMinMaxControl(parser, max_required=True):
  """Adds min and max num replicas controls to a given parser."""
  parser.add_argument(
      '--min-num-replicas',
      type=arg_parsers.BoundedInt(0, sys.maxsize),
      help='Minimum number of replicas Autoscaler can set.',
  )
  parser.add_argument(
      '--max-num-replicas',
      type=arg_parsers.BoundedInt(0, sys.maxsize),
      required=max_required,
      help='Maximum number of replicas Autoscaler can set.',
  )


def GetModeFlag():
  # Can't use a ChoiceEnumMapper because we don't have access to the "messages"
  # module for the right API version.
  return base.ChoiceArgument(
      '--mode',
      {
          'on': (
              'Permits autoscaling to scale out and in (default for '
              'new autoscalers).'
          ),
          'only-scale-out': 'Permits autoscaling to scale only out and not in.',
          'only-up': """
              (DEPRECATED) Permits autoscaling to scale only out and not in.

              Value `only-up` is deprecated. Use `--mode only-scale-out`
              instead.
          """,
          'off': 'Turns off autoscaling, while keeping the new configuration.',
      },
      help_str="""\
          Set the mode of an autoscaler for a managed instance group.

          You can turn off or restrict a group's autoscaler activities without
          affecting your autoscaler configuration. The autoscaler configuration
          persists while the activities are turned off or restricted, and the
          activities resume when the autoscaler is turned on again or when the
          restrictions are lifted.
      """,
  )


def AddScaleInControlFlag(parser, include_clear=False):
  """Adds scale-in-control flags to the given parser."""
  arg_group = parser
  # Convert to arg group if --clear-scale-in-control flag is included.
  if include_clear:
    arg_group = parser.add_group(mutex=True)
    arg_group.add_argument(
        '--clear-scale-in-control',
        action='store_true',
        help="""\
          If specified, the scale-in-control field will be cleared. Using this
          flag will remove any configuration set by `--scale-in-control` flag.
        """,
    )
  arg_group.add_argument(
      '--scale-in-control',
      type=arg_parsers.ArgDict(
          spec={
              'max-scaled-in-replicas': str,
              'max-scaled-in-replicas-percent': str,
              'time-window': int,
          },
      ),
      help="""\
        Configuration that allows slower scale in so that even if Autoscaler
        recommends an abrupt scale in of a managed instance group, it will be
        throttled as specified by the parameters.

        *max-scaled-in-replicas*::: Maximum allowed number of VMs that can be
        deducted from the peak recommendation during the window. Possibly all
        these VMs can be deleted at once so the application needs to be prepared
        to lose that many VMs in one step. Mutually exclusive with
        'max-scaled-in-replicas-percent'.

        *max-scaled-in-replicas-percent*::: Maximum allowed percent of VMs
        that can be deducted from the peak recommendation during the window.
        Possibly all these VMs can be deleted at once so the application needs
        to be prepared to lose that many VMs in one step. Mutually exclusive
        with  'max-scaled-in-replicas'.

        *time-window*::: How long back autoscaling should look when computing
        recommendations. The autoscaler will not resize below the maximum
        allowed deduction subtracted from the peak size observed in this
        period. Measured in seconds.
        """,
  )


def AddClearScaleDownControlFlag(parser):
  """Adds --clear-scale-down-control flag to the given parser."""
  arg_group = parser
  arg_group.add_argument(
      '--clear-scale-down-control',
      action='store_true',
      help="""\
        If specified, the scale-down-control field will be cleared. Using this
        flag will remove any configuration set by the now-deprecated
        `--scale-down-control` flag. This is only useful if the MIG
        configuration had scale-down-control set in the past.
      """,
  )


def AddPredictiveAutoscaling(parser, standard=True):
  """Add Predictive autoscaling arguments to the parser."""
  choices = {
      'none': """\
(Default) No predictions are made when calculating the number of VM
instances.
""",
      'optimize-availability': """\
Predictive autoscaling predicts the future values of the
scaling metric and scales the group in advance to ensure that new
VM instances are ready in time to cover the predicted peak.
""",
  }
  if standard:
    choices['standard'] = """
    Standard predictive autoscaling  predicts the future values of
    the scaling metric and then scales the group to ensure that new VM
    instances are ready in time to cover the predicted peak."""
  parser.add_argument(
      '--cpu-utilization-predictive-method',
      choices=choices,
      help="""
      Indicates whether to use a predictive algorithm when scaling based on
      CPU.""",
  )


def AddScheduledAutoscaling(parser, patch_args):
  """Add parameters controlling scheduled autoscaling."""
  if patch_args:
    arg_group = parser.add_group(mutex=True)
    arg_group_config = parser.add_group()
    arg_group.add_argument(
        '--set-schedule',
        metavar='SCHEDULE_NAME',
        help='A unique name for the scaling schedule to be configured.',
    )
    arg_group.add_argument(
        '--update-schedule',
        metavar='SCHEDULE_NAME',
        help='Name of the scaling schedule to be updated.',
    )
    arg_group.add_argument(
        '--remove-schedule',
        metavar='SCHEDULE_NAME',
        help="""\
          Name of the scaling schedule to be removed.

          Be careful with this action as scaling schedule deletion cannot be
          undone.

          You can delete any schedule regardless of its status. If you delete
          a scaling schedule that is currently active, the deleted scaling
          schedule stops being effective immediately after it is deleted.
          If there is no need to maintain capacity, the autoscaler starts
          removing instances after the usual stabilization period and after
          scale-in controls (if configured). For more information, see
          [Delays in scaling in](https://cloud.google.com/compute/docs/autoscaler/understanding-autoscaler-decisions#delays_in_scaling_in) and [Scale-in controls](https://cloud.google.com/compute/docs/autoscaler/understanding-autoscaler-decisions#scale-in_controls).
          This ensures you don't accidentally lose capacity immediately after
          the scaling schedule ends.
          """,
    )
    arg_group.add_argument(
        '--enable-schedule',
        metavar='SCHEDULE_NAME',
        help="""\
        Name of the scaling schedule to be enabled.

        See --disable-schedule for details.
        """,
    )
    arg_group.add_argument(
        '--disable-schedule',
        metavar='SCHEDULE_NAME',
        help="""\
          Name of the scaling schedule to be disabled.

          When a scaling schedule is disabled its configuration persists but
          the scaling schedule itself never becomes active. If you disable a
          scaling schedule that is currently active the disabled scaling
          schedule stops being effective immediately after it moves into
          DISABLED state.
          If there is no need to maintain capacity, the autoscaler starts
          removing instances after the usual stabilization period and after
          scale-in controls (if configured). For more information, see
          [Delays in scaling in](https://cloud.google.com/compute/docs/autoscaler/understanding-autoscaler-decisions#delays_in_scaling_in) and [Scale-in controls](https://cloud.google.com/compute/docs/autoscaler/understanding-autoscaler-decisions#scale-in_controls).
          This ensures you don't accidentally lose capacity immediately after
          the scaling schedule ends.
          """,
    )
    AddScheduledAutoscalingConfigurationArguments(arg_group_config)
  else:
    arg_group = parser
    parser.add_argument(
        '--set-schedule',
        metavar='SCHEDULE_NAME',
        help='Unique name for the scaling schedule.',
    )
    AddScheduledAutoscalingConfigurationArguments(parser.add_group())


def AddScheduledAutoscalingConfigurationArguments(arg_group):
  """Add arguments that are common to adding or modifying a scaling schedule."""
  arg_group.add_argument(
      '--schedule-cron',
      metavar='CRON_EXPRESSION',
      help="""\
        Start time of the scaling schedule in cron format.

        This is when the autoscaler starts creating new VMs, if the group's
        current size is less than the minimum required instances. Set the start
        time to allow enough time for new VMs to boot and initialize. For
        example if your workload takes 10 minutes from VM creation to start
        serving then set the start time 10 minutes earlier than the time you
        need VMs to be ready.
        """,
  )
  arg_group.add_argument(
      '--schedule-duration-sec',
      metavar='DURATION',
      type=arg_parsers.BoundedInt(300, sys.maxsize),
      help="""\
        How long should the scaling schedule be active, measured in seconds.

        Minimum duration is 5 minutes. A scaling schedule is active from its
        start time and for its configured duration. During this time, the
        autoscaler scales the group to have at least as many VMs as defined by
        the minimum required instances. After the configured duration, if there
        is no need to maintain capacity, the autoscaler starts removing
        instances after the usual stabilization period and after scale-in
        controls (if configured). For more information, see
        [Delays in scaling in](https://cloud.google.com/compute/docs/autoscaler/understanding-autoscaler-decisions#delays_in_scaling_in) and [Scale-in controls](https://cloud.google.com/compute/docs/autoscaler/understanding-autoscaler-decisions#scale-in_controls).
        This ensures you don't accidentally lose capacity immediately after
        the scaling schedule ends.
        """,
  )
  arg_group.add_argument(
      '--schedule-min-required-replicas',
      metavar='MIN_REQUIRED_REPLICAS',
      type=arg_parsers.BoundedInt(0, sys.maxsize),
      help="""\
        How many VMs the autoscaler should provision for the duration of this
        scaling schedule.

        Autoscaler provides at least this number of instances when the scaling
        schedule is active. A managed instance group can have more VMs if there
        are other scaling schedules active with more required instances or if
        another signal (for example, scaling based on CPU) requires more
        instances to meet its target.

        This configuration does not change autoscaling minimum and maximum
        instance limits which are always in effect. Autoscaler does not create
        more than the maximum number of instances configured for a group.
        """,
  )
  arg_group.add_argument(
      '--schedule-time-zone',
      metavar='TIME_ZONE',
      help="""\
        Name of the timezone that the scaling schedule's start time is in.

        It should be provided as a name from the IANA tz database (for
        example Europe/Paris or UTC). It automatically adjusts for daylight
        savings time (DST). If no time zone is provided, UTC is used as a
        default.

        See https://en.wikipedia.org/wiki/List_of_tz_database_time_zones for
        the list of valid timezones.
        """,
  )
  arg_group.add_argument(
      '--schedule-description',
      metavar='DESCRIPTION',
      help='A verbose description of the scaling schedule.',
  )


def ValidateConflictsWithAutoscalingFile(args, conflicting_args):
  if hasattr(args, 'autoscaling_file') and args.IsSpecified('autoscaling_file'):
    for arg in conflicting_args:
      if args.IsSpecified(arg):
        conflicting_flags = [
            '--' + a.replace('_', '-') for a in conflicting_args
        ]
        raise calliope_exceptions.ConflictingArgumentsException(
            *(['--autoscaling-file'] + conflicting_flags)
        )


def _ValidateCustomMetricUtilizationVsUpdateStackdriverMetric(args):
  if args.IsSpecified('custom_metric_utilization') and args.IsSpecified(
      'update_stackdriver_metric'
  ):
    raise calliope_exceptions.ConflictingArgumentsException(
        '--custom-metric-utilization', '--update-stackdriver-metric'
    )


def _ValidateRemoveStackdriverMetricVsUpdateStackdriverMetric(args):
  if (
      args.IsSpecified('update_stackdriver_metric')
      and args.IsSpecified('remove_stackdriver_metric')
      and args.update_stackdriver_metric == args.remove_stackdriver_metric
  ):
    raise calliope_exceptions.InvalidArgumentException(
        '--update-stackdriver-metric',
        'You can not remove Stackdriver metric you are updating with '
        '[--update-stackdriver-metric] flag.',
    )


def _ValidateRequiringUpdateStackdriverMetric(args):  # pylint:disable=missing-docstring
  if not args.IsSpecified('update_stackdriver_metric'):
    requiring_flags = [
        'stackdriver_metric_filter',
        'stackdriver_metric_single_instance_assignment',
        'stackdriver_metric_utilization_target',
        'stackdriver_metric_utilization_target_type',
    ]
    for f in requiring_flags:
      if args.IsSpecified(f):
        raise calliope_exceptions.RequiredArgumentException(
            '--' + f.replace('_', '-'),
            '[--update-stackdriver-metric] required to use this flag.',
        )


def _ValidateRequiredByUpdateStackdriverMetric(args):  # pylint:disable=missing-docstring
  if args.IsSpecified('update_stackdriver_metric'):
    one_of_required = [
        'stackdriver_metric_single_instance_assignment',
        'stackdriver_metric_utilization_target',
    ]
    if not any([args.IsSpecified(f) for f in one_of_required]):
      flags = ['[--{}]'.format(f.replace('_', '--')) for f in one_of_required]
      msg = (
          'You must provide one of {} with '
          '[--update-stackdriver-metric].'.format(', '.join(flags))
      )
      raise calliope_exceptions.RequiredArgumentException(
          '--update-stackdriver-metric', msg
      )


def _ValidateSingleInstanceAssignmentVsUtilizationTarget(args):  # pylint:disable=missing-docstring
  if args.IsSpecified('stackdriver_metric_single_instance_assignment'):
    potential_conflicting = [
        'stackdriver_metric_utilization_target',
        'stackdriver_metric_utilization_target_type',
    ]
    conflicting = [f for f in potential_conflicting if args.IsSpecified(f)]
    if any(conflicting):
      assignment_flag = '--stackdriver-metric-single-instance-assignment'
      conflicting_flags = [
          '[--{}]'.format(f.replace('_', '-')) for f in conflicting
      ]
      raise calliope_exceptions.ConflictingArgumentsException(
          assignment_flag,
          'You cannot use any of {} with `{}`'.format(
              conflicting_flags, assignment_flag
          ),
      )


def _ValidateUtilizationTargetHasType(args):
  if args.IsSpecified(
      'stackdriver_metric_utilization_target'
  ) and not args.IsSpecified('stackdriver_metric_utilization_target_type'):
    raise calliope_exceptions.RequiredArgumentException(
        '--stackdriver-metric-utilization-target-type',
        'Required with [--stackdriver-metric-utilization-target].',
    )


def ValidateStackdriverMetricsFlags(args):
  """Perform validations related to .*stackdriver-metric.* flags."""
  _ValidateCustomMetricUtilizationVsUpdateStackdriverMetric(args)
  _ValidateRemoveStackdriverMetricVsUpdateStackdriverMetric(args)
  _ValidateRequiringUpdateStackdriverMetric(args)
  _ValidateRequiredByUpdateStackdriverMetric(args)
  _ValidateSingleInstanceAssignmentVsUtilizationTarget(args)
  _ValidateUtilizationTargetHasType(args)


def ValidateGeneratedAutoscalerIsValid(args, autoscaler):
  if (
      args.IsSpecified('remove_stackdriver_metric')
      and not autoscaler.autoscalingPolicy.customMetricUtilizations
      and not autoscaler.autoscalingPolicy.cpuUtilization
      and not autoscaler.autoscalingPolicy.loadBalancingUtilization
  ):
    raise calliope_exceptions.InvalidArgumentException(
        '--remove-stackdriver-metric',
        'This would remove the only signal used for autoscaling. If you want '
        'to stop autoscaling the Managed Instance Group use `stop-autoscaling` '
        'command instead.',
    )


def ValidateAutoscalerArgs(args):
  """Validates args."""
  if args.min_num_replicas and args.max_num_replicas:
    if args.min_num_replicas > args.max_num_replicas:
      raise calliope_exceptions.InvalidArgumentException(
          '--max-num-replicas', "can't be less than min num replicas."
      )

  if args.custom_metric_utilization:
    for custom_metric_utilization in args.custom_metric_utilization:
      for field in ('utilization-target', 'metric', 'utilization-target-type'):
        if field not in custom_metric_utilization:
          raise calliope_exceptions.InvalidArgumentException(
              '--custom-metric-utilization', field + ' not present.'
          )
      if custom_metric_utilization['utilization-target'] < 0:
        raise calliope_exceptions.InvalidArgumentException(
            '--custom-metric-utilization utilization-target', 'less than 0.'
        )


def GetInstanceGroupManagerOrThrow(igm_ref, client):
  """Retrieves the given Instance Group Manager if possible.

  Args:
    igm_ref: reference to the Instance Group Manager.
    client: The compute client.

  Returns:
    Instance Group Manager object.
  """
  if hasattr(igm_ref, 'region'):
    service = client.apitools_client.regionInstanceGroupManagers
    request_type = service.GetRequestType('Get')
  if hasattr(igm_ref, 'zone'):
    service = client.apitools_client.instanceGroupManagers
    request_type = service.GetRequestType('Get')
  request = request_type(**igm_ref.AsDict())

  errors = []
  # Run through the generator to actually make the requests and get potential
  # errors.
  igm_details = client.MakeRequests(
      [(service, 'Get', request)], errors_to_collect=errors
  )

  if errors or len(igm_details) != 1:
    utils.RaiseException(
        errors,
        ResourceNotFoundException,
        error_message='Could not fetch resource:',
    )
  return igm_details[0]


def CreateZoneRef(resources, data):
  """Create zone reference from object with project and zone fields."""
  return resources.Parse(
      None,
      params={'project': data.project, 'zone': data.zone},
      collection='compute.zones',
  )


def CreateRegionRef(resources, data):
  """Create region reference from object with project and region fields."""
  return resources.Parse(
      None,
      params={'project': data.project, 'region': data.region},
      collection='compute.regions',
  )


def GroupByProject(locations):
  """Group locations by project field."""
  result = {}
  for location in locations or []:
    if location.project not in result:
      result[location.project] = []
    result[location.project].append(location)
  return result


def AutoscalersForLocations(
    zones, regions, client, fail_when_api_not_supported=True
):
  """Finds all Autoscalers defined for a given project and locations.

  Args:
    zones: iterable of target zone references
    regions: iterable of target region references
    client: The compute client.
    fail_when_api_not_supported: If true, raise tool exception if API does not
      support autoscaling.

  Returns:
    A list of Autoscaler objects.
  """
  # Errors is passed through library calls and modified with
  # (ERROR_CODE, ERROR_MESSAGE) tuples.
  errors = []

  # Explicit list() is required to unwind the generator and make sure errors
  # are detected at this level.
  requests = []
  for project, zones in six.iteritems(GroupByProject(zones)):
    requests += lister.FormatListRequests(
        service=client.apitools_client.autoscalers,
        project=project,
        scopes=sorted(set([zone_ref.zone for zone_ref in zones])),
        scope_name='zone',
        filter_expr=None,
    )

  if regions:
    if hasattr(client.apitools_client, 'regionAutoscalers'):
      for project, regions in six.iteritems(GroupByProject(regions)):
        requests += lister.FormatListRequests(
            service=client.apitools_client.regionAutoscalers,
            project=project,
            scopes=sorted(set([region_ref.region for region_ref in regions])),
            scope_name='region',
            filter_expr=None,
        )
    else:
      if fail_when_api_not_supported:
        errors.append((None, 'API does not support regional autoscaling'))

  autoscalers = client.MakeRequests(requests=requests, errors_to_collect=errors)

  if errors:
    utils.RaiseToolException(
        errors,
        error_message=(
            'Could not check if the Managed Instance Group is Autoscaled.'
        ),
    )

  return autoscalers


def AutoscalersForMigs(migs, autoscalers):
  """Finds Autoscalers with target amongst given IGMs.

  Args:
    migs: List of triples (IGM name, scope type, location reference).
    autoscalers: A list of Autoscalers to search among.

  Returns:
    A list of all Autoscalers with target on mig_names list.
  """
  igm_url_regexes = []
  for name, scope_type, location in migs:
    igm_url_regexes.append(
        '/projects/{project}/{scopeType}/{scopeName}/'
        'instanceGroupManagers/{name}$'.format(
            project=location.project,
            scopeType=(scope_type + 's'),
            scopeName=getattr(location, scope_type),
            name=name,
        )
    )
  igm_url_regex = re.compile('(' + ')|('.join(igm_url_regexes) + ')')
  result = [
      autoscaler
      for autoscaler in autoscalers
      if igm_url_regex.search(autoscaler.target)
  ]
  return result


def AutoscalerForMigByRef(client, resources, igm_ref):
  """Returns autoscaler targeting given instance group manager.

  Args:
    client: a GCE client
    resources: a GCE resource registry
    igm_ref: reference to instance group manager

  Returns:
    Autoscaler message with autoscaler targeting the IGM refferenced by
    igm_ref or None if there isn't one.
  Raises:
    ValueError: if instance group manager collection path is unknown
  """
  if igm_ref.Collection() == 'compute.instanceGroupManagers':
    scope_type = 'zone'
    location = CreateZoneRef(resources, igm_ref)
    zones, regions = [location], None
  elif igm_ref.Collection() == 'compute.regionInstanceGroupManagers':
    scope_type = 'region'
    location = CreateRegionRef(resources, igm_ref)
    zones, regions = None, [location]
  else:
    raise ValueError('Unknown reference type {0}'.format(igm_ref.Collection()))

  autoscalers = AutoscalersForLocations(
      regions=regions, zones=zones, client=client
  )

  return AutoscalerForMig(
      mig_name=igm_ref.Name(),
      autoscalers=autoscalers,
      location=location,
      scope_type=scope_type,
  )


def AutoscalerForMig(mig_name, autoscalers, location, scope_type):
  """Finds Autoscaler targeting given IGM.

  Args:
    mig_name: Name of MIG targeted by Autoscaler.
    autoscalers: A list of Autoscalers to search among.
    location: Target location reference.
    scope_type: Target scope type.

  Returns:
    Autoscaler object for autoscaling the given Instance Group Manager or None
    when such Autoscaler does not exist.
  Raises:
    InvalidArgumentError: if more than one autoscaler provided
  """
  autoscalers = AutoscalersForMigs(
      [(mig_name, scope_type, location)], autoscalers
  )
  if autoscalers:
    # For each Instance Group Manager there can be at most one Autoscaler having
    # the Manager as a target, so when one is found it can be returned as it is
    # the only one.
    if len(autoscalers) == 1:
      return autoscalers[0]
    else:
      raise InvalidArgumentError('More than one Autoscaler with given target.')
  return None


def AddAutoscalersToMigs(
    migs_iterator, client, resources, fail_when_api_not_supported=True
):
  """Add Autoscaler to each IGM object if autoscaling is enabled for it."""

  def ParseZone(zone_link):
    return resources.Parse(
        zone_link,
        params={'project': properties.VALUES.core.project.GetOrFail},
        collection='compute.zones',
    )

  def ParseRegion(region_link):
    return resources.Parse(
        region_link,
        params={'project': properties.VALUES.core.project.GetOrFail},
        collection='compute.regions',
    )

  migs = list(migs_iterator)
  zones = set([ParseZone(mig['zone']) for mig in migs if 'zone' in mig])
  regions = set([ParseRegion(mig['region']) for mig in migs if 'region' in mig])
  autoscalers = {}
  all_autoscalers = AutoscalersForLocations(
      zones=zones,
      regions=regions,
      client=client,
      fail_when_api_not_supported=fail_when_api_not_supported,
  )

  for location in list(zones) + list(regions):
    autoscalers[location.Name()] = []

  for autoscaler in all_autoscalers:
    autoscaler_scope = None
    if autoscaler.zone is not None:
      autoscaler_scope = ParseZone(autoscaler.zone)
    if hasattr(autoscaler, 'region') and autoscaler.region is not None:
      autoscaler_scope = ParseRegion(autoscaler.region)
    if autoscaler_scope is not None:
      autoscalers.setdefault(autoscaler_scope.Name(), [])
      autoscalers[autoscaler_scope.Name()].append(autoscaler)

  for mig in migs:
    location = None
    scope_type = None
    if 'region' in mig:
      location = ParseRegion(mig['region'])
      scope_type = 'region'
    elif 'zone' in mig:
      location = ParseZone(mig['zone'])
      scope_type = 'zone'

    autoscaler = None
    if location and scope_type:
      autoscaler = AutoscalerForMig(
          mig_name=mig['name'],
          autoscalers=autoscalers[location.Name()],
          location=location,
          scope_type=scope_type,
      )
    if autoscaler:
      mig['autoscaler'] = autoscaler
    yield mig


def _BuildCpuUtilization(args, messages):
  """Builds the CPU Utilization message given relevant arguments."""
  flags_to_check = [
      'target_cpu_utilization',
      'scale_based_on_cpu',
      'cpu_utilization_predictive_method',
  ]

  if instance_utils.IsAnySpecified(args, *flags_to_check):
    cpu_message = messages.AutoscalingPolicyCpuUtilization()
    if args.target_cpu_utilization:
      cpu_message.utilizationTarget = args.target_cpu_utilization
    if args.cpu_utilization_predictive_method:
      cpu_predictive_enum = (
          messages.AutoscalingPolicyCpuUtilization.PredictiveMethodValueValuesEnum
      )
      cpu_message.predictiveMethod = arg_utils.ChoiceToEnum(
          args.cpu_utilization_predictive_method, cpu_predictive_enum
      )
    return cpu_message
  return None


def _BuildCustomMetricUtilizationsFromCustomMetricUtilizationFlag(
    flag, messages
):
  """Translate --custom-metric-utilization flag to API message."""
  result = []
  for custom_metric_utilization in flag:
    result.append(
        messages.AutoscalingPolicyCustomMetricUtilization(
            utilizationTarget=custom_metric_utilization['utilization-target'],
            metric=custom_metric_utilization['metric'],
            utilizationTargetType=(
                messages.AutoscalingPolicyCustomMetricUtilization.UtilizationTargetTypeValueValuesEnum(
                    custom_metric_utilization['utilization-target-type'],
                )
            ),
        )
    )
  return result


def _RemoveMetricFromList(metrics, to_remove):
  for i, metric in enumerate(metrics):
    if metric.metric == to_remove:
      del metrics[i]
      return


def _UpdateCustomMetricUtilizationsFromStackoverflowFlags(
    args, messages, original
):
  """Take apply stackdriver flags to customMetricUtilizations."""
  if original:
    result = original.autoscalingPolicy.customMetricUtilizations
  else:
    result = []
  if args.remove_stackdriver_metric:
    _RemoveMetricFromList(result, args.remove_stackdriver_metric)
  if args.update_stackdriver_metric:
    _RemoveMetricFromList(result, args.update_stackdriver_metric)
    if args.stackdriver_metric_utilization_target_type:
      target_type = messages.AutoscalingPolicyCustomMetricUtilization.UtilizationTargetTypeValueValuesEnum(
          args.stackdriver_metric_utilization_target_type.upper().replace(
              '-', '_'
          ),
      )
    else:
      target_type = None

    if args.stackdriver_metric_filter and "'" in args.stackdriver_metric_filter:
      log.warning(
          "The provided filter contains a single quote character ('). While "
          "valid as a metric/resource label value, it's not a control "
          'character that is part of the filtering language; if you meant '
          'to use it to quote a string value, you need to use a double quote '
          'character (") instead.'
      )
    result.append(
        messages.AutoscalingPolicyCustomMetricUtilization(
            utilizationTarget=args.stackdriver_metric_utilization_target,
            metric=args.update_stackdriver_metric,
            utilizationTargetType=target_type,
            singleInstanceAssignment=(
                args.stackdriver_metric_single_instance_assignment
            ),
            filter=args.stackdriver_metric_filter,
        )
    )
  return result


def _BuildCustomMetricUtilizations(args, messages, original):
  """Builds custom metric utilization policy list from args.

  Args:
    args: command line arguments.
    messages: module containing message classes.
    original: original autoscaler message.

  Returns:
    AutoscalingPolicyCustomMetricUtilization list.
  """
  if args.custom_metric_utilization:
    return _BuildCustomMetricUtilizationsFromCustomMetricUtilizationFlag(
        args.custom_metric_utilization, messages
    )
  if hasattr(args, 'stackdriver_metric_filter'):
    return _UpdateCustomMetricUtilizationsFromStackoverflowFlags(
        args, messages, original
    )


def _BuildLoadBalancingUtilization(args, messages):
  if args.target_load_balancing_utilization:
    return messages.AutoscalingPolicyLoadBalancingUtilization(
        utilizationTarget=args.target_load_balancing_utilization,
    )
  if args.scale_based_on_load_balancing:
    return messages.AutoscalingPolicyLoadBalancingUtilization()
  return None


def ParseModeString(mode, messages):
  return messages.AutoscalingPolicy.ModeValueValuesEnum(
      mode.upper().replace('-', '_')
  )


def _BuildMode(args, messages, original):
  if not args.mode:
    return original.autoscalingPolicy.mode if original else None
  return ParseModeString(args.mode, messages)


def BuildScaleIn(args, messages):
  """Builds AutoscalingPolicyScaleInControl.

  Args:
    args: command line arguments.
    messages: module containing message classes.

  Returns:
    AutoscalingPolicyScaleInControl message object.
  Raises:
    InvalidArgumentError:  if both max-scaled-in-replicas and
      max-scaled-in-replicas-percent are specified.
  """
  if args.IsSpecified('scale_in_control'):
    replicas_arg = args.scale_in_control.get('max-scaled-in-replicas')
    replicas_arg_percent = args.scale_in_control.get(
        'max-scaled-in-replicas-percent'
    )
    if replicas_arg and replicas_arg_percent:
      raise InvalidArgumentError(
          'max-scaled-in-replicas and max-scaled-in-replicas-percent'
          "are mutually exclusive, you can't specify both"
      )
    elif replicas_arg_percent:
      max_replicas = messages.FixedOrPercent(percent=int(replicas_arg_percent))
    else:
      max_replicas = messages.FixedOrPercent(fixed=int(replicas_arg))

    return messages.AutoscalingPolicyScaleInControl(
        maxScaledInReplicas=max_replicas,
        timeWindowSec=args.scale_in_control.get('time-window'),
    )


def _RemoveScheduleEncoder(message, unused_encoder=None):
  """Encoder for use when removing a schedule.

  It works around issues with proto encoding of AdditionalProperties with null
  values by directly encoding a dict of keys with None values into json,
  skipping proto-based encoding.

  Args:
    message: an instance of AutoscalingPolicy.ScalingSchedulesValue.

  Returns:
    Schedule removal request JSON dumped to string.
  """
  py_object = {property.key: None for property in message.additionalProperties}
  return json.dumps(py_object)


def _RemoveScheduleDecoder(unused_data, unused_decoder=None):
  """Placeholder decoder for schedule removal message.

  It's passed when registering message codec, but it will never be used as
  removing schedules is a write-only operation.
  """
  raise NotImplementedError(
      "This should never be called, it's a write-only operation."
  )


def BuildSchedules(args, messages):
  """Builds AutoscalingPolicyScalingSchedules.

  Args:
    args: command line arguments.
    messages: module containing message classes.

  Returns:
    Dict containing an AutoscalingPolicyScalingSchedule message object.
  Raises:
    InvalidArgumentError:  if more than one of --scaling-schedule,
    --update-schedule, --remove-schedule,
    --enable-schedule, --disable-schedule is specified.
  """
  # The following method uses getattr instead of args.IsSpecified because the
  # latter doesn't work before the parameter is available in GA, raising
  # googlecloudsdk.calliope.parser_errors.UnknownDestinationException.
  mutex_group = {
      'set_schedule',
      'update_schedule',
      'remove_schedule',
      'enable_schedule',
      'disable_schedule',
  }
  count = 0
  for possible_argument in mutex_group:
    if getattr(args, possible_argument, None) is not None:
      count += 1
  if count == 0:
    return None
  if count > 1:
    raise InvalidArgumentError(
        '--set-schedule, --update-schedule, --remove-schedule, '
        '--enable-schedule, --disable-schedule are mutually exclusive, only '
        'one can be specified.'
    )

  scaling_schedule_wrapper = (
      messages.AutoscalingPolicy.ScalingSchedulesValue.AdditionalProperty
  )
  field_mapping = {
      'schedule_cron': 'schedule',
      'schedule_duration_sec': 'durationSec',
      'schedule_min_required_replicas': 'minRequiredReplicas',
      'schedule_time_zone': 'timeZone',
      'schedule_description': 'description',
  }

  if getattr(args, 'enable_schedule', None) is not None:
    return messages.AutoscalingPolicy.ScalingSchedulesValue(
        additionalProperties=[
            scaling_schedule_wrapper(
                key=args.enable_schedule,
                value=messages.AutoscalingPolicyScalingSchedule(disabled=False),
            )
        ]
    )
  if getattr(args, 'disable_schedule', None) is not None:
    return messages.AutoscalingPolicy.ScalingSchedulesValue(
        additionalProperties=[
            scaling_schedule_wrapper(
                key=args.disable_schedule,
                value=messages.AutoscalingPolicyScalingSchedule(disabled=True),
            )
        ]
    )
  if getattr(args, 'remove_schedule', None) is not None:
    # Register a custom message codec to properly encode AdditionalProperty's
    # None value into nulls.
    encoding.RegisterCustomMessageCodec(
        encoder=_RemoveScheduleEncoder, decoder=_RemoveScheduleDecoder
    )(messages.AutoscalingPolicy.ScalingSchedulesValue)
    return messages.AutoscalingPolicy.ScalingSchedulesValue(
        additionalProperties=[
            scaling_schedule_wrapper(key=args.remove_schedule, value=None)
        ]
    )
  if getattr(args, 'set_schedule', None) is not None:
    policy_name = args.set_schedule
    required = {
        'schedule_cron',
        'schedule_duration_sec',
        'schedule_min_required_replicas',
    }
    # Set-shedule should clear pre-existing fields, so we set them to None.
    scaling_schedule = {field: None for field in field_mapping.values()}
  else:
    policy_name = args.update_schedule
    required = set()
    scaling_schedule = {}

  for arg_attr, field in six.iteritems(field_mapping):
    arg = getattr(args, arg_attr, None)
    if arg is not None:
      scaling_schedule[field] = arg
    elif arg_attr in required:
      raise InvalidArgumentError(
          '--set-schedule argument requires --schedule-duration-sec, '
          '--schedule-cron, and --schedule-min-required-replicas to be '
          'specified.'
      )

  return messages.AutoscalingPolicy.ScalingSchedulesValue(
      additionalProperties=[
          scaling_schedule_wrapper(
              key=policy_name,
              value=messages.AutoscalingPolicyScalingSchedule(
                  **scaling_schedule
              ),
          )
      ]
  )


def _BuildAutoscalerPolicy(args, messages, original):
  """Builds AutoscalingPolicy from args.

  Args:
    args: command line arguments.
    messages: module containing message classes.
    original: original autoscaler message.

  Returns:
    AutoscalingPolicy message object.
  """
  policy_dict = {
      'coolDownPeriodSec': args.cool_down_period,
      'stabilizationPeriodSec': args.stabilization_period,
      'cpuUtilization': _BuildCpuUtilization(args, messages),
      'customMetricUtilizations': _BuildCustomMetricUtilizations(
          args, messages, original
      ),
      'loadBalancingUtilization': _BuildLoadBalancingUtilization(
          args, messages
      ),
      'maxNumReplicas': args.max_num_replicas,
      'minNumReplicas': args.min_num_replicas,
  }
  policy_dict['mode'] = _BuildMode(args, messages, original)
  policy_dict['scaleInControl'] = BuildScaleIn(args, messages)
  policy_dict['scalingSchedules'] = BuildSchedules(args, messages)

  return messages.AutoscalingPolicy(
      **dict(
          (key, value)
          for key, value in six.iteritems(policy_dict)
          if value is not None
      )
  )  # Filter out None values.


def AdjustAutoscalerNameForCreation(autoscaler_resource, igm_ref):
  """Set name of autoscaler o be created.

  If autoscaler name is not None it wNone ill be used as a prefix of name of the
  autoscaler to be created. Prefix may be shortened so that the name fits below
  length limit. Name prefix is followed by '-' character and four
  random letters.

  Args:
    autoscaler_resource: Autoscaler resource to be created.
    igm_ref: reference to Instance Group Manager targeted by the Autoscaler.
  """
  if autoscaler_resource.name is None:
    autoscaler_resource.name = igm_ref.Name()
  trimmed_name = autoscaler_resource.name[
      0 : (_MAX_AUTOSCALER_NAME_LENGTH - _NUM_RANDOM_CHARACTERS_IN_AS_NAME - 1)
  ]
  random_characters = [
      random.choice(string.ascii_lowercase + string.digits)
      for _ in range(_NUM_RANDOM_CHARACTERS_IN_AS_NAME)
  ]
  random_suffix = ''.join(random_characters)
  new_name = '{0}-{1}'.format(trimmed_name, random_suffix)
  autoscaler_resource.name = new_name


def BuildAutoscaler(args, messages, igm_ref, name, original):
  """Builds autoscaler message protocol buffer."""
  autoscaler = messages.Autoscaler(
      autoscalingPolicy=_BuildAutoscalerPolicy(args, messages, original),
      description=args.description,
      name=name,
      target=igm_ref.SelfLink(),
  )
  return autoscaler


def CreateAutohealingPolicies(messages, health_check, initial_delay):
  """Creates autohealing policy list from args."""
  if health_check is None and initial_delay is None:
    return []
  policy = messages.InstanceGroupManagerAutoHealingPolicy()
  if health_check:
    policy.healthCheck = health_check
  if initial_delay:
    policy.initialDelaySec = initial_delay
  return [policy]


def ModifyAutohealingPolicies(
    current_policies, messages, args, health_check_url
):
  """Modifies existing autohealing policy from args."""
  if args.clear_autohealing:
    return [messages.InstanceGroupManagerAutoHealingPolicy()]
  if not health_check_url and not args.initial_delay:
    # No modifications of AutoHealingPolicies.
    return None
  current_policy = current_policies[0] if current_policies else None
  policy = current_policy or messages.InstanceGroupManagerAutoHealingPolicy()
  if health_check_url:
    policy.healthCheck = health_check_url
  if args.initial_delay:
    policy.initialDelaySec = args.initial_delay
  return [policy]


def ValidateAutohealingPolicies(auto_healing_policies):
  """Validates autohealing policies.

  Args:
    auto_healing_policies: list of AutoHealingPolicies to validate
  """
  if not auto_healing_policies:
    return
  # Only a single auto_healing_policy is allowed. Displaying warnings for any
  # additional entries is unnecessary as an error will be returned.
  policy = auto_healing_policies[0]
  if not policy.healthCheck and policy.initialDelaySec:
    message = (
        'WARNING: Health check should be provided when specifying '
        'initial delay.'
    )
    console_io.PromptContinue(message=message, cancel_on_no=True)


def CreateInstanceLifecyclePolicy(messages, args):
  """Creates instance lifecycle policy list from args."""
  policy = messages.InstanceGroupManagerInstanceLifecyclePolicy()
  if args.IsSpecified('force_update_on_repair'):
    if args.force_update_on_repair:
      policy.forceUpdateOnRepair = (
          messages.InstanceGroupManagerInstanceLifecyclePolicy.ForceUpdateOnRepairValueValuesEnum.YES
      )
    else:
      policy.forceUpdateOnRepair = (
          messages.InstanceGroupManagerInstanceLifecyclePolicy.ForceUpdateOnRepairValueValuesEnum.NO
      )

  if args.IsKnownAndSpecified('default_action_on_vm_failure'):
    policy.defaultActionOnFailure = arg_utils.ChoiceToEnum(
        args.default_action_on_vm_failure,
        messages.InstanceGroupManagerInstanceLifecyclePolicy.DefaultActionOnFailureValueValuesEnum,
    )

  if args.IsKnownAndSpecified('action_on_vm_failed_health_check'):
    policy.onFailedHealthCheck = arg_utils.ChoiceToEnum(
        args.action_on_vm_failed_health_check,
        messages.InstanceGroupManagerInstanceLifecyclePolicy.OnFailedHealthCheckValueValuesEnum,
    )

  if args.IsKnownAndSpecified('on_repair_allow_changing_zone'):
    policy.onRepair = messages.InstanceGroupManagerInstanceLifecyclePolicyOnRepair(
        allowChangingZone=arg_utils.ChoiceToEnum(
            args.on_repair_allow_changing_zone,
            messages.InstanceGroupManagerInstanceLifecyclePolicyOnRepair.AllowChangingZoneValueValuesEnum,
        )
    )

  return ValueOrNone(policy)


def CreateInstanceFlexibilityPolicy(
    args,
    messages,
    igm_resource=None,
    support_instance_selection_min_cpu_platform=False,
):
  """Creates instance flexibility policy from args.

  Args:
    args: arguments of the request
    messages: Compute API messages
    igm_resource: instance group manager resource that is being patched
    support_instance_selection_min_cpu_platform: whether to support instance
      selection min cpu platform field

  Returns:
    InstanceFlexibilityPolicy.
  """
  instance_selections = CreateInstanceSelections(
      args, messages, igm_resource, support_instance_selection_min_cpu_platform
  )

  instance_flexibility_policy = (
      messages.InstanceGroupManagerInstanceFlexibilityPolicy(
          instanceSelections=instance_selections
      )
  )
  return ValueOrNone(instance_flexibility_policy)


def CreateResourcePolicies(
    messages: types.ModuleType, args: parser_extensions.Namespace
):
  """Creates resource policies from args."""
  policy = messages.InstanceGroupManagerResourcePolicies()
  if args.IsKnownAndSpecified('workload_policy'):
    policy.workloadPolicy = args.workload_policy
  elif args.IsKnownAndSpecified('remove_workload_policy'):
    RegisterResourcePoliciesPatchEncoders(messages)
    return policy

  return ValueOrNone(policy)


def _DictToAttachedDiskMessage(disk_dict, messages):
  """Converts a Python dict to a Compute API AttachedDisk message."""
  return encoding.DictToMessage(disk_dict, messages.AttachedDisk)


def CreateInstanceSelections(
    args,
    messages,
    igm_resource,
    support_instance_selection_min_cpu_platform=False,
):
  """Build a list of InstanceSelection from the given flags."""
  instance_selections = []
  if args.IsKnownAndSpecified(
      'remove_instance_selections_all'
  ) or args.IsKnownAndSpecified('remove_instance_selections'):
    RegisterInstanceSelectionsPatchEncoders(messages)
    existing_instance_selection_names = _GetExistingInstanceSelectionNames(
        igm_resource
    )

    if args.IsKnownAndSpecified('remove_instance_selections_all'):
      for instance_selection_name in existing_instance_selection_names:
        instance_selections.append(
            messages.InstanceGroupManagerInstanceFlexibilityPolicy.InstanceSelectionsValue.AdditionalProperty(
                key=instance_selection_name,
                value=None,
            )
        )
    elif args.IsKnownAndSpecified('remove_instance_selections'):
      for instance_selection_name in args.remove_instance_selections:
        if instance_selection_name not in existing_instance_selection_names:
          continue
        if any(
            instance_selection.key == instance_selection_name
            for instance_selection in instance_selections
        ):
          continue
        instance_selections.append(
            messages.InstanceGroupManagerInstanceFlexibilityPolicy.InstanceSelectionsValue.AdditionalProperty(
                key=instance_selection_name,
                value=None,
            )
        )

  if args.IsKnownAndSpecified('instance_selection_machine_types'):
    _AddInstanceSelection(
        messages,
        instance_selections,
        'instance-selection-1',
        args.instance_selection_machine_types,
        1,
        min_cpu_platform=None,
        api_disks=None,
    )

  if args.IsKnownAndSpecified('instance_selection'):
    for instance_selection in args.instance_selection:
      if 'name' not in instance_selection:
        raise InvalidArgumentError('Missing instance selection name.')
      name = instance_selection['name'][0]

      if (
          'machine-type' not in instance_selection
          or not instance_selection['machine-type']
      ):
        raise InvalidArgumentError(
            'Missing machine type in instance selection.'
        )
      machine_types = instance_selection['machine-type']
      rank = None
      if 'rank' in instance_selection:
        rank = instance_selection['rank'][0]
        if not rank.isdigit():
          raise InvalidArgumentError(
              'Invalid value for rank in instance selection.'
          )
        rank = int(rank)
      min_cpu_platform = None
      if (
          'min-cpu-platform' in instance_selection
          and support_instance_selection_min_cpu_platform
      ):
        min_cpu_platform = instance_selection['min-cpu-platform'][0]
      _AddInstanceSelection(
          messages,
          instance_selections,
          name,
          machine_types,
          rank,
          min_cpu_platform,
          api_disks=None,
      )

  if args.IsKnownAndSpecified('instance_flexibility_policy'):
    # Clean up existing instance selections to override them with new values
    # from the full policy flag.
    instance_selections = []
    new_instance_selections = args.instance_flexibility_policy[
        'instanceSelections'
    ]
    for (
        name,
        instance_selection,
    ) in new_instance_selections.items():
      if (
          'machineTypes' not in instance_selection
          or not instance_selection['machineTypes']
      ):
        raise InvalidArgumentError(
            'Missing machine type in instance selection.'
        )
      machine_types = instance_selection['machineTypes']
      rank = None
      if 'rank' in instance_selection:
        rank = int(instance_selection['rank'])
      min_cpu_platform = None
      if 'minCpuPlatform' in instance_selection:
        min_cpu_platform = instance_selection['minCpuPlatform']
      api_disks = []
      if 'disks' in instance_selection:
        for disk_dict in instance_selection.get('disks', []):
          try:
            api_disks.append(_DictToAttachedDiskMessage(disk_dict, messages))
          except InvalidArgumentException as e:
            raise InvalidArgumentException(
                'instance_selection',
                f'Invalid disk format in instance selection "{name}": {e} -'
                f' Received: {disk_dict}',
            )
      _AddInstanceSelection(
          messages,
          instance_selections,
          name,
          machine_types,
          rank,
          min_cpu_platform,
          api_disks,
      )

    RegisterInstanceSelectionsPatchEncoders(messages)
    instance_selection_names = [
        selection.key for selection in instance_selections
    ]
    existing_instance_selection_names = _GetExistingInstanceSelectionNames(
        igm_resource
    )
    for instance_selection_name in existing_instance_selection_names:
      if instance_selection_name not in instance_selection_names:
        instance_selections.append(
            messages.InstanceGroupManagerInstanceFlexibilityPolicy.InstanceSelectionsValue.AdditionalProperty(
                key=instance_selection_name,
                value=None,
            )
        )

  if not instance_selections:
    return None
  return messages.InstanceGroupManagerInstanceFlexibilityPolicy.InstanceSelectionsValue(
      additionalProperties=instance_selections
  )


def _AddInstanceSelection(
    messages,
    instance_selections,
    instance_selection_name,
    machine_types,
    rank,
    min_cpu_platform=None,
    api_disks=None,
):
  """Adds instance selection to instance selections list."""
  for instance_selection in instance_selections:
    if instance_selection.key == instance_selection_name:
      if instance_selection.value is not None:
        raise InvalidArgumentError(
            'Attempt to add multiple instance selections with the same name.'
        )
      instance_selections.remove(
          messages.InstanceGroupManagerInstanceFlexibilityPolicy.InstanceSelectionsValue.AdditionalProperty(
              key=instance_selection_name,
              value=None,
          )
      )
  instance_selection = (
      messages.InstanceGroupManagerInstanceFlexibilityPolicyInstanceSelection(
          machineTypes=machine_types
      )
  )
  if min_cpu_platform is not None:
    instance_selection.minCpuPlatform = min_cpu_platform
  if rank is not None:
    instance_selection.rank = rank
  if api_disks:
    instance_selection.disks = api_disks
  instance_selections.append(
      messages.InstanceGroupManagerInstanceFlexibilityPolicy.InstanceSelectionsValue.AdditionalProperty(
          key=instance_selection_name,
          value=instance_selection,
      )
  )


def _IsPreviouslyProcessed(intance_selection_name, instance_selections, is_add):
  for instance_selection in instance_selections:
    if instance_selection.key == intance_selection_name:
      if instance_selection.value is not None and is_add:
        raise InvalidArgumentError(
            'Attempt to add multiple instance selections with the same name.'
        )
      return True
  return False


def _GetExistingInstanceSelectionNames(igm_resource):
  if not igm_resource or not igm_resource.instanceFlexibilityPolicy:
    return []
  return [
      instance_selection.key
      for instance_selection in igm_resource.instanceFlexibilityPolicy.instanceSelections.additionalProperties
  ]


def CreateStandbyPolicy(
    messages, initial_delay_sec=None, standby_policy_mode=None
):
  """Creates standby policy from args."""
  # pylint: disable=g-explicit-bool-comparison
  if initial_delay_sec is None and standby_policy_mode is None:
    return None
  standby_policy = messages.InstanceGroupManagerStandbyPolicy()
  if initial_delay_sec:
    standby_policy.initialDelaySec = initial_delay_sec
  if standby_policy_mode:
    standby_policy_mode_enum = standby_policy_mode.upper().replace('-', '_')
    standby_policy.mode = (
        messages.InstanceGroupManagerStandbyPolicy.ModeValueValuesEnum(
            standby_policy_mode_enum
        )
    )
  return standby_policy


def _GetInstanceTemplatesSet(*versions_lists):
  versions_set = set()
  for versions_list in versions_lists:
    versions_set.update(versions_list)
  return versions_set


def ValidateVersions(igm_info, new_versions, resources, force=False):
  """Validates whether versions provided by user are consistent.

  Args:
    igm_info: instance group manager resource.
    new_versions: list of new versions.
    force: if true, we allow any combination of instance templates, as long as
      they are different. If false, only the following transitions are allowed:
      X -> Y, X -> (X, Y), (X, Y) -> X, (X, Y) -> Y, (X, Y) -> (X, Y)

  Raises:
     InvalidArgumentError: if provided arguments are not complete or invalid.
  """
  if (
      len(new_versions) == 2
      and new_versions[0].instanceTemplate == new_versions[1].instanceTemplate
  ):
    raise InvalidArgumentError('Provided instance templates must be different.')
  if force:
    return

  # Only X -> Y, X -> (X, Y), (X, Y) -> X, (X, Y) -> Y, (X, Y) -> (X, Y)
  # are allowed in gcloud (unless --force)
  # Equivalently, at most two versions in old and new versions set union
  if igm_info.versions:
    igm_templates = [
        resources.ParseURL(version.instanceTemplate).RelativeName()
        for version in igm_info.versions
    ]
  elif igm_info.instanceTemplate:
    igm_templates = [
        resources.ParseURL(igm_info.instanceTemplate).RelativeName()
    ]
  else:
    raise InvalidArgumentError(
        'Either versions or instance template must be specified for '
        'managed instance group.'
    )

  new_templates = [
      resources.ParseURL(version.instanceTemplate).RelativeName()
      for version in new_versions
  ]

  version_count = len(_GetInstanceTemplatesSet(igm_templates, new_templates))
  if version_count > 2:
    raise InvalidArgumentError(
        'Update inconsistent with current state. '
        'The only allowed transitions between versions are: '
        'X -> Y, X -> (X, Y), (X, Y) -> X, (X, Y) -> Y, (X, Y) -> (X, Y). '
        'Please check versions templates or use --force.'
    )


def AddAutoscaledPropertyToMigs(migs, client, resources):
  """Add Autoscaler information if Autoscaler is defined for the MIGs.

  Issue additional queries to detect if any given Instange Group Manager is
  a target of some autoscaler and add this information to in 'autoscaled'
  property.

  Args:
    migs: list of dicts, List of IGM resources converted to dictionaries
    client: a GCE client
    resources: a GCE resource registry

  Returns:
    Pair of:
    - boolean - True iff any autoscaler has an error
    - Copy of migs list with additional property 'autoscaled' set to 'No'/'Yes'/
    'Yes (*)' for each MIG depending on look-up result.
  """

  augmented_migs = []
  had_errors = False
  for mig in AddAutoscalersToMigs(
      migs_iterator=_ComputeInstanceGroupSize(migs, client, resources),
      client=client,
      resources=resources,
      fail_when_api_not_supported=False,
  ):
    status = ResolveAutoscalingStatusForMig(client, mig)
    if status == client.messages.Autoscaler.StatusValueValuesEnum.ERROR:
      had_errors = True
    augmented_migs.append(mig)
  return (had_errors, augmented_migs)


def ResolveAutoscalingStatusForMig(client, mig):
  """Resolves 'autoscaled' property for MIG.

  Uses 'autoscaler' property of a MIG to resolve 'autoscaled' property for
  output.

  Args:
    client: a GCE client
    mig: IGM resource as a dict

  Returns:
    Status of autoscaler if MIG is autoscaled. None otherwise.
  """
  if 'autoscaler' in mig and mig['autoscaler'] is not None:
    # status is present in autoscaler iff Autoscaler message has embedded
    # StatusValueValuesEnum defined.
    if (
        hasattr(mig['autoscaler'], 'status')
        and mig['autoscaler'].status
        == client.messages.Autoscaler.StatusValueValuesEnum.ERROR
    ):
      mig['autoscaled'] = 'yes (*)'
      return mig['autoscaler'].status
    else:
      # Assume it to be ACTIVE
      mig['autoscaled'] = 'yes'
      return client.messages.Autoscaler.StatusValueValuesEnum.ACTIVE
  else:
    mig['autoscaled'] = 'no'
    return None


def _ComputeInstanceGroupSize(items, client, resources):
  """Add information about Instance Group size."""
  errors = []
  zone_refs = [
      resources.Parse(
          mig['zone'],
          params={'project': properties.VALUES.core.project.GetOrFail},
          collection='compute.zones',
      )
      for mig in items
      if 'zone' in mig
  ]
  region_refs = [
      resources.Parse(
          mig['region'],
          params={'project': properties.VALUES.core.project.GetOrFail},
          collection='compute.regions',
      )
      for mig in items
      if 'region' in mig
  ]

  zonal_instance_groups = []
  for project, zone_refs in six.iteritems(GroupByProject(zone_refs)):
    zonal_instance_groups.extend(
        lister.GetZonalResources(
            service=client.apitools_client.instanceGroups,
            project=project,
            requested_zones=set([zone.zone for zone in zone_refs]),
            filter_expr=None,
            http=client.apitools_client.http,
            batch_url=client.batch_url,
            errors=errors,
        )
    )

  regional_instance_groups = []
  if getattr(client.apitools_client, 'regionInstanceGroups', None):
    for project, region_refs in six.iteritems(GroupByProject(region_refs)):
      regional_instance_groups.extend(
          lister.GetRegionalResources(
              service=client.apitools_client.regionInstanceGroups,
              project=project,
              requested_regions=set([region.region for region in region_refs]),
              filter_expr=None,
              http=client.apitools_client.http,
              batch_url=client.batch_url,
              errors=errors,
          )
      )

  instance_groups = zonal_instance_groups + regional_instance_groups
  instance_group_uri_to_size = {ig.selfLink: ig.size for ig in instance_groups}

  if errors:
    utils.RaiseToolException(errors)

  for item in items:
    self_link = item['selfLink']
    gm_self_link = self_link.replace(
        '/instanceGroupManagers/', '/instanceGroups/'
    )

    item['size'] = str(instance_group_uri_to_size.get(gm_self_link, ''))
    yield item


def GetHealthCheckUri(resources, args):
  """Creates health check reference from args."""
  if args.health_check:
    ref = auto_healing_utils.HEALTH_CHECK_ARG.ResolveAsResource(
        args,
        resources,
        default_scope=compute_flags.compute_scope.ScopeEnum.GLOBAL,
    )
    return ref.SelfLink()
  if args.http_health_check:
    return resources.Parse(
        args.http_health_check,
        params={'project': properties.VALUES.core.project.GetOrFail},
        collection='compute.httpHealthChecks',
    ).SelfLink()
  if args.https_health_check:
    return resources.Parse(
        args.https_health_check,
        params={'project': properties.VALUES.core.project.GetOrFail},
        collection='compute.httpsHealthChecks',
    ).SelfLink()


# TODO(b/70203649): improve/fix method (no silent errors, add optimizations)
def CreateInstanceReferences(holder, igm_ref, instance_names):
  """Creates references to instances in instance group (zonal or regional)."""
  if igm_ref.Collection() == 'compute.instanceGroupManagers':
    instance_refs = []
    for instance in instance_names:
      instance_refs.append(
          holder.resources.Parse(
              instance,
              params={
                  'project': igm_ref.project,
                  'zone': igm_ref.zone,
              },
              collection='compute.instances',
          )
      )
    return instance_refs
  elif igm_ref.Collection() == 'compute.regionInstanceGroupManagers':
    messages = holder.client.messages
    request = (
        messages.ComputeRegionInstanceGroupManagersListManagedInstancesRequest
    )(
        instanceGroupManager=igm_ref.Name(),
        region=igm_ref.region,
        project=igm_ref.project,
    )
    managed_instances = list_pager.YieldFromList(
        service=holder.client.apitools_client.regionInstanceGroupManagers,
        batch_size=500,
        request=request,
        method='ListManagedInstances',
        field='managedInstances',
    )
    instances_to_return = []
    for instance_ref in managed_instances:
      if (
          path_simplifier.Name(instance_ref.instance) in instance_names
          or instance_ref.instance in instance_names
      ):
        instances_to_return.append(instance_ref.instance)
    return instances_to_return
  else:
    raise ValueError('Unknown reference type {0}'.format(igm_ref.Collection()))


def GetDeviceNamesFromStatefulPolicy(stateful_policy):
  """Returns a list of device names from given StatefulPolicy message."""
  if (
      not stateful_policy
      or not stateful_policy.preservedState
      or not stateful_policy.preservedState.disks
  ):
    return []
  return [
      disk.key
      for disk in stateful_policy.preservedState.disks.additionalProperties
  ]


def GetInterfaceNamesFromStatefulPolicyForInternalIPs(stateful_policy):
  """Returns a list of stateful internal IPs interface names."""
  return _GetInterfaceNamesFromStatefulPolicyForIPs(
      stateful_policy,
      lambda stateful_policy: stateful_policy.preservedState.internalIPs,
  )


def GetInterfaceNamesFromStatefulPolicyForExternalIPs(stateful_policy):
  """Returns a list of stateful external IPs interface names."""
  return _GetInterfaceNamesFromStatefulPolicyForIPs(
      stateful_policy,
      lambda stateful_policy: stateful_policy.preservedState.externalIPs,
  )


def _GetInterfaceNamesFromStatefulPolicyForIPs(
    stateful_policy, ips_field_lambda
):
  if not stateful_policy or not stateful_policy.preservedState:
    return []
  ips = ips_field_lambda(stateful_policy)
  if not ips:
    return []
  return [ip.key for ip in ips.additionalProperties]


def IsAutoscalerNew(autoscaler):
  return getattr(autoscaler, 'name', None) is None


def PatchUpdatePolicy(client, args, update_policy):
  """Returns an update_policy with attributes from args applied."""
  result = None
  if update_policy is None:
    update_policy = client.messages.InstanceGroupManagerUpdatePolicy()
  if args.IsSpecified('instance_redistribution_type'):
    update_policy.instanceRedistributionType = (
        client.messages.InstanceGroupManagerUpdatePolicy.InstanceRedistributionTypeValueValuesEnum
    )(args.instance_redistribution_type.upper())
    result = update_policy
  if args.IsSpecified('update_policy_type'):
    update_policy.type = update_instances_utils.ParseUpdatePolicyType(
        '--update-policy-update-type', args.update_policy_type, client.messages
    )
    result = update_policy
  if args.IsSpecified('update_policy_max_surge'):
    update_policy.maxSurge = update_instances_utils.ParseFixedOrPercent(
        '--update-policy-max-surge',
        'max-surge',
        args.update_policy_max_surge,
        client.messages,
    )
    result = update_policy
  if args.IsSpecified('update_policy_max_unavailable'):
    update_policy.maxUnavailable = update_instances_utils.ParseFixedOrPercent(
        '--update-policy-max-unavailable',
        'max-unavailable',
        args.update_policy_max_unavailable,
        client.messages,
    )
    result = update_policy
  if args.IsSpecified('update_policy_minimal_action'):
    update_policy.minimalAction = (
        update_instances_utils.ParseInstanceActionFlag
    )(
        '--update-policy-minimal-action',
        args.update_policy_minimal_action,
        client.messages.InstanceGroupManagerUpdatePolicy.MinimalActionValueValuesEnum,
    )
    result = update_policy
  if args.IsSpecified('update_policy_most_disruptive_action'):
    update_policy.mostDisruptiveAllowedAction = (
        update_instances_utils.ParseInstanceActionFlag
    )(
        '--update-policy-most-disruptive-action',
        args.update_policy_most_disruptive_action,
        client.messages.InstanceGroupManagerUpdatePolicy.MostDisruptiveAllowedActionValueValuesEnum,
    )
    result = update_policy
  if args.IsSpecified('update_policy_replacement_method'):
    replacement_method = update_instances_utils.ParseReplacementMethod(
        args.update_policy_replacement_method, client.messages
    )
    update_policy.replacementMethod = replacement_method
    result = update_policy
  # min_ready is available in alpha and beta APIs only
  if hasattr(args, 'update_policy_min_ready') and args.IsSpecified(
      'update_policy_min_ready'
  ):
    update_policy.minReadySec = args.update_policy_min_ready
    result = update_policy
  return result


def ListPerInstanceConfigs(client, igm_ref):
  """Lists per-instance-configs for a given IGM."""
  if not hasattr(
      client.messages,
      'ComputeInstanceGroupManagersListPerInstanceConfigsRequest',
  ):
    return []
  if igm_ref.Collection() == 'compute.instanceGroupManagers':
    service = client.apitools_client.instanceGroupManagers
    request = (
        client.messages.ComputeInstanceGroupManagersListPerInstanceConfigsRequest
    )(
        instanceGroupManager=igm_ref.Name(),
        project=igm_ref.project,
        zone=igm_ref.zone,
    )
  elif igm_ref.Collection() == 'compute.regionInstanceGroupManagers':
    service = client.apitools_client.regionInstanceGroupManagers
    request = (
        client.messages.ComputeRegionInstanceGroupManagersListPerInstanceConfigsRequest
    )(
        instanceGroupManager=igm_ref.Name(),
        project=igm_ref.project,
        region=igm_ref.region,
    )
  else:
    raise ValueError('Unknown reference type {0}'.format(igm_ref.Collection()))

  errors = []
  results = list(
      request_helper.MakeRequests(
          requests=[(service, 'ListPerInstanceConfigs', request)],
          http=client.apitools_client.http,
          batch_url=client.batch_url,
          errors=errors,
      )
  )

  if not results:
    return []
  return results[0].items


def IsStateful(igm_info):
  """For a given IGM, returns if it is stateful."""
  return (
      hasattr(igm_info.status, 'stateful')
      and hasattr(igm_info.status.stateful, 'hasStatefulConfig')
      and igm_info.status.stateful.hasStatefulConfig
  )


def ValidateIgmReadyForStatefulness(igm_resource, client):
  """Throws exception if IGM is in state not ready for adding statefulness."""
  if not igm_resource.updatePolicy:
    return

  client_update_policy = client.messages.InstanceGroupManagerUpdatePolicy
  type_is_proactive = igm_resource.updatePolicy.type == (
      client_update_policy.TypeValueValuesEnum.PROACTIVE
  )
  replacement_method_is_substitute = (
      igm_resource.updatePolicy.replacementMethod
      == (client_update_policy.ReplacementMethodValueValuesEnum.SUBSTITUTE)
  )
  instance_redistribution_type_is_proactive = igm_resource.updatePolicy.instanceRedistributionType == (
      client_update_policy.InstanceRedistributionTypeValueValuesEnum.PROACTIVE
  )

  if type_is_proactive and replacement_method_is_substitute:
    raise exceptions.Error(
        'Stateful IGMs cannot use SUBSTITUTE replacement method. '
        'Try `gcloud compute instance-groups managed '
        'rolling-update stop-proactive-update'
    )
  if instance_redistribution_type_is_proactive:
    raise exceptions.Error(
        'Stateful regional IGMs cannot use proactive instance redistribution. '
        'Try `gcloud compute instance-groups managed '
        'update --instance-redistribution-type=NONE'
    )


def ValueOrNone(message):
  """Return message if message is a proto with one or more fields set or None.

  If message is None or is the default proto, it returns None. In all other
  cases, it returns the message.

  Args:
    message: A generated proto message object.

  Returns:
    message if message is initialized or None
  """
  if message is None:
    return message
  default_object = message.__class__()
  return message if message != default_object else None


def RegisterCustomInstancePropertiesPatchEncoders(client):
  """Registers decoders and encoders that will handle null values for maps in InstancePropertiesPatch message."""

  def _NullValueEncoder(message):
    """Encoder for use when removing map entries.

    It works around issues with proto encoding of AdditionalProperties with null
    values by directly encoding a dict of keys with None values into json,
    skipping proto-based encoding.

    Args:
      message: an instance of InstancePropertiesPatch.MetadataValue or
        InstancePropertiesPatch.LabelsValue

    Returns:
      JSON string with null value.
    """
    return json.dumps({
        property.key: property.value
        for property in message.additionalProperties
    })

  def _NullMetadataDecoder(data):
    """Decoder for metadata map entries.

    Args:
      data: JSON representation of metadata map.

    Returns:
      Instance of InstancePropertiesPatch.MetadataValue.
    """
    py_object = json.loads(data)
    return client.messages.InstancePropertiesPatch.MetadataValue(
        additionalProperties=[
            client.messages.InstancePropertiesPatch.MetadataValue.AdditionalProperty(
                key=key, value=value
            )
            for key, value in py_object.items()
        ]
    )

  def _NullLabelsDecoder(data):
    """Decoder for labels map entries.

    Args:
      data: JSON representation of labels map.

    Returns:
      Instance of InstancePropertiesPatch.LabelsValue.
    """
    py_object = json.loads(data)
    return client.messages.InstancePropertiesPatch.LabelsValue(
        additionalProperties=[
            client.messages.InstancePropertiesPatch.LabelsValue.AdditionalProperty(
                key=key, value=value
            )
            for key, value in py_object.items()
        ]
    )

  encoding.RegisterCustomMessageCodec(
      encoder=_NullValueEncoder, decoder=_NullMetadataDecoder
  )(client.messages.InstancePropertiesPatch.MetadataValue)
  encoding.RegisterCustomMessageCodec(
      encoder=_NullValueEncoder, decoder=_NullLabelsDecoder
  )(client.messages.InstancePropertiesPatch.LabelsValue)


def RegisterCustomStatefulIpsPatchEncoders(client):
  """Registers decoders and encoders that will handle null values for Internal and External IPs maps in StatefulPolicy message."""

  auto_delete_map = {
      'NEVER': client.messages.StatefulPolicyPreservedStateNetworkIp(
          autoDelete=client.messages.StatefulPolicyPreservedStateNetworkIp.AutoDeleteValueValuesEnum.NEVER
      ),
      'ON_PERMANENT_INSTANCE_DELETION': client.messages.StatefulPolicyPreservedStateNetworkIp(
          autoDelete=client.messages.StatefulPolicyPreservedStateNetworkIp.AutoDeleteValueValuesEnum.ON_PERMANENT_INSTANCE_DELETION
      ),
  }

  def _StatefulIpsValueEncoder(message):
    """Encoder for Stateful Ips map entries.

    It works around issues with proto encoding of StatefulPolicyPreservedState
    with null values by directly encoding a dict of keys with None values into
    json, skipping proto-based encoding.

    Args:
      message: an instance of StatefulPolicyPreservedState.InternalIPsValue or
        StatefulPolicyPreservedState.ExternalIPsValue

    Returns:
      JSON string with null value.
    """
    return json.dumps({
        property.key: _GetAutodeleteOrNone(property)
        for property in message.additionalProperties
    })

  def _GetAutodeleteOrNone(autodelete):
    if autodelete.value is None:
      return None
    return {'autoDelete': autodelete.value.autoDelete.name}

  def _InternalStatefulIpsDecoder(data):
    """Decoder for Stateful Ips map entries.

    Args:
      data: JSON representation of Internal Stateful Ips.

    Returns:
      Instance of StatefulPolicyPreservedState.InternalIPsValue.
    """
    ips_value = client.messages.StatefulPolicyPreservedState.InternalIPsValue
    return _CommonStatefulIpsDecoder(data, ips_value)

  def _ExternalStatefulIpsDecoder(data):
    """Decoder for Stateful Ips map entries.

    Args:
      data: JSON representation of External Stateful Ips.

    Returns:
      Instance of
      StatefulPolicyPreservedState.ExternalIPsValue.AdditionalProperty.
    """
    ips_value = client.messages.StatefulPolicyPreservedState.ExternalIPsValue
    return _CommonStatefulIpsDecoder(data, ips_value)

  def _CommonStatefulIpsDecoder(data, ips_value):
    py_object = json.loads(data)
    return ips_value(
        additionalProperties=[
            ips_value.AdditionalProperty(
                key=key, value=auto_delete_map[value['autoDelete']]
            )
            for key, value in py_object.items()
        ]
    )

  encoding.RegisterCustomMessageCodec(
      encoder=_StatefulIpsValueEncoder, decoder=_InternalStatefulIpsDecoder
  )(client.messages.StatefulPolicyPreservedState.InternalIPsValue)
  encoding.RegisterCustomMessageCodec(
      encoder=_StatefulIpsValueEncoder, decoder=_ExternalStatefulIpsDecoder
  )(client.messages.StatefulPolicyPreservedState.ExternalIPsValue)


def RegisterCustomStatefulDisksPatchEncoders(client):
  """Registers decoders and encoders that will handle null values for Stateful Disks map in StatefulPolicy message."""

  auto_delete_map = {
      'NEVER': client.messages.StatefulPolicyPreservedStateDiskDevice(
          autoDelete=client.messages.StatefulPolicyPreservedStateDiskDevice.AutoDeleteValueValuesEnum.NEVER
      ),
      'ON_PERMANENT_INSTANCE_DELETION': client.messages.StatefulPolicyPreservedStateDiskDevice(
          autoDelete=client.messages.StatefulPolicyPreservedStateDiskDevice.AutoDeleteValueValuesEnum.ON_PERMANENT_INSTANCE_DELETION
      ),
  }

  def _StatefulDisksValueEncoder(message):
    """Encoder for Stateful Disks map entries.

    It works around issues with proto encoding of StatefulPolicyPreservedState
    with null values by directly encoding a dict of keys with None values into
    json, skipping proto-based encoding.

    Args:
      message: an instance of StatefulPolicyPreservedState.DisksValue

    Returns:
      JSON string with null value.
    """
    return json.dumps({
        property.key: _GetAutodeleteOrNone(property)
        for property in message.additionalProperties
    })

  def _GetAutodeleteOrNone(autodelete):
    if autodelete.value is None:
      return None
    return {'autoDelete': autodelete.value.autoDelete.name}

  def _StatefulDisksDecoder(data):
    """Decoder for Stateful Disks map entries.

    Args:
      data: JSON representation of Stateful Disks.

    Returns:
      Instance of StatefulPolicyPreservedState.DisksValue.
    """
    disk_device_value = client.messages.StatefulPolicyPreservedState.DisksValue
    py_object = json.loads(data)
    return disk_device_value(
        additionalProperties=[
            disk_device_value.AdditionalProperty(
                key=key, value=auto_delete_map[value['autoDelete']]
            )
            for key, value in py_object.items()
        ]
    )

  encoding.RegisterCustomMessageCodec(
      encoder=_StatefulDisksValueEncoder, decoder=_StatefulDisksDecoder
  )(client.messages.StatefulPolicyPreservedState.DisksValue)


def RegisterInstanceSelectionsPatchEncoders(messages):
  """Registers encoders that will handle null values for Instance Selections in InstanceFlexibilityPolicy message."""

  def _InstanceSelectionsValueEncoder(message):
    """Encoder for Instance Selections map entries.

    It works around issues with proto encoding of InstanceSelections
    with null values by directly encoding a dict of keys with None values into
    json, skipping proto-based encoding.

    Args:
      message: an instance of
        InstanceGroupManagerInstanceFlexibilityPolicy.InstanceSelectionsValue

    Returns:
      JSON string with null value.
    """

    def _GetInstanceSelectionValueOrNone(prop):
      if prop.value is None:
        return None
      disks = None
      if prop.value.disks:
        disks = [
            encoding.MessageToPyValue(disk) for disk in prop.value.disks
        ]
      return {
          'rank': prop.value.rank,
          'machineTypes': prop.value.machineTypes,
          'minCpuPlatform': prop.value.minCpuPlatform,
          'disks': disks,
      }

    return json.dumps({
        property.key: _GetInstanceSelectionValueOrNone(property)
        for property in message.additionalProperties
    })

  def _InstanceSelectionsDecoder(data):
    """Decoder for Instance Selections map entries.

    Args:
      data: JSON representation of Instance Selections.

    Returns:
      Instance of
      InstanceGroupManagerInstanceFlexibilityPolicy.InstanceSelectionsValue.
    """
    instance_selections_value = (
        messages.InstanceGroupManagerInstanceFlexibilityPolicy.InstanceSelectionsValue
    )
    py_object = json.loads(data)
    return instance_selections_value(
        additionalProperties=[
            instance_selections_value.AdditionalProperty(key=key, value=value)
            for key, value in py_object.items()
        ]
    )

  encoding.RegisterCustomMessageCodec(
      encoder=_InstanceSelectionsValueEncoder,
      decoder=_InstanceSelectionsDecoder,
  )(
      messages.InstanceGroupManagerInstanceFlexibilityPolicy.InstanceSelectionsValue
  )


def RegisterResourcePoliciesPatchEncoders(messages: types.ModuleType) -> None:
  """Registers encoders that will handle null values for resource policies in ResourcePolicies message."""

  def _ResourcePoliciesEncoder(message):
    """Encoder for Resource Policies message.

    It works around issues with proto encoding of ResourcePolicies
    with null values by directly encoding a message with None value into
    json, skipping proto-based encoding.

    Args:
      message: an instance of InstanceGroupManagerResourcePolicies

    Returns:
      JSON string with null value.
    """

    if message.workloadPolicy is None:
      return 'null'
    return protojson.encode_message(message)

  def _ResourcePoliciesDecoder(data):
    """Decoder for Resource Policies message.

    Args:
      data: JSON representation of Resource Policies.

    Returns:
      Instance of InstanceGroupManagerResourcePolicies.
    """

    return protojson.decode_message(
        messages.InstanceGroupManagerResourcePolicies, data
    )

  encoding.RegisterCustomMessageCodec(
      encoder=_ResourcePoliciesEncoder,
      decoder=_ResourcePoliciesDecoder,
  )(messages.InstanceGroupManagerResourcePolicies)


def CreateTargetSizePolicy(messages, mode):
  """Creates target size policy from args."""
  target_size_policy = messages.InstanceGroupManagerTargetSizePolicy()
  mode_enum = arg_utils.ChoiceToEnumName(mode)
  target_size_policy.mode = (
      messages.InstanceGroupManagerTargetSizePolicy.ModeValueValuesEnum(
          mode_enum
      )
  )

  return target_size_policy
