229 lines
8.7 KiB
Python
229 lines
8.7 KiB
Python
# -*- coding: utf-8 -*- #
|
|
# Copyright 2021 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.
|
|
"""Command to create a Dataplex asset resource."""
|
|
|
|
from __future__ import absolute_import
|
|
from __future__ import division
|
|
from __future__ import unicode_literals
|
|
|
|
from googlecloudsdk.api_lib.dataplex import asset
|
|
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 flags
|
|
from googlecloudsdk.command_lib.dataplex import resource_args
|
|
from googlecloudsdk.command_lib.util.apis import arg_utils
|
|
from googlecloudsdk.command_lib.util.args import labels_util
|
|
from googlecloudsdk.core import log
|
|
|
|
|
|
def _CommonArgs(parser):
|
|
"""Create a common args."""
|
|
resource_args.AddAssetResourceArg(parser, 'to create.')
|
|
parser.add_argument(
|
|
'--validate-only',
|
|
action='store_true',
|
|
default=False,
|
|
help="Validate the create action, but don't actually perform it.",
|
|
)
|
|
parser.add_argument('--description', help='Description of the asset')
|
|
parser.add_argument('--display-name', help='Display name of the asset')
|
|
flags.AddDiscoveryArgs(parser)
|
|
base.ASYNC_FLAG.AddToParser(parser)
|
|
labels_util.AddCreateLabelsFlags(parser)
|
|
|
|
|
|
@base.ReleaseTracks(base.ReleaseTrack.GA)
|
|
class Create(base.Command):
|
|
"""Create a Dataplex asset resource.
|
|
|
|
An asset represents a cloud resource that is being managed within a lake as a
|
|
member of a zone.
|
|
|
|
This asset ID will be used to generate names such as table names when
|
|
publishing metadata to Hive Metastore and BigQuery.
|
|
* Must contain only lowercase letters, numbers, and hyphens.
|
|
* Must start with a letter.
|
|
* Must end with a number or a letter.
|
|
* Must be between 1-63 characters.
|
|
* Must be unique within the zone.
|
|
"""
|
|
|
|
detailed_help = {
|
|
'EXAMPLES':
|
|
"""\
|
|
To create a Dataplex asset with name `test-asset`, within zone
|
|
`test-zone`, in lake `test-lake`, in location `us-central1`, with
|
|
resource type `STORAGE_BUCKET`, with resource name
|
|
`projects/test-project/buckets/test-bucket`, run:
|
|
|
|
$ {command} test-asset --location=us-central --lake=test-lake --zone=test-zone --resource-type=STORAGE_BUCKET --resource-name=projects/test-project/buckets/test-bucket
|
|
|
|
To create a Dataplex asset with name `test-asset`, within zone
|
|
`test-zone`, in lake `test-lake`, in location `us-central1`, with
|
|
resource type `STORAGE_BUCKET`, with resource name
|
|
`projects/test-project/buckets/test-bucket`, with discovery-enabled,
|
|
and discovery schedule `0 * * * *`, run:
|
|
|
|
$ {command} test-asset --location=us-central --lake=test-lake --zone=test-zone --resource-type=STORAGE_BUCKET --resource-name=projects/test-project/buckets/test-bucket --discovery-enabled --discovery-schedule="0 * * * *"
|
|
""",
|
|
}
|
|
|
|
@staticmethod
|
|
def Args(parser):
|
|
_CommonArgs(parser)
|
|
resource_spec = parser.add_group(
|
|
required=True,
|
|
help='Specification of the resource that is referenced by this asset.',
|
|
)
|
|
resource_spec.add_argument(
|
|
'--resource-name',
|
|
help=""""Relative name of the cloud resource that contains the data that
|
|
is being managed within a lake. For example:
|
|
`projects/{project_number}/buckets/{bucket_id}` or `projects/{project_number}/datasets/{dataset_id}`""",
|
|
)
|
|
resource_spec.add_argument(
|
|
'--resource-type',
|
|
required=True,
|
|
choices={
|
|
'STORAGE_BUCKET': 'Cloud Storage Bucket',
|
|
'BIGQUERY_DATASET': 'BigQuery Dataset',
|
|
},
|
|
type=arg_utils.ChoiceToEnumName,
|
|
help='Type',
|
|
)
|
|
resource_spec.add_argument(
|
|
'--resource-read-access-mode',
|
|
required=False,
|
|
choices={
|
|
'DIRECT': 'Data is accessed directly using storage APIs',
|
|
'MANAGED': (
|
|
'Data is accessed through a managed interface using BigQuery'
|
|
' APIs.'
|
|
),
|
|
},
|
|
type=arg_utils.ChoiceToEnumName,
|
|
help='Read access mode',
|
|
)
|
|
|
|
def GenerateRequest(self, args):
|
|
return asset.GenerateAssetForCreateRequest(args)
|
|
|
|
@gcloud_exception.CatchHTTPErrorRaiseHTTPException(
|
|
'Status code: {status_code}. {status_message}.')
|
|
def Run(self, args):
|
|
asset_ref = args.CONCEPTS.asset.Parse()
|
|
dataplex_client = dataplex_util.GetClientInstance()
|
|
create_req_op = dataplex_client.projects_locations_lakes_zones_assets.Create(
|
|
dataplex_util.GetMessageModule().DataplexProjectsLocationsLakesZonesAssetsCreateRequest(
|
|
assetId=asset_ref.Name(),
|
|
parent=asset_ref.Parent().RelativeName(),
|
|
validateOnly=args.validate_only,
|
|
googleCloudDataplexV1Asset=self.GenerateRequest(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_:
|
|
asset.WaitForOperation(create_req_op)
|
|
log.CreatedResource(
|
|
asset_ref.Name(),
|
|
details='Asset created in [{0}]'
|
|
.format(asset_ref.Parent().RelativeName()))
|
|
return
|
|
|
|
log.status.Print('Creating [{0}] with operation [{1}].'.format(
|
|
asset_ref, create_req_op.name))
|
|
|
|
|
|
@base.ReleaseTracks(base.ReleaseTrack.ALPHA)
|
|
class CreateAlpha(Create):
|
|
"""Create a Dataplex asset resource.
|
|
|
|
An asset represents a cloud resource that is being managed within a lake as a
|
|
member of a zone.
|
|
|
|
This asset ID will be used to generate names such as table names when
|
|
publishing metadata to Hive Metastore and BigQuery.
|
|
* Must contain only lowercase letters, numbers, and hyphens.
|
|
* Must start with a letter.
|
|
* Must end with a number or a letter.
|
|
* Must be between 1-63 characters.
|
|
* Must be unique within the zone.
|
|
"""
|
|
|
|
detailed_help = {
|
|
'EXAMPLES': """\
|
|
To create a Dataplex asset with name `test-asset`, within zone
|
|
`test-zone`, in lake `test-lake`, in location `us-central1`, with
|
|
resource type `STORAGE_BUCKET`, with resource name
|
|
`projects/test-project/buckets/test-bucket`, run:
|
|
|
|
$ {command} test-asset --location=us-central --lake=test-lake --zone=test-zone --resource-type=STORAGE_BUCKET --resource-name=projects/test-project/buckets/test-bucket
|
|
|
|
To create a Dataplex asset with name `test-asset`, within zone
|
|
`test-zone`, in lake `test-lake`, in location `us-central1`, with
|
|
resource type `STORAGE_BUCKET`, with resource name
|
|
`projects/test-project/buckets/test-bucket`, with discovery-enabled,
|
|
and discovery schedule `0 * * * *`, run:
|
|
|
|
$ {command} test-asset --location=us-central --lake=test-lake --zone=test-zone --resource-type=STORAGE_BUCKET --resource-name=projects/test-project/buckets/test-bucket --discovery-enabled --discovery-schedule="0 * * * *"
|
|
""",
|
|
}
|
|
|
|
def GenerateRequest(self, args):
|
|
return asset.GenerateAssetForCreateRequestAlpha(args)
|
|
|
|
@staticmethod
|
|
def Args(parser):
|
|
_CommonArgs(parser)
|
|
resource_spec = parser.add_group(
|
|
required=True,
|
|
help='Specification of the resource that is referenced by this asset.',
|
|
)
|
|
resource_spec.add_argument(
|
|
'--resource-name',
|
|
help=""""Relative name of the cloud resource that contains the data that
|
|
is being managed within a lake. For example:
|
|
`projects/{project_number}/buckets/{bucket_id}` or `projects/{project_number}/datasets/{dataset_id}`""",
|
|
)
|
|
resource_spec.add_argument(
|
|
'--resource-type',
|
|
required=True,
|
|
choices={
|
|
'STORAGE_BUCKET': 'Cloud Storage Bucket',
|
|
'BIGQUERY_DATASET': 'BigQuery Dataset',
|
|
},
|
|
type=arg_utils.ChoiceToEnumName,
|
|
help='Type',
|
|
)
|
|
resource_spec.add_argument(
|
|
'--resource-read-access-mode',
|
|
required=False,
|
|
choices={
|
|
'DIRECT': 'Data is accessed directly using storage APIs',
|
|
'MANAGED': (
|
|
'Data is accessed through a managed interface using BigQuery'
|
|
' APIs.'
|
|
),
|
|
},
|
|
type=arg_utils.ChoiceToEnumName,
|
|
help='Read access mode',
|
|
)
|