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,28 @@
# -*- coding: utf-8 -*- #
# Copyright 2022 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 Cloud SCC BigQuery Exports."""
from __future__ import absolute_import
from __future__ import division
from __future__ import unicode_literals
from googlecloudsdk.calliope import base
@base.ReleaseTracks(base.ReleaseTrack.GA)
class BigQueryExports(base.Group):
"""Manage Cloud SCC (Security Command Center) BigQuery exports."""
category = base.SECURITY_CATEGORY

View File

@@ -0,0 +1,155 @@
# -*- 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.
"""Command for creating a Cloud Security Command Center BigQuery export."""
from __future__ import absolute_import
from __future__ import division
from __future__ import print_function
from __future__ import unicode_literals
from googlecloudsdk.api_lib.scc import securitycenter_client
from googlecloudsdk.calliope import base
from googlecloudsdk.command_lib.scc import flags as scc_flags
from googlecloudsdk.command_lib.scc import util as scc_util
from googlecloudsdk.command_lib.scc.bqexports import bqexport_util
from googlecloudsdk.command_lib.scc.bqexports import flags as bqexports_flags
from googlecloudsdk.core import log
from googlecloudsdk.core import properties
@base.ReleaseTracks(base.ReleaseTrack.GA)
class Create(base.CreateCommand):
"""Create a Security Command Center BigQuery export."""
detailed_help = {
'DESCRIPTION': """\
Create a Security Command Center BigQuery export.
BigQuery exports that are created with Security Command Center API V2 and
later include a `location` attribute. If a location is not specified, the
default `global` location is used. For example, the following BigQuery
export name has `location=global` attribute:
`organizations/123/locations/global/bigQueryExports/test-bq-export`.
""",
'EXAMPLES': """\
To create a BigQuery export `test-bq-export` given organization `123` with a
dataset `abc` in project `234` and filter on category that equals to
`XSS_SCRIPTING`, run:
$ gcloud scc bqexports create test-bq-export \
--organization=123 \
--dataset=projects/234/datasets/abc \
--description="This is a test BigQuery export" \
--filter="category=\\"XSS_SCRIPTING\\""
To create a BigQuery export `test-bq-export` given folder `456` with a
dataset `abc` in project `234` and filter on category that equals to
`XSS_SCRIPTING`, run:
$ gcloud scc bqexports create test-bq-export --folder=456 \
--dataset=projects/234/datasets/abc \
--description="This is a test BigQuery export" \
--filter="category=\\"XSS_SCRIPTING\\""
To create a BigQuery export test-bq-export given project `789` with a
dataset `abc` in project `234` and filter on category that equals to
`XSS_SCRIPTING`, run:
$ gcloud scc bqexports create test-bq-export --project=789 \
--dataset=projects/234/datasets/abc \
--description="This is a test BigQuery export" \
--filter="category=\\"XSS_SCRIPTING\\""
To create a BigQuery export `test-bq-export` given organization `123` and
`location=global` to send findings with `category=XSS_SCRIPTING` to the
BigQuery dataset `abc` in project `234`, run:
$ gcloud scc bqexports create test-bq-export \
--organization=123 \
--dataset=projects/234/datasets/abc \
--description="This is a test BigQuery export" \
--filter="category=\\"XSS_SCRIPTING\\""
--location=global
""",
'API REFERENCE': """\
This command uses the Security Command Center API. For more information,
see [Security Command Center API.](https://cloud.google.com/security-command-center/docs/reference/rest)
""",
}
@staticmethod
def Args(parser):
bqexports_flags.DATASET_FLAG_REQUIRED.AddToParser(parser)
bqexports_flags.DESCRIPTION_FLAG.AddToParser(parser)
bqexports_flags.FILTER_FLAG.AddToParser(parser)
bqexports_flags.AddBigQueryPositionalArgument(parser)
bqexports_flags.AddParentGroup(parser)
parser.display_info.AddFormat(properties.VALUES.core.default_format.Get())
scc_flags.API_VERSION_FLAG.AddToParser(parser)
scc_flags.LOCATION_FLAG.AddToParser(parser)
def Run(self, args):
# Determine what version to call from --location and --api-version.
version = scc_util.GetVersionFromArguments(
args, args.BIG_QUERY_EXPORT, version_specific_existing_resource=True
)
messages = securitycenter_client.GetMessages(version)
client = securitycenter_client.GetClient(version)
# Set version-specific variables
if version == 'v1':
req = messages.SecuritycenterOrganizationsBigQueryExportsCreateRequest()
config_name = bqexport_util.ValidateAndGetBigQueryExportV1Name(args)
export = messages.GoogleCloudSecuritycenterV1BigQueryExport()
req.googleCloudSecuritycenterV1BigQueryExport = export
endpoint = client.organizations_bigQueryExports
else:
req = (
messages.SecuritycenterOrganizationsLocationsBigQueryExportsCreateRequest()
)
config_name = bqexport_util.ValidateAndGetBigQueryExportV2Name(args)
export = messages.GoogleCloudSecuritycenterV2BigQueryExport()
req.googleCloudSecuritycenterV2BigQueryExport = export
endpoint = client.organizations_locations_bigQueryExports
req.bigQueryExportId = _GetBigQueryExportIdFromFullResourceName(config_name)
req.parent = _GetParentFromFullResourceName(config_name)
export.dataset = args.dataset
export.description = args.description
export.filter = args.filter
# Set the args' filter to None to avoid downstream naming conflicts.
args.filter = None
bq_export_response = endpoint.Create(req)
log.status.Print('Created.')
return bq_export_response
def _GetBigQueryExportIdFromFullResourceName(config_name):
"""Gets BigQuery export id from the full resource name."""
bq_export_components = config_name.split('/')
return bq_export_components[len(bq_export_components) - 1]
def _GetParentFromFullResourceName(config_name):
"""Returns the parts of the BigQuery export name before "/bigQueryExports"."""
return '/'.join(config_name.split('/')[:-2])

