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

"""Shared flags definitions for flags and arguments for BigQuery Exports."""


from googlecloudsdk.calliope import base

DATASET_FLAG_OPTIONAL = base.Argument(
    '--dataset',
    help="""
    The dataset to write findings updates to.""",
)

DATASET_FLAG_REQUIRED = base.Argument(
    '--dataset',
    required=True,
    help="""
    The dataset to write findings updates to.""",
)

DESCRIPTION_FLAG = base.Argument(
    '--description',
    help="""
      The text that will be used to describe a BigQuery export.""",
)

# Note:
# SCC's custom --filter is passing the streaming config filter as part of
# the request body. However --filter is a global filter flag in gcloud. The
# --filter flag in gcloud (outside of this command) is used for client side
# filtering. This has led to a collision in logic as gcloud believes the
# update is trying to perform client side filtering. In the context of
# notifications, it is instead updating the streaming config filter.
#
# Any future new commands should reconsider not using --filter for this logic
# and perhaps use a different name to avoid any collisions with gcloud logic.
FILTER_FLAG = base.Argument(
    '--filter',
    help="""
    The filter string which will applied to findings muted by a BigQuery export.
    """,
)

PAGE_TOKEN_FLAG = base.Argument(
    '--page-token',
    help="""
      Response objects will return a non-null value for page-token to
      indicate that there is at least one additional page of data. User can
      either directly request that page by specifying the page-token
      explicitly or let gcloud fetch one-page-at-a-time.""",
)

UPDATE_MASK_FLAG = base.Argument(
    '--update-mask',
    help="""
        Optional: If left unspecified (default), an update-mask is
        automatically created using the flags specified in the command and only
        those values are updated.
    """,
)


def AddBigQueryPositionalArgument(parser):
  """Add BigQuery Export as a positional argument."""
  parser.add_argument(
      'BIG_QUERY_EXPORT',
      metavar='BIG_QUERY_EXPORT',
      help="""\
        ID of the BigQuery export e.g. `my-bq-export` or the full
        resource name of the BigQuery export e.g.
        `organizations/123/bigQueryExports/my-bq-export`.
        """,
  )
  return parser


def AddParentGroup(parser, required=False):
  """Set folder/org/project as mutually exclusive group."""
  resource_group = parser.add_group(required=required, mutex=True)
  resource_group.add_argument(
      '--organization',
      help="""\
        Organization where the BigQuery export resides. Formatted as
        organizations/123 or just 123.
        """,
  )
  resource_group.add_argument(
      '--folder',
      help="""\
        Folder where the BigQuery export resides. Formatted as folders/456 or
        just 456.
        """,
  )
  resource_group.add_argument(
      '--project',
      help="""\
        Project (id or number) where the BigQuery export resides. Formatted
        as projects/789 or just 789.
        """,
  )
  return parser