feat: Add new gcloud commands, API clients, and third-party libraries across various services.

This commit is contained in:
2026-01-01 20:26:35 +01:00
parent 5e23cbece0
commit a19e592eb7
25221 changed files with 8324611 additions and 0 deletions

View File

@@ -0,0 +1,32 @@
# -*- coding: utf-8 -*- #
# Copyright 2024 Google LLC. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
"""Command group for Dataplex Glossary services."""
from __future__ import absolute_import
from __future__ import division
from __future__ import unicode_literals
from googlecloudsdk.calliope import base
@base.ReleaseTracks(base.ReleaseTrack.ALPHA, base.ReleaseTrack.GA)
@base.DefaultUniverseOnly
class Glossaries(base.Group):
"""Manage Dataplex glossaries.
A Glossary represents a collection of Categories and Terms.
"""
category = base.DATA_ANALYTICS_CATEGORY

View File

@@ -0,0 +1,54 @@
# -*- 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 glossaries add-iam-policy-binding` command."""
from googlecloudsdk.api_lib.dataplex import glossary
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.iam import iam_util
@base.ReleaseTracks(base.ReleaseTrack.ALPHA, base.ReleaseTrack.GA)
@base.DefaultUniverseOnly
class AddIamPolicyBinding(base.Command):
"""Add IAM policy binding to a Dataplex Glossary."""
detailed_help = {
'EXAMPLES': """\
To add an IAM policy binding for the role of `roles/dataplex.viewer`
for the user `test-user@gmail.com` to Glossary `test-glossary` in location
`us-central`, run:
$ {command} test-glossary --project=test-project --location=us-central1 --role=roles/dataplex.viewer --member=user:test-user@gmail.com
See https://cloud.google.com/dataplex/docs/iam-roles for details of
policy role and member types.
""",
}
@staticmethod
def Args(parser):
resource_args.AddGlossaryResourceArg(
parser, 'to add IAM policy binding to.'
)
iam_util.AddArgsForAddIamPolicyBinding(parser)
@gcloud_exception.CatchHTTPErrorRaiseHTTPException(
'Status code: {status_code}. {status_message}.'
)
def Run(self, args):
glossary_ref = args.CONCEPTS.glossary.Parse()
result = glossary.GlossaryAddIamPolicyBinding(
glossary_ref, args.member, args.role
)
return result

View File

@@ -0,0 +1,28 @@
# -*- coding: utf-8 -*- #
# Copyright 2024 Google LLC. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
"""Command group for Dataplex glossary category services."""
from googlecloudsdk.calliope import base
@base.ReleaseTracks(base.ReleaseTrack.ALPHA, base.ReleaseTrack.GA)
@base.DefaultUniverseOnly
class GlossaryCategories(base.Group):
"""Manage Dataplex glossary categories.
A glossary category represents a collection of glossary categories and
glossary terms within a glossary that are related to each other.
"""
category = base.DATA_ANALYTICS_CATEGORY

View File

