Class SecurityCenterAsyncClient (1.16.1)

SecurityCenterAsyncClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Union[str, google.cloud.securitycenter_v1.services.security_center.transports.base.SecurityCenterTransport] = 'grpc_asyncio', client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

V1 APIs for Security Center service.

Inheritance

builtins.object > SecurityCenterAsyncClient

Properties

transport

Returns the transport used by the client instance.

Returns
TypeDescription
SecurityCenterTransportThe transport used by the client instance.

Methods

SecurityCenterAsyncClient

SecurityCenterAsyncClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Union[str, google.cloud.securitycenter_v1.services.security_center.transports.base.SecurityCenterTransport] = 'grpc_asyncio', client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

Instantiates the security center client.

Parameters
NameDescription
credentials Optional[google.auth.credentials.Credentials]

The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment.

transport Union[str, `.SecurityCenterTransport`]

The transport to use. If set to None, a transport is chosen automatically.

client_options ClientOptions

Custom options for the client. It won't take effect if a transport instance is provided. (1) The api_endpoint property can be used to override the default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT environment variable can also be used to override the endpoint: "always" (always use the default mTLS endpoint), "never" (always use the default regular endpoint) and "auto" (auto switch to the default mTLS endpoint if client certificate is present, this is the default value). However, the api_endpoint property takes precedence if provided. (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "true", then the client_cert_source property can be used to provide client certificate for mutual TLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is "false" or not set, no client certificate will be used.

Exceptions
TypeDescription
google.auth.exceptions.MutualTlsChannelErrorIf mutual TLS transport creation failed for any reason.

asset_path

asset_path(organization: str, asset: str)

Returns a fully-qualified asset string.

big_query_export_path

big_query_export_path(organization: str, export: str)

Returns a fully-qualified big_query_export string.

bulk_mute_findings