View File

@@ -0,0 +1,115 @@
# -*- 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.
"""Command for deleting a Cloud Security Command Center BigQuery export."""
from __future__ import absolute_import
from __future__ import division
from __future__ import print_function
from __future__ import unicode_literals
from googlecloudsdk.api_lib.scc import securitycenter_client
from googlecloudsdk.calliope import base
from googlecloudsdk.command_lib.scc import flags as scc_flags
from googlecloudsdk.command_lib.scc import util as scc_util
from googlecloudsdk.command_lib.scc.bqexports import bqexport_util
from googlecloudsdk.command_lib.scc.bqexports import flags as bqexport_flags
from googlecloudsdk.core import log
from googlecloudsdk.core.console import console_io
@base.ReleaseTracks(base.ReleaseTrack.GA)
class Delete(base.DeleteCommand):
"""Delete a Security Command Center BigQuery export."""
detailed_help = {
'DESCRIPTION': """\
Delete a Security Command Center BigQuery export.
BigQuery exports that are created with Security Command Center API V2 and
later include a `location` attribute. If the `location` attribute is
included in the resource name of a BigQuery export, you must specify it
when referencing the export. For example, the following BigQuery export
name has `location=eu`:
`organizations/123/locations/eu/bigQueryExports/test-bq-export`.
""",
'EXAMPLES': """\
To delete a BigQuery export given organization `123` with id
`test-bq-export`, run:
$ gcloud scc bqexports delete test-bq-export \
--organization=123
To delete a BigQuery export given folder `456` with `id test-bq-export`,
run:
$ gcloud scc bqexports delete test-bq-export --folder=456
To delete a BigQuery export given project `789` with id `test-bq-export`,
run:
$ gcloud scc bqexports delete test-bq-export --project=789
To delete the BigQuery export `test-bq-export`, with `location=global`,
from organization `123`, run:
$ gcloud scc bqexports delete test-bq-export \
--organization=123 --location=global
""",
'API REFERENCE': """\
This command uses the Security Command Center API. For more information, see
[Security Command Center API.](https://cloud.google.com/security-command-center/docs/reference/rest)
""",
}
@staticmethod
def Args(parser):
bqexport_flags.AddBigQueryPositionalArgument(parser)
bqexport_flags.AddParentGroup(parser)
scc_flags.API_VERSION_FLAG.AddToParser(parser)
scc_flags.LOCATION_FLAG.AddToParser(parser)
def Run(self, args):
# Prompt user to confirm deletion.
console_io.PromptContinue(
message='Are you sure you want to delete a BigQuery export?\n',
cancel_on_no=True,
)
# Determine what version to call from --location and --api-version. The
# BigQuery export is a version_specific_existing_resource that may not be
# accessed through v2 if it currently exists in v1, and vice versa.
version = scc_util.GetVersionFromArguments(
args, args.BIG_QUERY_EXPORT, version_specific_existing_resource=True
)
messages = securitycenter_client.GetMessages(version)
client = securitycenter_client.GetClient(version)
if version == 'v1':
req = messages.SecuritycenterOrganizationsBigQueryExportsDeleteRequest()
req.name = bqexport_util.ValidateAndGetBigQueryExportV1Name(args)
empty_bq_response = client.organizations_bigQueryExports.Delete(req)
else:
req = (
messages.SecuritycenterOrganizationsLocationsBigQueryExportsDeleteRequest()
)
req.name = bqexport_util.ValidateAndGetBigQueryExportV2Name(args)
empty_bq_response = client.organizations_locations_bigQueryExports.Delete(
req
)
log.status.Print('Deleted.')
return empty_bq_response