@@ -0,0 +1,96 @@
# -*- 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 glossaries categories create` command."""
from googlecloudsdk.api_lib.dataplex import glossary
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.ReleaseTrack.GA)
@base.DefaultUniverseOnly
class Create(base.Command):
"""Creates a glossary category.
A glossary category represents a collection of glossary categories and
glossary terms within a glossary that are related to each other.
"""
detailed_help = {
'EXAMPLES': """\
To create a glossary category `test-category` in glossary `test-glossary` in project `test-project` in
location `us-central1`, with description `test description`,
displayName `displayName` and parent `projects/test-project/locations/us-central1/glossaries/test-glossary` , run:
$ {command} test-category --glossary=test-glossary
--location=us-central1 --project=test-project
--parent='projects/test-project/locations/us-central1/glossaries/test-glossary'
--description='test description' --display-name='displayName'
""",
}
@staticmethod
def Args(parser):
resource_args.AddGlossaryCategoryResourceArg(parser, 'to create.')
parser.add_argument(
'--display-name',
required=False,
help='Display name of the glossary category.',
)
parser.add_argument(
'--description',
required=False,
help='Description of the glossary category.',
)
parser.add_argument(
'--parent',
required=True,
help='Immediate parent of the created glossary category.',
)
labels_util.AddCreateLabelsFlags(parser)
@gcloud_exception.CatchHTTPErrorRaiseHTTPException(
'Status code: {status_code}. {status_message}.'
)
def Run(self, args):
glossary_category_ref = args.CONCEPTS.glossary_category.Parse()
dataplex_client = dataplex_util.GetClientInstance()
create_response = dataplex_client.projects_locations_glossaries_categories.Create(
dataplex_util.GetMessageModule().DataplexProjectsLocationsGlossariesCategoriesCreateRequest(
categoryId=glossary_category_ref.Name(),
parent=glossary_category_ref.Parent().RelativeName(),
googleCloudDataplexV1GlossaryCategory=glossary.GenerateGlossaryCategoryForCreateRequest(
args
),
)
)
log.CreatedResource(
create_response.name,
details=(
'Glossary category created in project [{0}] in location [{1}] in'
' glossary [{2}]'.format(
glossary_category_ref.projectsId,
glossary_category_ref.locationsId,
glossary_category_ref.glossariesId,
)
),
)
return create_response

View File

@@ -0,0 +1,18 @@
- release_tracks: [ALPHA, GA]
help_text:
brief: |
Deletes a glossary category.
description: |
Deletes a glossary category.
examples: |
To delete glossary category `test-category` in glossary `test-glossary` in project `test-project` in location `us-central1`, run:
$ {command} test-category --glossary=test-glossary --location=us-central1 --project=test-project
request:
ALPHA:
api_version: v1
collection: dataplex.projects.locations.glossaries.categories
arguments:
resource:
help_text: |
Arguments and flags that define the glossary category you want to delete.
spec: !REF googlecloudsdk.command_lib.dataplex.resources:glossary_category

View File

@@ -0,0 +1,19 @@
- release_tracks: [ALPHA, GA]
help_text:
brief: |
Describes a glossary category.
description: |
Describes a glossary category.
examples: |
To describe a glossary category `test-category` in glossary `test-glossary` in project `test-project` in loaction `us-central1`, run:
$ {command} test-category --glossary=test-glossary --location=us-central1 --project=test-project
request:
ALPHA:
api_version: v1
collection: dataplex.projects.locations.glossaries.categories
method: get
arguments:
resource:
help_text: |
Arguments and flags that define the glossary category you want to describe.
spec: !REF googlecloudsdk.command_lib.dataplex.resources:glossary_category

View File

@@ -0,0 +1,24 @@
- release_tracks: [ALPHA, GA]
help_text:
brief: |
List glossary categories.
description: |
List glossary categories.
examples: |
To list glossary categories in glossary `test-glossary` in location `us-central1` in project `test-project`, run :
$ {command} --glossary=test-glossary --location=us-central1 --project=test-project
request:
ALPHA:
api_version: v1
collection: dataplex.projects.locations.glossaries.categories
arguments:
resource:
help_text: |
Arguments and flags that define the glossary in which to list glossary categories.
spec: !REF googlecloudsdk.command_lib.dataplex.resources:glossary
response:
id_field: name

View File