bulk_mute_findings(request: Optional[Union[google.cloud.securitycenter_v1.types.securitycenter_service.BulkMuteFindingsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Kicks off an LRO to bulk mute findings for a parent based on a filter. The parent can be either an organization, folder or project. The findings matched by the filter will be muted after the LRO is done.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import securitycenter_v1

async def sample_bulk_mute_findings():
    # Create a client
    client = securitycenter_v1.SecurityCenterAsyncClient()

    # Initialize request argument(s)
    request = securitycenter_v1.BulkMuteFindingsRequest(
        parent="parent_value",
    )

    # Make the request
    operation = client.bulk_mute_findings(request=request)

    print("Waiting for operation to complete...")

    response = await operation.result()

    # Handle the response
    print(response)
Parameters
NameDescription
request Union[google.cloud.securitycenter_v1.types.BulkMuteFindingsRequest, dict]

The request object. Request message for bulk findings update. Note: 1. If multiple bulk update requests match the same resource, the order in which they get executed is not defined. 2. Once a bulk operation is started, there is no way to stop it.

parent `str`

Required. The parent, at which bulk action needs to be applied. Its format is "organizations/[organization_id]", "folders/[folder_id]", "projects/[project_id]". This corresponds to the parent field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
google.api_core.operation_async.AsyncOperationAn object representing a long-running operation. The result type for the operation will be BulkMuteFindingsResponse The response to a BulkMute request. Contains the LRO information.

common_billing_account_path

common_billing_account_path(billing_account: str)

Returns a fully-qualified billing_account string.

common_folder_path

common_folder_path(folder: str)

Returns a fully-qualified folder string.

common_location_path

common_location_path(project: str, location: str)

Returns a fully-qualified location string.

common_organization_path

common_organization_path(organization: str)

Returns a fully-qualified organization string.

common_project_path

common_project_path(project: str)

Returns a fully-qualified project string.

create_big_query_export

create_big_query_export(request: Optional[Union[google.cloud.securitycenter_v1.types.securitycenter_service.CreateBigQueryExportRequest, dict]] = None, *, parent: Optional[str] = None, big_query_export: Optional[google.cloud.securitycenter_v1.types.bigquery_export.BigQueryExport] = None, big_query_export_id: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Creates a big query export.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import securitycenter_v1

async def sample_create_big_query_export():
    # Create a client
    client = securitycenter_v1.SecurityCenterAsyncClient()

    # Initialize request argument(s)
    request = securitycenter_v1.CreateBigQueryExportRequest(
        parent="parent_value",
        big_query_export_id="big_query_export_id_value",
    )

    # Make the request
    response = await client.create_big_query_export(request=request)

    # Handle the response
    print(response)
Parameters
NameDescription
request Union[google.cloud.securitycenter_v1.types.CreateBigQueryExportRequest, dict]

The request object. Request message for creating a big query export.

parent `str`

Required. Resource name of the new big query export's parent. Its format is "organizations/[organization_id]", "folders/[folder_id]", or "projects/[project_id]". This corresponds to the parent field on the request instance; if request is provided, this should not be set.

big_query_export BigQueryExport

Required. The big query export being created. This corresponds to the big_query_export field on the request instance; if request is provided, this should not be set.

big_query_export_id `str`

Required. Unique identifier provided by the client within the parent scope. It must consist of lower case letters, numbers, and hyphen, with the first character a letter, the last a letter or a number, and a 63 character maximum. This corresponds to the big_query_export_id field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
google.cloud.securitycenter_v1.types.BigQueryExportConfigures how to deliver Findings to BigQuery Instance.

create_finding

create_finding(request: Optional[Union[google.cloud.securitycenter_v1.types.securitycenter_service.CreateFindingRequest, dict]] = None, *, parent: Optional[str] = None, finding_id: Optional[str] = None, finding: Optional[google.cloud.securitycenter_v1.types.finding.Finding] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Creates a finding. The corresponding source must exist for finding creation to succeed.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import securitycenter_v1

async def sample_create_finding():
    # Create a client
    client = securitycenter_v1.SecurityCenterAsyncClient()

    # Initialize request argument(s)
    request = securitycenter_v1.CreateFindingRequest(
        parent="parent_value",
        finding_id="finding_id_value",
    )

    # Make the request
    response = await client.create_finding(request=request)

    # Handle the response
    print(response)
Parameters
NameDescription
request Union[google.cloud.securitycenter_v1.types.CreateFindingRequest, dict]

The request object. Request message for creating a finding.

parent `str`

Required. Resource name of the new finding's parent. Its format should be "organizations/[organization_id]/sources/[source_id]". This corresponds to the parent field on the request instance; if request is provided, this should not be set.

finding_id `str`

Required. Unique identifier provided by the client within the parent scope. It must be alphanumeric and less than or equal to 32 characters and greater than 0 characters in length. This corresponds to the finding_id field on the request instance; if request is provided, this should not be set.

finding Finding

Required. The Finding being created. The name and security_marks will be ignored as they are both output only fields on this resource. This corresponds to the finding field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
google.cloud.securitycenter_v1.types.FindingSecurity Command Center finding. A finding is a record of assessment data like security, risk, health, or privacy, that is ingested into Security Command Center for presentation, notification, analysis, policy testing, and enforcement. For example, a cross-site scripting (XSS) vulnerability in an App Engine application is a finding.

create_mute_config

create_mute_config(request: Optional[Union[google.cloud.securitycenter_v1.types.securitycenter_service.CreateMuteConfigRequest, dict]] = None, *, parent: Optional[str] = None, mute_config: Optional[google.cloud.securitycenter_v1.types.mute_config.MuteConfig] = None, mute_config_id: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Creates a mute config.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import securitycenter_v1

async def sample_create_mute_config():
    # Create a client
    client = securitycenter_v1.SecurityCenterAsyncClient()

    # Initialize request argument(s)
    mute_config = securitycenter_v1.MuteConfig()
    mute_config.filter = "filter_value"

    request = securitycenter_v1.CreateMuteConfigRequest(
        parent="parent_value",
        mute_config=mute_config,
        mute_config_id="mute_config_id_value",
    )

    # Make the request
    response = await client.create_mute_config(request=request)

    # Handle the response
    print(response)
Parameters
NameDescription
request Union[google.cloud.securitycenter_v1.types.CreateMuteConfigRequest, dict]

The request object. Request message for creating a mute config.

parent `str`

Required. Resource name of the new mute configs's parent. Its format is "organizations/[organization_id]", "folders/[folder_id]", or "projects/[project_id]". This corresponds to the parent field on the request instance; if request is provided, this should not be set.

mute_config MuteConfig

Required. The mute config being created. This corresponds to the mute_config field on the request instance; if request is provided, this should not be set.

mute_config_id `str`

Required. Unique identifier provided by the client within the parent scope. It must consist of lower case letters, numbers, and hyphen, with the first character a letter, the last a letter or a number, and a 63 character maximum. This corresponds to the mute_config_id field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
google.cloud.securitycenter_v1.types.MuteConfigA mute config is a Cloud SCC resource that contains the configuration to mute create/update events of findings.

create_notification_config

create_notification_config(request: Optional[Union[google.cloud.securitycenter_v1.types.securitycenter_service.CreateNotificationConfigRequest, dict]] = None, *, parent: Optional[str] = None, config_id: Optional[str] = None, notification_config: Optional[google.cloud.securitycenter_v1.types.notification_config.NotificationConfig] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Creates a notification config.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import securitycenter_v1

async def sample_create_notification_config():
    # Create a client
    client = securitycenter_v1.SecurityCenterAsyncClient()

    # Initialize request argument(s)
    request = securitycenter_v1.CreateNotificationConfigRequest(
        parent="parent_value",
        config_id="config_id_value",
    )

    # Make the request
    response = await client.create_notification_config(request=request)

    # Handle the response
    print(response)
Parameters
NameDescription
request Union[google.cloud.securitycenter_v1.types.CreateNotificationConfigRequest, dict]

The request object. Request message for creating a notification config.

parent `str`

Required. Resource name of the new notification config's parent. Its format is "organizations/[organization_id]". This corresponds to the parent field on the request instance; if request is provided, this should not be set.

config_id `str`

Required. Unique identifier provided by the client within the parent scope. It must be between 1 and 128 characters, and contains alphanumeric characters, underscores or hyphens only. This corresponds to the config_id field on the request instance; if request is provided, this should not be set.

notification_config NotificationConfig

Required. The notification config being created. The name and the service account will be ignored as they are both output only fields on this resource. This corresponds to the notification_config field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
google.cloud.securitycenter_v1.types.NotificationConfigCloud Security Command Center (Cloud SCC) notification configs. A notification config is a Cloud SCC resource that contains the configuration to send notifications for create/update events of findings, assets and etc.

create_source

create_source(request: Optional[Union[google.cloud.securitycenter_v1.types.securitycenter_service.CreateSourceRequest, dict]] = None, *, parent: Optional[str] = None, source: Optional[google.cloud.securitycenter_v1.types.source.Source] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Creates a source.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import securitycenter_v1

async def sample_create_source():
    # Create a client
    client = securitycenter_v1.SecurityCenterAsyncClient()

    # Initialize request argument(s)
    request = securitycenter_v1.CreateSourceRequest(
        parent="parent_value",
    )

    # Make the request
    response = await client.create_source(request=request)

    # Handle the response
    print(response)
Parameters
NameDescription
request Union[google.cloud.securitycenter_v1.types.CreateSourceRequest, dict]

The request object. Request message for creating a source.

parent `str`

Required. Resource name of the new source's parent. Its format should be "organizations/[organization_id]". This corresponds to the parent field on the request instance; if request is provided, this should not be set.

source Source

Required. The Source being created, only the display_name and description will be used. All other fields will be ignored. This corresponds to the source field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
google.cloud.securitycenter_v1.types.SourceSecurity Command Center finding source. A finding source is an entity or a mechanism that can produce a finding. A source is like a container of findings that come from the same scanner, logger, monitor, and other tools.

delete_big_query_export

delete_big_query_export(request: Optional[Union[google.cloud.securitycenter_v1.types.securitycenter_service.DeleteBigQueryExportRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Deletes an existing big query export.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import securitycenter_v1

async def sample_delete_big_query_export():
    # Create a client
    client = securitycenter_v1.SecurityCenterAsyncClient()

    # Initialize request argument(s)
    request = securitycenter_v1.DeleteBigQueryExportRequest(
        name="name_value",
    )

    # Make the request
    await client.delete_big_query_export(request=request)
Parameters
NameDescription
request Union[google.cloud.securitycenter_v1.types.DeleteBigQueryExportRequest, dict]

The request object. Request message for deleting a big query export.

name `str`

Required. Name of the big query export to delete. Its format is organizations/{organization}/bigQueryExports/{export_id}, folders/{folder}/bigQueryExports/{export_id}, or projects/{project}/bigQueryExports/{export_id} This corresponds to the name field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

delete_mute_config

delete_mute_config(request: Optional[Union[google.cloud.securitycenter_v1.types.securitycenter_service.DeleteMuteConfigRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Deletes an existing mute config.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import securitycenter_v1

async def sample_delete_mute_config():
    # Create a client
    client = securitycenter_v1.SecurityCenterAsyncClient()

    # Initialize request argument(s)
    request = securitycenter_v1.DeleteMuteConfigRequest(
        name="name_value",
    )

    # Make the request
    await client.delete_mute_config(request=request)
Parameters
NameDescription
request Union[google.cloud.securitycenter_v1.types.DeleteMuteConfigRequest, dict]

The request object. Request message for deleting a mute config.

name `str`

Required. Name of the mute config to delete. Its format is organizations/{organization}/muteConfigs/{config_id}, folders/{folder}/muteConfigs/{config_id}, or projects/{project}/muteConfigs/{config_id} This corresponds to the name field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

delete_notification_config

delete_notification_config(request: Optional[Union[google.cloud.securitycenter_v1.types.securitycenter_service.DeleteNotificationConfigRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Deletes a notification config.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import securitycenter_v1

async def sample_delete_notification_config():
    # Create a client
    client = securitycenter_v1.SecurityCenterAsyncClient()

    # Initialize request argument(s)
    request = securitycenter_v1.DeleteNotificationConfigRequest(
        name="name_value",
    )

    # Make the request
    await client.delete_notification_config(request=request)
Parameters
NameDescription
request Union[google.cloud.securitycenter_v1.types.DeleteNotificationConfigRequest, dict]

The request object. Request message for deleting a notification config.

name `str`

Required. Name of the notification config to delete. Its format is "organizations/[organization_id]/notificationConfigs/[config_id]". This corresponds to the name field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

external_system_path

external_system_path(
    organization: str, source: str, finding: str, externalsystem: str
)

Returns a fully-qualified external_system string.

finding_path

finding_path(organization: str, source: str, finding: str)

Returns a fully-qualified finding string.

from_service_account_file

from_service_account_file(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

Parameter
NameDescription
filename str

The path to the service account private key json file.

Returns
TypeDescription
SecurityCenterAsyncClientThe constructed client.

from_service_account_info

from_service_account_info(info: dict, *args, **kwargs)

Creates an instance of this client using the provided credentials info.

Parameter
NameDescription
info dict

The service account private key info.

Returns
TypeDescription
SecurityCenterAsyncClientThe constructed client.

from_service_account_json

from_service_account_json(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

Parameter
NameDescription
filename str

The path to the service account private key json file.

Returns
TypeDescription
SecurityCenterAsyncClientThe constructed client.

get_big_query_export

get_big_query_export(request: Optional[Union[google.cloud.securitycenter_v1.types.securitycenter_service.GetBigQueryExportRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Gets a big query export.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import securitycenter_v1

async def sample_get_big_query_export():
    # Create a client
    client = securitycenter_v1.SecurityCenterAsyncClient()

    # Initialize request argument(s)
    request = securitycenter_v1.GetBigQueryExportRequest(
        name="name_value",
    )

    # Make the request
    response = await client.get_big_query_export(request=request)

    # Handle the response
    print(response)
Parameters
NameDescription
request Union[google.cloud.securitycenter_v1.types.GetBigQueryExportRequest, dict]

The request object. Request message for retrieving a big query export.

name `str`

Required. Name of the big query export to retrieve. Its format is organizations/{organization}/bigQueryExports/{export_id}, folders/{folder}/bigQueryExports/{export_id}, or projects/{project}/bigQueryExports/{export_id} This corresponds to the name field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
google.cloud.securitycenter_v1.types.BigQueryExportConfigures how to deliver Findings to BigQuery Instance.

get_iam_policy

get_iam_policy(request: Optional[Union[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest, dict]] = None, *, resource: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Gets the access control policy on the specified Source.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import securitycenter_v1
from google.iam.v1 import iam_policy_pb2  # type: ignore

async def sample_get_iam_policy():
    # Create a client
    client = securitycenter_v1.SecurityCenterAsyncClient()

    # Initialize request argument(s)
    request = iam_policy_pb2.GetIamPolicyRequest(
        resource="resource_value",
    )

    # Make the request
    response = await client.get_iam_policy(request=request)

    # Handle the response
    print(response)
Parameters
NameDescription
request Union[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest, dict]

The request object. Request message for GetIamPolicy method.

resource `str`

REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. This corresponds to the resource field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
google.iam.v1.policy_pb2.PolicyAn Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A Policy is a collection of bindings. A binding binds one or more members, or principals, to a single role. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions; each role can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a binding can also specify a condition, which is a logical expression that allows access to a resource only if the expression evaluates to true. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](\ https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01t00:00:00.000z')",="" }="" }="" ],="" "etag":="" "bwwwja0yfja=", " version":="" 3="" }="" **yaml="" example:**="" bindings:="" -="" members:="" -="" user:\="" mike@example.com="" -="" group:\="" admins@example.com="" -="" domain:google.com="" -="" serviceaccount:\="" my-project-id@appspot.gserviceaccount.com="" role:="" roles/resourcemanager.organizationadmin="" -="" members:="" -="" user:\="" eve@example.com="" role:="" roles/resourcemanager.organizationviewer="" condition:="" title:="" expirable="" access="" description:="" does="" not="" grant="" access="" after="" sep="" 2020="" expression:="" request.time="">< timestamp('2020-10-01t00:00:00.000z')="" etag:="" bwwwja0yfja="version:" 3="" for="" a="" description="" of="" iam="" and="" its="" features,="" see="" the="" [iam="" documentation](\="">

get_mtls_endpoint_and_cert_source

get_mtls_endpoint_and_cert_source(
    client_options: Optional[google.api_core.client_options.ClientOptions] = None,
)

Return the API endpoint and client cert source for mutual TLS.

The client cert source is determined in the following order: (1) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is not "true", the client cert source is None. (2) if client_options.client_cert_source is provided, use the provided one; if the default client cert source exists, use the default one; otherwise the client cert source is None.

The API endpoint is determined in the following order: (1) if client_options.api_endpoint if provided, use the provided one. (2) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "always", use the default mTLS endpoint; if the environment variabel is "never", use the default API endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise use the default API endpoint.

More details can be found at https://google.aip.dev/auth/4114.

Parameter
NameDescription
client_options google.api_core.client_options.ClientOptions

Custom options for the client. Only the api_endpoint and client_cert_source properties may be used in this method.

Exceptions
TypeDescription
google.auth.exceptions.MutualTLSChannelErrorIf any errors happen.
Returns
TypeDescription
Tuple[str, Callable[[], Tuple[bytes, bytes]]]returns the API endpoint and the client cert source to use.

get_mute_config

get_mute_config(request: Optional[Union[google.cloud.securitycenter_v1.types.securitycenter_service.GetMuteConfigRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Gets a mute config.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import securitycenter_v1

async def sample_get_mute_config():
    # Create a client
    client = securitycenter_v1.SecurityCenterAsyncClient()

    # Initialize request argument(s)
    request = securitycenter_v1.GetMuteConfigRequest(
        name="name_value",
    )

    # Make the request
    response = await client.get_mute_config(request=request)

    # Handle the response
    print(response)
Parameters
NameDescription
request Union[google.cloud.securitycenter_v1.types.GetMuteConfigRequest, dict]

The request object. Request message for retrieving a mute config.

name `str`

Required. Name of the mute config to retrieve. Its format is organizations/{organization}/muteConfigs/{config_id}, folders/{folder}/muteConfigs/{config_id}, or projects/{project}/muteConfigs/{config_id} This corresponds to the name field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
google.cloud.securitycenter_v1.types.MuteConfigA mute config is a Cloud SCC resource that contains the configuration to mute create/update events of findings.

get_notification_config

get_notification_config(request: Optional[Union[google.cloud.securitycenter_v1.types.securitycenter_service.GetNotificationConfigRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Gets a notification config.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import securitycenter_v1

async def sample_get_notification_config():
    # Create a client
    client = securitycenter_v1.SecurityCenterAsyncClient()

    # Initialize request argument(s)
    request = securitycenter_v1.GetNotificationConfigRequest(
        name="name_value",
    )

    # Make the request
    response = await client.get_notification_config(request=request)

    # Handle the response
    print(response)
Parameters
NameDescription
request Union[google.cloud.securitycenter_v1.types.GetNotificationConfigRequest, dict]

The request object. Request message for getting a notification config.

name `str`

Required. Name of the notification config to get. Its format is "organizations/[organization_id]/notificationConfigs/[config_id]". This corresponds to the name field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
google.cloud.securitycenter_v1.types.NotificationConfigCloud Security Command Center (Cloud SCC) notification configs. A notification config is a Cloud SCC resource that contains the configuration to send notifications for create/update events of findings, assets and etc.

get_organization_settings

get_organization_settings(request: Optional[Union[google.cloud.securitycenter_v1.types.securitycenter_service.GetOrganizationSettingsRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Gets the settings for an organization.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import securitycenter_v1

async def sample_get_organization_settings():
    # Create a client
    client = securitycenter_v1.SecurityCenterAsyncClient()

    # Initialize request argument(s)
    request = securitycenter_v1.GetOrganizationSettingsRequest(
        name="name_value",
    )

    # Make the request
    response = await client.get_organization_settings(request=request)

    # Handle the response
    print(response)
Parameters
NameDescription
request Union[google.cloud.securitycenter_v1.types.GetOrganizationSettingsRequest, dict]

The request object. Request message for getting organization settings.

name `str`

Required. Name of the organization to get organization settings for. Its format is "organizations/[organization_id]/organizationSettings". This corresponds to the name field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
google.cloud.securitycenter_v1.types.OrganizationSettingsUser specified settings that are attached to the Security Command Center organization.

get_source

get_source(request: Optional[Union[google.cloud.securitycenter_v1.types.securitycenter_service.GetSourceRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Gets a source.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import securitycenter_v1

async def sample_get_source():
    # Create a client
    client = securitycenter_v1.SecurityCenterAsyncClient()

    # Initialize request argument(s)
    request = securitycenter_v1.GetSourceRequest(
        name="name_value",
    )

    # Make the request
    response = await client.get_source(request=request)

    # Handle the response
    print(response)
Parameters
NameDescription
request Union[google.cloud.securitycenter_v1.types.GetSourceRequest, dict]

The request object. Request message for getting a source.

name `str`

Required. Relative resource name of the source. Its format is "organizations/[organization_id]/source/[source_id]". This corresponds to the name field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
google.cloud.securitycenter_v1.types.SourceSecurity Command Center finding source. A finding source is an entity or a mechanism that can produce a finding. A source is like a container of findings that come from the same scanner, logger, monitor, and other tools.

get_transport_class

get_transport_class()

Returns an appropriate transport class.

group_assets

group_assets(request: Optional[Union[google.cloud.securitycenter_v1.types.securitycenter_service.GroupAssetsRequest, dict]] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Filters an organization's assets and groups them by their specified properties.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import securitycenter_v1

async def sample_group_assets():
    # Create a client
    client = securitycenter_v1.SecurityCenterAsyncClient()

    # Initialize request argument(s)
    request = securitycenter_v1.GroupAssetsRequest(
        parent="parent_value",
        group_by="group_by_value",
    )

    # Make the request
    page_result = client.group_assets(request=request)

    # Handle the response
    async for response in page_result:
        print(response)
Parameters
NameDescription
request Union[google.cloud.securitycenter_v1.types.GroupAssetsRequest, dict]

The request object. Request message for grouping by assets.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
google.cloud.securitycenter_v1.services.security_center.pagers.GroupAssetsAsyncPagerResponse message for grouping by assets. Iterating over this object will yield results and resolve additional pages automatically.

group_findings

group_findings(request: Optional[Union[google.cloud.securitycenter_v1.types.securitycenter_service.GroupFindingsRequest, dict]] = None, *, parent: Optional[str] = None, group_by: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Filters an organization or source's findings and groups them by their specified properties.

To group across all sources provide a - as the source id. Example: /v1/organizations/{organization_id}/sources/-/findings, /v1/folders/{folder_id}/sources/-/findings, /v1/projects/{project_id}/sources/-/findings

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import securitycenter_v1

async def sample_group_findings():
    # Create a client
    client = securitycenter_v1.SecurityCenterAsyncClient()

    # Initialize request argument(s)
    request = securitycenter_v1.GroupFindingsRequest(
        parent="parent_value",
        group_by="group_by_value",
    )

    # Make the request
    page_result = client.group_findings(request=request)

    # Handle the response
    async for response in page_result:
        print(response)
Parameters
NameDescription
request Union[google.cloud.securitycenter_v1.types.GroupFindingsRequest, dict]

The request object. Request message for grouping by findings.

parent `str`

Required. Name of the source to groupBy. Its format is "organizations/[organization_id]/sources/[source_id]", folders/[folder_id]/sources/[source_id], or projects/[project_id]/sources/[source_id]. To groupBy across all sources provide a source_id of -. For example: organizations/{organization_id}/sources/-, folders/{folder_id}/sources/-, or projects/{project_id}/sources/- This corresponds to the parent field on the request instance; if request is provided, this should not be set.

group_by `str`

Required. Expression that defines what assets fields to use for grouping (including state_change). The string value should follow SQL syntax: comma separated list of fields. For example: "parent,resource_name". The following fields are supported: - resource_name - category - state - parent - severity The following fields are supported when compare_duration is set: - state_change This corresponds to the group_by field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
google.cloud.securitycenter_v1.services.secur