View File

@@ -0,0 +1,108 @@
# -*- 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.
"""Command for getting a Cloud Security Command Center BigQuery export."""
from __future__ import absolute_import
from __future__ import division
from __future__ import print_function
from __future__ import unicode_literals
from googlecloudsdk.api_lib.scc import securitycenter_client
from googlecloudsdk.calliope import base
from googlecloudsdk.command_lib.scc import flags as scc_flags
from googlecloudsdk.command_lib.scc import util as scc_util
from googlecloudsdk.command_lib.scc.bqexports import bqexport_util
from googlecloudsdk.command_lib.scc.bqexports import flags as bqexports_flags
@base.ReleaseTracks(base.ReleaseTrack.GA)
class Get(base.DescribeCommand):
"""Get a Security Command Center BigQuery export."""
detailed_help = {
'DESCRIPTION': """\
Get a Security Command Center BigQuery export.
BigQuery exports that are created with Security Command Center API V2 and
later include a `location` attribute. If the `location` attribute is
included in the resource name of a BigQuery export, you must specify it
when referencing the export. For example, the following BigQuery export
name has `location=eu`:
`organizations/123/locations/eu/bigQueryExports/test-bq-export`.
""",
'EXAMPLES': """\
To get a BigQuery export under given organization `123` with id
`test-bq-export`,
run:
$ gcloud scc bqexports get test-bq-export \
--organization=123
To get a BigQuery export under given folder `456` with id `test-bq-export`,
run:
$ gcloud scc bqexports get test-bq-export --folder=456
To get a BigQuery export under given project `789` with id `test-bq-export,`
run:
$ gcloud scc bqexports get test-bq-export --project=789
To get a BigQuery export under given organization `123` with id
`test-bq-export`, and `location=global` run:
$ gcloud scc bqexports get test-bq-export \
--organization=123 \
--location=global
""",
'API REFERENCE': """\
This command uses the Security Command Center API. For more information,
see [Security Command Center API.](https://cloud.google.com/security-command-center/docs/reference/rest)
""",
}
@staticmethod
def Args(parser):
bqexports_flags.AddBigQueryPositionalArgument(parser)
bqexports_flags.AddParentGroup(parser)
scc_flags.API_VERSION_FLAG.AddToParser(parser)
scc_flags.LOCATION_FLAG.AddToParser(parser)
def Run(self, args):
# Determine what version to call from --location and --api-version. The
# BigQueryExport is a version_specific_existing_resource that may not be
# accessed through v2 if it currently exists in v1, and vice versa.
version = scc_util.GetVersionFromArguments(
args, args.BIG_QUERY_EXPORT, version_specific_existing_resource=True
)
messages = securitycenter_client.GetMessages(version)
client = securitycenter_client.GetClient(version)
if version == 'v1':
req = messages.SecuritycenterOrganizationsBigQueryExportsGetRequest()
req.name = bqexport_util.ValidateAndGetBigQueryExportV1Name(args)
bq_export_response = client.organizations_bigQueryExports.Get(req)
else:
req = (
messages.SecuritycenterOrganizationsLocationsBigQueryExportsGetRequest()
)
req.name = bqexport_util.ValidateAndGetBigQueryExportV2Name(args)
bq_export_response = client.organizations_locations_bigQueryExports.Get(
req
)
return bq_export_response

View File