@@ -0,0 +1,95 @@
# -*- 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 glossaries categories update` command."""
from googlecloudsdk.api_lib.dataplex import glossary
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.calliope import exceptions
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.ReleaseTrack.GA)
@base.DefaultUniverseOnly
class Update(base.Command):
"""Updates a glossary category."""
detailed_help = {
'EXAMPLES': """\
To update display name, desciption and labels of glossary category
`test-category` in glossary `test-glossary` in project `test-project`
in location `us-central1`, run:
$ {command} test-category --location=us-central1 --project=test-project
--glossary=test-glossary --description='updated description'
--display-name='updated displayName' --labels=key1=value1,key2=value2
To update parent of glossary category `test-category` in glossary
`test-glossary` in project `test-project` in location `us-central1`, run:
$ {command} test-category --location=us-central1 --project=test-project
--glossary=test-glossary --parent='projects/test-project/locations/us-central1/glossaries/updated-glossary'
""",
}
@staticmethod
def Args(parser):
resource_args.AddGlossaryCategoryResourceArg(parser, 'to update.')
parser.add_argument(
'--description',
required=False,
help='Description of the glossary category.',
)
parser.add_argument(
'--display-name',
required=False,
help='Display Name of the glossary category.',
)
parser.add_argument(
'--parent',
required=False,
help='Immediate parent of the created glossary category.',
)
labels_util.AddCreateLabelsFlags(parser)
@gcloud_exception.CatchHTTPErrorRaiseHTTPException(
'Status code: {status_code}. {status_message}.'
)
def Run(self, args):
update_mask = glossary.GenerateCategoryUpdateMask(args)
if len(update_mask) < 1:
raise exceptions.HttpException(
'Update command must specify at least one additional parameter to'
' change.'
)
glossary_category_ref = args.CONCEPTS.glossary_category.Parse()
dataplex_client = dataplex_util.GetClientInstance()
update_response = dataplex_client.projects_locations_glossaries_categories.Patch(
dataplex_util.GetMessageModule().DataplexProjectsLocationsGlossariesCategoriesPatchRequest(
name=glossary_category_ref.RelativeName(),
updateMask=','.join(update_mask),
googleCloudDataplexV1GlossaryCategory=glossary.GenerateGlossaryCategoryForUpdateRequest(
args
),
)
)
log.UpdatedResource(glossary_category_ref)
return update_response

View File

