File: //snap/google-cloud-cli/394/lib/surface/dataplex/governance_rules/create.py
# -*- coding: utf-8 -*- #
# Copyright 2024 Google Inc. 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.
"""`gcloud dataplex governance-rules create` command."""
from __future__ import absolute_import
from __future__ import division
from __future__ import unicode_literals
from googlecloudsdk.api_lib.dataplex import governance_rule
from googlecloudsdk.api_lib.dataplex import util as dataplex_util
from googlecloudsdk.api_lib.util import exceptions as gcloud_exception
from googlecloudsdk.calliope import base
from googlecloudsdk.command_lib.dataplex import resource_args
from googlecloudsdk.command_lib.util.args import labels_util
from googlecloudsdk.core import log
@base.ReleaseTracks(base.ReleaseTrack.ALPHA)
@base.DefaultUniverseOnly
@base.Hidden
class Create(base.Command):
"""Create a Dataplex Governance Rule.
Governance Rule is a template for creating Governance Rules.
"""
detailed_help = {
'EXAMPLES': """\
To create Governance Rule `test-governance-rule` in project `test-dataplex` at location `us-central1`,
with description `test description`, displayName `test display name` and ruleMetaDataFile `file.json`, run:
$ {command} test-governance-rule --location=us-central1 --project=test-project --description='test description'
--display-name='test display name'
--rule-metadata-file='file.json'
""",
}
@staticmethod
def Args(parser):
resource_args.AddGovernanceRuleResourceArg(parser, 'to create.')
parser.add_argument(
'--description',
required=False,
help='Description of the Governance Rule.',
)
parser.add_argument(
'--display-name',
required=False,
help='Display name of the Governance Rule.',
)
parser.add_argument(
'--rule-metadata-file',
required=True,
help='The name of the JSON or YAML file to define rule metadata.',
)
async_type = parser.add_group(mutex=True, required=False)
async_type.add_argument(
'--validate-only',
action='store_true',
default=False,
help="Validate the create action, but don't actually perform it.",
)
base.ASYNC_FLAG.AddToParser(async_type)
labels_util.AddCreateLabelsFlags(parser)
@gcloud_exception.CatchHTTPErrorRaiseHTTPException(
'Status code: {status_code}. {status_message}.'
)
def Run(self, args):
governance_rule_ref = args.CONCEPTS.governance_rule.Parse()
dataplex_client = dataplex_util.GetClientInstance()
create_req_op = dataplex_client.projects_locations_governanceRules.Create(
dataplex_util.GetMessageModule().DataplexProjectsLocationsGovernanceRulesCreateRequest(
governanceRuleId=governance_rule_ref.Name(),
parent=governance_rule_ref.Parent().RelativeName(),
validateOnly=args.validate_only,
googleCloudDataplexV1GovernanceRule=governance_rule.GenerateGovernanceRuleForCreateRequest(
args
),
)
)
validate_only = getattr(args, 'validate_only', False)
if validate_only:
log.status.Print('Validation complete.')
return
async_ = getattr(args, 'async_', False)
if not async_:
response = governance_rule.WaitForOperation(create_req_op)
log.CreatedResource(
response.name,
details=(
'Governance Rule created in project [{0}] with location [{1}]'
.format(
governance_rule_ref.projectsId,
governance_rule_ref.locationsId,
)
),
)
return response
log.status.Print(
'Creating Governance Rule [{0}] with operation [{1}].'.format(
governance_rule_ref, create_req_op.name
)
)
return create_req_op