@@ -0,0 +1,112 @@
# -*- 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.
"""Command for listing Cloud Security Command Center BigQuery exports."""
from __future__ import absolute_import
from __future__ import division
from __future__ import print_function
from __future__ import unicode_literals
from apitools.base.py import list_pager
from googlecloudsdk.api_lib.scc import securitycenter_client
from googlecloudsdk.calliope import base
from googlecloudsdk.command_lib.scc import flags as scc_flags
from googlecloudsdk.command_lib.scc import util as scc_util
from googlecloudsdk.command_lib.scc.bqexports import flags as bqexports_flags
@base.ReleaseTracks(base.ReleaseTrack.GA)
class List(base.ListCommand):
"""List Security Command Center BigQuery exports."""
detailed_help = {
'DESCRIPTION': """List Security Command Center BigQuery exports.
BigQuery exports that are created with Security Command Center API V2 and
later include a `location` attribute. Include the `--location` flag to
list BigQuery exports with `location` attribute other than `global`.
""",
'EXAMPLES': """\
List BigQuery exports under organization `123`:
$ gcloud scc bqexports list --organization=123
List BigQuery exports under folder `456`:
$ gcloud scc bqexports list --folder=456
List BigQuery exports under project `789`:
$ gcloud scc bqexports list --project=789
List BigQuery exports under organization `123` and location `global`:
$ gcloud scc bqexports list --organization=123 \
--location=global
List BigQuery exports under organization `123` and `location=eu`:
$ gcloud scc bqexports list --organization=123 \
--location=eu
""",
'API REFERENCE': """\
This command uses the Security Command Center API. For more information, see
[Security Command Center API.](https://cloud.google.com/security-command-center/docs/reference/rest)
""",
}
@staticmethod
def Args(parser):
# Remove URI flag.
base.URI_FLAG.RemoveFromParser(parser)
bqexports_flags.AddParentGroup(parser, required=True)
scc_flags.API_VERSION_FLAG.AddToParser(parser)
scc_flags.LOCATION_FLAG.AddToParser(parser)
def Run(self, args):
# Determine what version to call from --api-version.
version = scc_util.GetVersionFromArguments(
args, version_specific_existing_resource=True
)
messages = securitycenter_client.GetMessages(version)
client = securitycenter_client.GetClient(version)
if version == 'v1':
request = messages.SecuritycenterOrganizationsBigQueryExportsListRequest()
request.parent = scc_util.GetParentFromNamedArguments(args)
endpoint = client.organizations_bigQueryExports
else:
request = (
messages.SecuritycenterOrganizationsLocationsBigQueryExportsListRequest()
)
parent = scc_util.GetParentFromNamedArguments(args)
location = scc_util.ValidateAndGetLocation(args, 'v2')
request.parent = f'{parent}/locations/{location}'
endpoint = client.organizations_locations_bigQueryExports
request.pageSize = args.page_size
# Automatically handle pagination. All BigQuery exports are returned
# regardless of --page-size argument.
return list_pager.YieldFromList(
endpoint,
request,
batch_size_attribute='pageSize',
batch_size=args.page_size,
field='bigQueryExports',
)

View File