@@ -0,0 +1,98 @@
# -*- 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 glossaries create` command."""
from googlecloudsdk.api_lib.dataplex import glossary
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.ReleaseTrack.GA)
@base.DefaultUniverseOnly
class Create(base.Command):
"""Create a Dataplex Glossary resource.
A Glossary represents a collection of Categories and Terms.
"""
detailed_help = {
'EXAMPLES':
"""\
To create a Glossary `test-glossary` in project `test-dataplex` at
location `us-central1`, with description `test description` and
displayName `displayName` , run:
$ {command} test-glossary --location=us-central1 --project=test-dataplex --description='test description' --display-name='displayName'
""",
}
@staticmethod
def Args(parser):
resource_args.AddGlossaryResourceArg(parser, 'to create.')
parser.add_argument(
'--display-name', required=False, help='Display Name of the Glossary.'
)
parser.add_argument(
'--description', required=False, help='Description of the Glossary.'
)
async_group = parser.add_group(
mutex=True,
required=False)
async_group.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_group)
labels_util.AddCreateLabelsFlags(parser)
@gcloud_exception.CatchHTTPErrorRaiseHTTPException(
'Status code: {status_code}. {status_message}.')
def Run(self, args):
glossary_ref = args.CONCEPTS.glossary.Parse()
dataplex_client = dataplex_util.GetClientInstance()
create_req_op = dataplex_client.projects_locations_glossaries.Create(
dataplex_util.GetMessageModule(
).DataplexProjectsLocationsGlossariesCreateRequest(
glossaryId=glossary_ref.Name(),
parent=glossary_ref.Parent().RelativeName(),
validateOnly=args.validate_only,
googleCloudDataplexV1Glossary=glossary
.GenerateGlossaryForCreateRequest(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 = glossary.WaitForOperation(create_req_op)
log.CreatedResource(
response.name,
details='Glossary created in project [{0}] with location [{1}]'
.format(glossary_ref.projectsId,
glossary_ref.locationsId))
return response
log.status.Print(
'Creating Glossary [{0}] with operation [{1}].'.format(
glossary_ref, create_req_op.name))
return create_req_op

View File

@@ -0,0 +1,25 @@
- release_tracks: [ALPHA, GA]
help_text:
brief: |
Delete a Dataplex Glossary.
description: |
Delete a Dataplex Glossary.
examples: |
To Delete Glossary `test-glossary` in project `test-dataplex` at location `us-central1`, run:
$ {command} test-glossary --location=us-central1 --project=test-dataplex
request:
ALPHA:
api_version: v1
collection: dataplex.projects.locations.glossaries
arguments:
resource:
help_text: |
Arguments and flags that define the Dataplex Glossary you want to delete.
spec: !REF googlecloudsdk.command_lib.dataplex.resources:glossary
params:
- arg_name: etag
api_field: etag
help_text: |
etag value for particular Glossary.
async:
collection: dataplex.projects.locations.operations

View File

@@ -0,0 +1,21 @@
- release_tracks: [ALPHA, GA]
help_text:
brief: |
Describe a Glossary.
description: |
Describe a Glossary.
Displays all details of a Glossary given a valid Glossary ID.
examples: |
To describe a Dataplex Glossary `test-glossary` within location `us-central1` and in project `test-project`
$ {command} test-glossary --location=us-central1 --project=test-project
request:
ALPHA:
api_version: v1
collection: dataplex.projects.locations.glossaries
method: get
arguments:
resource:
help_text: |
Glossary you want to describe.
spec: !REF googlecloudsdk.command_lib.dataplex.resources:glossary

View File

@@ -0,0 +1,20 @@
- release_tracks: [ALPHA, GA]
help_text:
brief: |
Retrieve a Dataplex Glossary IAM policy.
description: |
Displays the IAM policy associated with a Dataplex Glossary resource.
If formatted as JSON, the output can be edited and used as
a policy file for *set-iam-policy*. The output includes an "etag"
field identifying the version emitted and allowing detection of
concurrent policy updates.
examples: |
To get the IAM policy of a Dataplex Glossary `test-glossary` in project `test-project` under location `us-central1`
$ {command} test-glossary --project=test-project --location=us-central1
request:
collection: dataplex.projects.locations.glossaries
arguments:
resource:
help_text: |
Arguments and flags that define the Dataplex Glossary IAM policy you want to retrieve.
spec: !REF googlecloudsdk.command_lib.dataplex.resources:glossary

View File

@@ -0,0 +1,22 @@
- release_tracks: [ALPHA, GA]
help_text:
brief: List Glossaries.
description: List Glossaries.
examples: |
To List Glossaries in project `test-dataplex` at location `us-central1`
$ {command} --location=us-central1 --project=test-dataplex
request:
collection: dataplex.projects.locations.glossaries
ALPHA:
api_version: v1
response:
id_field: name
arguments:
resource:
help_text: Location in which to list Glossaries.
spec: !REF googlecloudsdk.command_lib.dataplex.resources:location

View File

@@ -0,0 +1,54 @@
# -*- 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 glossaries remove-iam-policy-binding` command."""
from googlecloudsdk.api_lib.dataplex import glossary
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.iam import iam_util
@base.ReleaseTracks(base.ReleaseTrack.ALPHA, base.ReleaseTrack.GA)
@base.DefaultUniverseOnly
class RemoveIamPolicyBinding(base.Command):
"""Removes IAM policy binding from a Dataplex Glossary."""
detailed_help = {
'EXAMPLES': """\
To remove an IAM policy binding for the role `roles/dataplex.viewer`
for the user `test-user@gmail.com` from a glossary `test-glossary` within projet
`test-project` in location `us-central1`, run:
$ {command} test-glossary --project=test-project --location=us-central1 --role=roles/dataplex.viewer --member=user:test-user@gmail.com
See https://cloud.google.com/dataplex/docs/iam-roles for details of
policy role and member types.
""",
}
@staticmethod
def Args(parser):
resource_args.AddGlossaryResourceArg(
parser, 'to remove IAM policy binding from '
)
iam_util.AddArgsForRemoveIamPolicyBinding(parser)
@gcloud_exception.CatchHTTPErrorRaiseHTTPException(
'Status code: {status_code}. {status_message}.'
)
def Run(self, args):
glossary_ref = args.CONCEPTS.glossary.Parse()
result = glossary.GlossaryRemoveIamPolicyBinding(
glossary_ref, args.member, args.role
)
return result

View File

@@ -0,0 +1,54 @@
# -*- 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 glossaries set-iam-policy-binding` command."""
from googlecloudsdk.api_lib.dataplex import glossary
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.iam import iam_util
@base.ReleaseTracks(base.ReleaseTrack.ALPHA, base.ReleaseTrack.GA)
@base.DefaultUniverseOnly
class SetIamPolicy(base.Command):
"""Set an IAM policy binding for a Dataplex Glossary as defined in a JSON or YAML file.
See https://cloud.google.com/iam/docs/managing-policies for details of
the policy file format and contents.
"""
detailed_help = {
'EXAMPLES': """\
The following command will read an IAM policy defined in a JSON file
`policy.json` and set it for the Dataplex Glossary `test-glossary` within
project `test-project` in location `us-central1`:
$ {command} test-glossary --project=test-project --location=us-central1 policy.json
where policy.json is the relative path to the json file.
""",
}
@staticmethod
def Args(parser):
resource_args.AddGlossaryResourceArg(parser, 'to set IAM policy to.')
iam_util.AddArgForPolicyFile(parser)
@gcloud_exception.CatchHTTPErrorRaiseHTTPException(
'Status code: {status_code}. {status_message}.'
)
def Run(self, args):
glossary_ref = args.CONCEPTS.glossary.Parse()
return glossary.GlossarySetIamPolicyFromFile(
glossary_ref, args.policy_file
)

View File

@@ -0,0 +1,29 @@
# -*- coding: utf-8 -*- #
# Copyright 2024 Google LLC. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
"""Command group for Dataplex glossary term services."""
from googlecloudsdk.calliope import base
@base.ReleaseTracks(base.ReleaseTrack.ALPHA, base.ReleaseTrack.GA)
@base.DefaultUniverseOnly
class GlossaryCategories(base.Group):
"""Manage Dataplex glossary terms.
Glossary terms are the core of a Dataplex glossary. A glossary term holds a
rich text description that can be attached to entries or specific columns to
enrich them.
"""
category = base.DATA_ANALYTICS_CATEGORY

View File

@@ -0,0 +1,96 @@
# -*- 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 glossaries terms create` command."""
from googlecloudsdk.api_lib.dataplex import glossary
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.ReleaseTrack.GA)
@base.DefaultUniverseOnly
class Create(base.Command):
"""Creates a glossary term.
A glossary term holds a rich text description that can be attached to entries
or specific columns to enrich them.
"""
detailed_help = {
'EXAMPLES': """\
To create a glossary term `test-term` in glossary `test-glossary` in project `test-project` in
location `us-central1`, with description `test description`,
displayName `displayName` and parent `projects/test-project/locations/us-central1/glossaries/test-glossary/categories/test-category` , run:
$ {command} test-term --glossary=test-glossary
--location=us-central1 --project=test-project
--parent='projects/test-project/locations/us-central1/glossaries/test-glossary/categories/test-category'
--description='test description' --display-name='displayName'
""",
}
@staticmethod
def Args(parser):
resource_args.AddGlossaryTermResourceArg(parser, 'to create.')
parser.add_argument(
'--display-name',
required=False,
help='Display name of the glossary term.',
)
parser.add_argument(
'--description',
required=False,
help='Description of the glossary term.',
)
parser.add_argument(
'--parent',
required=True,
help='Immediate parent of the created glossary term.',
)
labels_util.AddCreateLabelsFlags(parser)
@gcloud_exception.CatchHTTPErrorRaiseHTTPException(
'Status code: {status_code}. {status_message}.'
)
def Run(self, args):
glossary_term_ref = args.CONCEPTS.glossary_term.Parse()
dataplex_client = dataplex_util.GetClientInstance()
create_response = dataplex_client.projects_locations_glossaries_terms.Create(
dataplex_util.GetMessageModule().DataplexProjectsLocationsGlossariesTermsCreateRequest(
termId=glossary_term_ref.Name(),
parent=glossary_term_ref.Parent().RelativeName(),
googleCloudDataplexV1GlossaryTerm=glossary.GenerateGlossaryTermForCreateRequest(
args
),
)
)
log.CreatedResource(
create_response.name,
details=(
'Glossary term created in project [{0}] in location [{1}] in'
' glossary [{2}]'.format(
glossary_term_ref.projectsId,
glossary_term_ref.locationsId,
glossary_term_ref.glossariesId,
)
),
)
return create_response

View File

@@ -0,0 +1,19 @@
- release_tracks: [ALPHA, GA]
help_text:
brief: |
Deletes a glossary term.
description: |
Deletes a glossary term.
examples: |
To delete the glossary term `test-term` in glossary `test-glossary` in project `test-project` in location `us-central1`, run:
$ {command} test-term --glossary=test-glossary --location=us-central1 --project=test-project
request:
ALPHA:
api_version: v1
collection: dataplex.projects.locations.glossaries.terms
arguments:
resource:
help_text: |
Arguments and flags that define the glossary term you want to delete.
spec: !REF googlecloudsdk.command_lib.dataplex.resources:glossary_term

View File

@@ -0,0 +1,20 @@
- release_tracks: [ALPHA, GA]
help_text:
brief: |
Describes a glossary term.
description: |
Describes a glossary term.
examples: |
To describe the glossary term `test-term` in glossary `test-glossary` in project `test-project` in loaction `us-central1`, run:
$ {command} test-term --glossary=test-glossary --location=us-central1 --project=test-project
request:
ALPHA:
api_version: v1
collection: dataplex.projects.locations.glossaries.terms
method: get
arguments:
resource:
help_text: |
Arguments and flags that define the glossary term you want to describe.
spec: !REF googlecloudsdk.command_lib.dataplex.resources:glossary_term

View File

@@ -0,0 +1,24 @@
- release_tracks: [ALPHA, GA]
help_text:
brief: |
List glossary terms.
description: |
List glossary terms.
examples: |
To list glossary terms in glossary `test-glossary` in project `test-project` in location `us-central1`, run :
$ {command} --glossary=test-glossary --location=us-central1 --project=test-project
request:
ALPHA:
api_version: v1
collection: dataplex.projects.locations.glossaries.terms
arguments:
resource:
help_text: |
Arguments and flags that define the glossary in which to list glossary terms.
spec: !REF googlecloudsdk.command_lib.dataplex.resources:glossary
response:
id_field: name

View File

@@ -0,0 +1,95 @@
# -*- 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 glossaries terms update` command."""
from googlecloudsdk.api_lib.dataplex import glossary
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.calliope import exceptions
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.ReleaseTrack.GA)
@base.DefaultUniverseOnly
class Update(base.Command):
"""Updates a glossary term."""
detailed_help = {
'EXAMPLES': """\
To update display name, desciption and labels of glossary term
`test-term` in glossary `test-glossary` in project `test-project`
in location `us-central1`, run:
$ {command} test-term --location=us-central1 --project=test-project
--glossary=test-glossary --description='updated description'
--display-name='updated displayName' --labels=key1=value1,key2=value2
To update parent of glossary term `test-term` in glossary
`test-glossary` in project `test-project` in location `us-central1`, run:
$ {command} test-term --location=us-central1 --project=test-project
--glossary=test-glossary --parent='projects/test-project/locations/us-central1/glossaries/updated-glossary'
""",
}
@staticmethod
def Args(parser):
resource_args.AddGlossaryTermResourceArg(parser, 'to update.')
parser.add_argument(
'--description',
required=False,
help='Description of the glossary term.',
)
parser.add_argument(
'--display-name',
required=False,
help='Display name of the glossary term.',
)
parser.add_argument(
'--parent',
required=False,
help='Immediate parent of the created glossary term.',
)
labels_util.AddCreateLabelsFlags(parser)
@gcloud_exception.CatchHTTPErrorRaiseHTTPException(
'Status code: {status_code}. {status_message}.'
)
def Run(self, args):
update_mask = glossary.GenerateTermUpdateMask(args)
if len(update_mask) < 1:
raise exceptions.HttpException(
'Update commands must specify at least one additional parameter to'
' change.'
)
glossary_term_ref = args.CONCEPTS.glossary_term.Parse()
dataplex_client = dataplex_util.GetClientInstance()
update_response = dataplex_client.projects_locations_glossaries_terms.Patch(
dataplex_util.GetMessageModule().DataplexProjectsLocationsGlossariesTermsPatchRequest(
name=glossary_term_ref.RelativeName(),
updateMask=','.join(update_mask),
googleCloudDataplexV1GlossaryTerm=glossary.GenerateGlossaryTermForUpdateRequest(
args
),
)
)
log.UpdatedResource(glossary_term_ref)
return update_response

View File

@@ -0,0 +1,102 @@
# -*- 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 glossaries update` command."""
from googlecloudsdk.api_lib.dataplex import glossary
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.calliope import exceptions
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.ReleaseTrack.GA)
@base.DefaultUniverseOnly
class Update(base.Command):
"""Updates a Dataplex Glossary."""
detailed_help = {
'EXAMPLES': """\
To update Glossary `test-glossary` in project `test-dataplex` at location `us-central1`,
with description `updated description` and displayName `displayName`
$ {command} test-glossary --location=us-central1 --project test-dataplex --description='updated description'
""",
}
@staticmethod
def Args(parser):
resource_args.AddGlossaryResourceArg(parser, 'to update.')
parser.add_argument(
'--description',
required=False,
help='Description of the Glossary.',
)
parser.add_argument(
'--display-name',
required=False,
help='Display Name of the Glossary.',
)
parser.add_argument(
'--etag',
required=False,
help='etag value for particular Glossary.',
)
async_group = parser.add_group(mutex=True, required=False)
async_group.add_argument(
'--validate-only',
action='store_true',
default=False,
help="Validate the update action, but don't actually perform it.",
)
base.ASYNC_FLAG.AddToParser(async_group)
labels_util.AddCreateLabelsFlags(parser)
@gcloud_exception.CatchHTTPErrorRaiseHTTPException(
'Status code: {status_code}. {status_message}.'
)
def Run(self, args):
update_mask = glossary.GenerateUpdateMask(args)
if len(update_mask) < 1:
raise exceptions.HttpException(
'Update commands must specify at least one additional parameter to'
' change.'
)
glossary_ref = args.CONCEPTS.glossary.Parse()
dataplex_client = dataplex_util.GetClientInstance()
update_req_op = dataplex_client.projects_locations_glossaries.Patch(
dataplex_util.GetMessageModule().DataplexProjectsLocationsGlossariesPatchRequest(
name=glossary_ref.RelativeName(),
validateOnly=args.validate_only,
updateMask=','.join(update_mask),
googleCloudDataplexV1Glossary=glossary.GenerateGlossaryForUpdateRequest(
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 = glossary.WaitForOperation(update_req_op)
log.UpdatedResource(glossary_ref, details='Operation was successful.')
return response
log.status.Print(
'Updating Glossary [{0}] with operation [{1}].'.format(
glossary_ref, update_req_op.name
)
)
return update_req_op