@@ -0,0 +1,160 @@
# -*- 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.
"""Command for updating a Cloud Security Command Center BigQuery export."""
from __future__ import absolute_import
from __future__ import division
from __future__ import print_function
from __future__ import unicode_literals
from googlecloudsdk.api_lib.scc import securitycenter_client
from googlecloudsdk.calliope import base
from googlecloudsdk.command_lib.scc import flags as scc_flags
from googlecloudsdk.command_lib.scc import util as scc_util
from googlecloudsdk.command_lib.scc.bqexports import bqexport_util
from googlecloudsdk.command_lib.scc.bqexports import flags as bqexport_flags
from googlecloudsdk.core import log
from googlecloudsdk.core import properties
@base.ReleaseTracks(base.ReleaseTrack.GA)
class Update(base.UpdateCommand):
"""Update a Security Command Center BigQuery export."""
detailed_help = {
'DESCRIPTION': """\
Update a Security Command Center BigQuery export.
BigQuery exports that are created with Security Command Center API V2 and
later include a `location` attribute. If the `location` attribute is
included in the resource name of a BigQuery export, you must specify it
when referencing the export. For example, the following BigQuery export
name has `location=eu`:
`organizations/123/locations/eu/bigQueryExports/test-bq-export`.
""",
'EXAMPLES': """\
Update a BigQuery export with id `test-bq-export` under organization `123`
with a dataset `abc` in project `234` and a filter on category that equals
to `XSS_SCRIPTING`:
$ gcloud scc bqexports update test-bq-export \
--organization=123 \
--dataset=projects/234/datasets/abc \
--description="This is a test BigQuery export" \
--filter="category=\\"XSS_SCRIPTING\\""
Update a BigQuery export with id `test-bq-export` under folder `456` with
a dataset `abc` in project `234` and a filter on category that equals to
`XSS_SCRIPTING`:
$ gcloud scc bqexports update test-bq-export --folder=456 \
--dataset=projects/234/datasets/abc \
--description="This is a test BigQuery export" \
--filter="category=\\"XSS_SCRIPTING\\""
Update a BigQuery export with id `test-bq-export` under project `789` with
a dataset `abc` in project `234` and a filter on category that equals to
`XSS_SCRIPTING`:
$ gcloud scc bqexports update test-bq-export \
--project=789 --dataset=projects/234/datasets/abc \
--description="This is a test BigQuery export" \
--filter="category=\\"XSS_SCRIPTING\\""
Update a BigQuery export `test-bq-export` in organization `123` and
`location=global`. This command updates the target dataset to
`projects/234/datasets/abc`, the export description to `This is a test
BigQuery export` and the export filter to `XSS_SCRIPTING`:
$ gcloud scc bqexports update test-bq-export \
--organization=123 \
--dataset=projects/234/datasets/abc \
--description="This is a test BigQuery export" \
--filter="category=\\"XSS_SCRIPTING\\"" \
--location=global
""",
'API REFERENCE': """\
This command uses the Security Command Center API. For more information,
see [Security Command Center API.](https://cloud.google.com/security-command-center/docs/reference/rest)
""",
}
@staticmethod
def Args(parser):
bqexport_flags.DATASET_FLAG_OPTIONAL.AddToParser(parser)
bqexport_flags.DESCRIPTION_FLAG.AddToParser(parser)
bqexport_flags.FILTER_FLAG.AddToParser(parser)
bqexport_flags.UPDATE_MASK_FLAG.AddToParser(parser)
bqexport_flags.AddBigQueryPositionalArgument(parser)
bqexport_flags.AddParentGroup(parser)
parser.display_info.AddFormat(properties.VALUES.core.default_format.Get())
scc_flags.API_VERSION_FLAG.AddToParser(parser)
scc_flags.LOCATION_FLAG.AddToParser(parser)
def Run(self, args):
# Determine what version to call from --location and --api-version. The
# BigQuery export is a version_specific_existing_resource that may not be
# accessed through v2 if it currently exists in v1, and vice versa.
version = scc_util.GetVersionFromArguments(
args, args.BIG_QUERY_EXPORT, version_specific_existing_resource=True
)
messages = securitycenter_client.GetMessages(version)
client = securitycenter_client.GetClient(version)
if version == 'v1':
req = messages.SecuritycenterOrganizationsBigQueryExportsPatchRequest()
req.name = bqexport_util.ValidateAndGetBigQueryExportV1Name(args)
export = messages.GoogleCloudSecuritycenterV1BigQueryExport()
req.googleCloudSecuritycenterV1BigQueryExport = export
endpoint = client.organizations_bigQueryExports
else:
req = (
messages.SecuritycenterOrganizationsLocationsBigQueryExportsPatchRequest()
)
req.name = bqexport_util.ValidateAndGetBigQueryExportV2Name(args)
export = messages.GoogleCloudSecuritycenterV2BigQueryExport()
req.googleCloudSecuritycenterV2BigQueryExport = export
endpoint = client.organizations_locations_bigQueryExports
computed_update_mask = []
if args.IsKnownAndSpecified('dataset'):
computed_update_mask.append('dataset')
export.dataset = args.dataset
if args.IsKnownAndSpecified('description'):
computed_update_mask.append('description')
export.description = args.description
if args.IsKnownAndSpecified('filter'):
computed_update_mask.append('filter')
export.filter = args.filter
# If the user supplies an update mask, use that regardless of the supplied
# fields.
if args.IsKnownAndSpecified('update_mask'):
req.updateMask = args.update_mask
else:
req.updateMask = ','.join(computed_update_mask)
# Set the args' filter to None to avoid downstream naming conflicts.
args.filter = None
bq_export_response = endpoint.Patch(req)
log.status.Print('Updated.')
return bq_export_response