SecurityCenter¶
- class google.cloud.securitycenter_v2.services.security_center.SecurityCenterAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.securitycenter_v2.services.security_center.transports.base.SecurityCenterTransport, typing.Callable[[...], google.cloud.securitycenter_v2.services.security_center.transports.base.SecurityCenterTransport]]] = 'grpc_asyncio', client_options: typing.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>)[source]¶
V2 APIs for Security Center service.
Instantiates the security center async client.
- Parameters
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 (Optional[Union[str,SecurityCenterTransport,Callable[..., SecurityCenterTransport]]]) – The transport to use, or a Callable that constructs and returns a new transport to use. If a Callable is given, it will be called with the same set of initialization arguments as used in the SecurityCenterTransport constructor. If set to None, a transport is chosen automatically.
client_options (Optional[Union[google.api_core.client_options.ClientOptions, dict]]) –
Custom options for the client.
1. The
api_endpoint
property can be used to override the default endpoint provided by the client whentransport
is not explicitly provided. Only if this property is not set andtransport
was not explicitly provided, the endpoint is determined by the GOOGLE_API_USE_MTLS_ENDPOINT environment variable, which have one of the following values: “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).2. If the GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “true”, then the
client_cert_source
property can be used to provide a client certificate for mTLS 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.3. The
universe_domain
property can be used to override the default “googleapis.com” universe. Note thatapi_endpoint
property still takes precedence; anduniverse_domain
is currently not supported for mTLS.client_info (google.api_core.gapic_v1.client_info.ClientInfo) – The client info used to send a user-agent string along with API requests. If
None
, then default info will be used. Generally, you only need to set this if you’re developing your own client library.
- Raises
google.auth.exceptions.MutualTlsChannelError – If mutual TLS transport creation failed for any reason.
- property api_endpoint¶
Return the API endpoint used by the client instance.
- Returns
The API endpoint used by the client instance.
- Return type
- static attack_path_path(organization: str, simulation: str, valued_resource: str, attack_path: str) str ¶
Returns a fully-qualified attack_path string.
- async batch_create_resource_value_configs(request: Optional[Union[google.cloud.securitycenter_v2.types.securitycenter_service.BatchCreateResourceValueConfigsRequest, dict]] = None, *, parent: Optional[str] = None, requests: Optional[MutableSequence[google.cloud.securitycenter_v2.types.securitycenter_service.CreateResourceValueConfigRequest]] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.securitycenter_v2.types.securitycenter_service.BatchCreateResourceValueConfigsResponse [source]¶
Creates a ResourceValueConfig for an organization. Maps user’s tags to difference resource values for use by the attack path simulation.
# 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_v2 async def sample_batch_create_resource_value_configs(): # Create a client client = securitycenter_v2.SecurityCenterAsyncClient() # Initialize request argument(s) requests = securitycenter_v2.CreateResourceValueConfigRequest() requests.parent = "parent_value" request = securitycenter_v2.BatchCreateResourceValueConfigsRequest( parent="parent_value", requests=requests, ) # Make the request response = await client.batch_create_resource_value_configs(request=request) # Handle the response print(response)
- Parameters
request (Optional[Union[google.cloud.securitycenter_v2.types.BatchCreateResourceValueConfigsRequest, dict]]) – The request object. Request message to create multiple resource value configs
parent (
str
) –Required. Resource name of the new ResourceValueConfig’s parent. The parent field in the CreateResourceValueConfigRequest messages must either be empty or match this field.
This corresponds to the
parent
field on therequest
instance; ifrequest
is provided, this should not be set.requests (
MutableSequence[google.cloud.securitycenter_v2.types.CreateResourceValueConfigRequest]
) –Required. The resource value configs to be created.
This corresponds to the
requests
field on therequest
instance; ifrequest
is provided, this should not be set.retry (google.api_core.retry_async.AsyncRetry) – 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
Response message for BatchCreateResourceValueConfigs
- Return type
google.cloud.securitycenter_v2.types.BatchCreateResourceValueConfigsResponse
- static big_query_export_path(organization: str, location: str, export: str) str ¶
Returns a fully-qualified big_query_export string.
- async bulk_mute_findings(request: Optional[Union[google.cloud.securitycenter_v2.types.securitycenter_service.BulkMuteFindingsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.api_core.operation_async.AsyncOperation [source]¶
Kicks off an LRO to bulk mute findings for a parent based on a filter. If no location is specified, findings are muted in global. 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_v2 async def sample_bulk_mute_findings(): # Create a client client = securitycenter_v2.SecurityCenterAsyncClient() # Initialize request argument(s) request = securitycenter_v2.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
request (Optional[Union[google.cloud.securitycenter_v2.types.BulkMuteFindingsRequest, dict]]) –
The request object. Request message for bulk findings update. Note:
- If multiple bulk update requests
match the same resource, the order in which they get executed is not defined.
- 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. If no location is specified, findings are updated in global. The following list shows some examples:
organizations/[organization_id]
organizations/[organization_id]/locations/[location_id]
folders/[folder_id]
folders/[folder_id]/locations/[location_id]
projects/[project_id]
projects/[project_id]/locations/[location_id]
This corresponds to the
parent
field on therequest
instance; ifrequest
is provided, this should not be set.retry (google.api_core.retry_async.AsyncRetry) – 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
An object representing a long-running operation.
The result type for the operation will be
google.cloud.securitycenter_v2.types.BulkMuteFindingsResponse
The response to a BulkMute request. Contains the LRO information.- Return type
- async cancel_operation(request: Optional[google.longrunning.operations_pb2.CancelOperationRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) None [source]¶
Starts asynchronous cancellation on a long-running operation.
The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn’t support this method, it returns google.rpc.Code.UNIMPLEMENTED.
- Parameters
request (
CancelOperationRequest
) – The request object. Request message for CancelOperation method.retry (google.api_core.retry_async.AsyncRetry) – 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
None
- static common_billing_account_path(billing_account: str) str ¶
Returns a fully-qualified billing_account string.
- static common_location_path(project: str, location: str) str ¶
Returns a fully-qualified location string.
- static common_organization_path(organization: str) str ¶
Returns a fully-qualified organization string.
- async create_big_query_export(request: Optional[Union[google.cloud.securitycenter_v2.types.securitycenter_service.CreateBigQueryExportRequest, dict]] = None, *, parent: Optional[str] = None, big_query_export: Optional[google.cloud.securitycenter_v2.types.bigquery_export.BigQueryExport] = None, big_query_export_id: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.securitycenter_v2.types.bigquery_export.BigQueryExport [source]¶
Creates a BigQuery 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_v2 async def sample_create_big_query_export(): # Create a client client = securitycenter_v2.SecurityCenterAsyncClient() # Initialize request argument(s) request = securitycenter_v2.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
request (Optional[Union[google.cloud.securitycenter_v2.types.CreateBigQueryExportRequest, dict]]) – The request object. Request message for creating a BigQuery export.
parent (
str
) –Required. The name of the parent resource of the new BigQuery export. Its format is
organizations/[organization_id]/locations/[location_id]
,folders/[folder_id]/locations/[location_id]
, orprojects/[project_id]/locations/[location_id]
.This corresponds to the
parent
field on therequest
instance; ifrequest
is provided, this should not be set.big_query_export (
google.cloud.securitycenter_v2.types.BigQueryExport
) –Required. The BigQuery export being created.
This corresponds to the
big_query_export
field on therequest
instance; ifrequest
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 only lowercase letters, numbers, and hyphens, must start with a letter, must end with either a letter or a number, and must be 63 characters or less.
This corresponds to the
big_query_export_id
field on therequest
instance; ifrequest
is provided, this should not be set.retry (google.api_core.retry_async.AsyncRetry) – 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
Configures how to deliver Findings to BigQuery Instance.
- Return type
- async create_finding(request: Optional[Union[google.cloud.securitycenter_v2.types.securitycenter_service.CreateFindingRequest, dict]] = None, *, parent: Optional[str] = None, finding: Optional[google.cloud.securitycenter_v2.types.finding.Finding] = None, finding_id: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.securitycenter_v2.types.finding.Finding [source]¶
Creates a finding in a location. 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_v2 async def sample_create_finding(): # Create a client client = securitycenter_v2.SecurityCenterAsyncClient() # Initialize request argument(s) request = securitycenter_v2.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
request (Optional[Union[google.cloud.securitycenter_v2.types.CreateFindingRequest, dict]]) – The request object. Request message for creating a finding.
parent (
str
) –Required. Resource name of the new finding’s parent. The following list shows some examples of the format: +
organizations/[organization_id]/sources/[source_id]
+organizations/[organization_id]/sources/[source_id]/locations/[location_id]
This corresponds to the
parent
field on therequest
instance; ifrequest
is provided, this should not be set.finding (
google.cloud.securitycenter_v2.types.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 therequest
instance; ifrequest
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 therequest
instance; ifrequest
is provided, this should not be set.retry (google.api_core.retry_async.AsyncRetry) – 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
Security 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.
- Return type
- async create_mute_config(request: Optional[Union[google.cloud.securitycenter_v2.types.securitycenter_service.CreateMuteConfigRequest, dict]] = None, *, parent: Optional[str] = None, mute_config: Optional[google.cloud.securitycenter_v2.types.mute_config.MuteConfig] = None, mute_config_id: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.securitycenter_v2.types.mute_config.MuteConfig [source]¶
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_v2 async def sample_create_mute_config(): # Create a client client = securitycenter_v2.SecurityCenterAsyncClient() # Initialize request argument(s) mute_config = securitycenter_v2.MuteConfig() mute_config.filter = "filter_value" mute_config.type_ = "DYNAMIC" request = securitycenter_v2.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
request (Optional[Union[google.cloud.securitycenter_v2.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]/locations/[location_id]
,folders/[folder_id]/locations/[location_id]
, orprojects/[project_id]/locations/[location_id]
.This corresponds to the
parent
field on therequest
instance; ifrequest
is provided, this should not be set.mute_config (
google.cloud.securitycenter_v2.types.MuteConfig
) –Required. The mute config being created.
This corresponds to the
mute_config
field on therequest
instance; ifrequest
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 only lowercase letters, numbers, and hyphens, must start with a letter, must end with either a letter or a number, and must be 63 characters or less.
This corresponds to the
mute_config_id
field on therequest
instance; ifrequest
is provided, this should not be set.retry (google.api_core.retry_async.AsyncRetry) – 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
A mute config is a Cloud SCC resource that contains the configuration to mute create/update events of findings.
- Return type
- async create_notification_config(request: Optional[Union[google.cloud.securitycenter_v2.types.securitycenter_service.CreateNotificationConfigRequest, dict]] = None, *, parent: Optional[str] = None, notification_config: Optional[google.cloud.securitycenter_v2.types.notification_config.NotificationConfig] = None, config_id: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.securitycenter_v2.types.notification_config.NotificationConfig [source]¶
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_v2 async def sample_create_notification_config(): # Create a client client = securitycenter_v2.SecurityCenterAsyncClient() # Initialize request argument(s) request = securitycenter_v2.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
request (Optional[Union[google.cloud.securitycenter_v2.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]/locations/[location_id]
,folders/[folder_id]/locations/[location_id]
, orprojects/[project_id]/locations/[location_id]
.This corresponds to the
parent
field on therequest
instance; ifrequest
is provided, this should not be set.notification_config (
google.cloud.securitycenter_v2.types.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 therequest
instance; ifrequest
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 contain alphanumeric characters, underscores, or hyphens only.
This corresponds to the
config_id
field on therequest
instance; ifrequest
is provided, this should not be set.retry (google.api_core.retry_async.AsyncRetry) – 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
Cloud 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.
- Return type
- async create_source(request: Optional[Union[google.cloud.securitycenter_v2.types.securitycenter_service.CreateSourceRequest, dict]] = None, *, parent: Optional[str] = None, source: Optional[google.cloud.securitycenter_v2.types.source.Source] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.securitycenter_v2.types.source.Source [source]¶
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_v2 async def sample_create_source(): # Create a client client = securitycenter_v2.SecurityCenterAsyncClient() # Initialize request argument(s) request = securitycenter_v2.CreateSourceRequest( parent="parent_value", ) # Make the request response = await client.create_source(request=request) # Handle the response print(response)
- Parameters
request (Optional[Union[google.cloud.securitycenter_v2.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 therequest
instance; ifrequest
is provided, this should not be set.source (
google.cloud.securitycenter_v2.types.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 therequest
instance; ifrequest
is provided, this should not be set.retry (google.api_core.retry_async.AsyncRetry) – 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
Security 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.
- Return type
- async delete_big_query_export(request: Optional[Union[google.cloud.securitycenter_v2.types.securitycenter_service.DeleteBigQueryExportRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) None [source]¶
Deletes an existing BigQuery 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_v2 async def sample_delete_big_query_export(): # Create a client client = securitycenter_v2.SecurityCenterAsyncClient() # Initialize request argument(s) request = securitycenter_v2.DeleteBigQueryExportRequest( name="name_value", ) # Make the request await client.delete_big_query_export(request=request)
- Parameters
request (Optional[Union[google.cloud.securitycenter_v2.types.DeleteBigQueryExportRequest, dict]]) – The request object. Request message for deleting a BigQuery export.
name (
str
) –Required. The name of the BigQuery export to delete. The following list shows some examples of the format:
organizations/{organization}/locations/{location}/bigQueryExports/{export_id}
folders/{folder}/locations/{location}/bigQueryExports/{export_id}
projects/{project}/locations/{location}/bigQueryExports/{export_id}
This corresponds to the
name
field on therequest
instance; ifrequest
is provided, this should not be set.retry (google.api_core.retry_async.AsyncRetry) – 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.
- async delete_mute_config(request: Optional[Union[google.cloud.securitycenter_v2.types.securitycenter_service.DeleteMuteConfigRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) None [source]¶
Deletes an existing mute config. If no location is specified, default is global.
# 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_v2 async def sample_delete_mute_config(): # Create a client client = securitycenter_v2.SecurityCenterAsyncClient() # Initialize request argument(s) request = securitycenter_v2.DeleteMuteConfigRequest( name="name_value", ) # Make the request await client.delete_mute_config(request=request)
- Parameters
request (Optional[Union[google.cloud.securitycenter_v2.types.DeleteMuteConfigRequest, dict]]) – The request object. Request message for deleting a mute config. If no location is specified, default is global.
name (
str
) –Required. Name of the mute config to delete. The following list shows some examples of the format:
organizations/{organization}/muteConfigs/{config_id}
organizations/{organization}/locations/{location}/muteConfigs/{config_id}
folders/{folder}/muteConfigs/{config_id}
folders/{folder}/locations/{location}/muteConfigs/{config_id}
projects/{project}/muteConfigs/{config_id}
projects/{project}/locations/{location}/muteConfigs/{config_id}
This corresponds to the
name
field on therequest
instance; ifrequest
is provided, this should not be set.retry (google.api_core.retry_async.AsyncRetry) – 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.
- async delete_notification_config(request: Optional[Union[google.cloud.securitycenter_v2.types.securitycenter_service.DeleteNotificationConfigRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) None [source]¶
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_v2 async def sample_delete_notification_config(): # Create a client client = securitycenter_v2.SecurityCenterAsyncClient() # Initialize request argument(s) request = securitycenter_v2.DeleteNotificationConfigRequest( name="name_value", ) # Make the request await client.delete_notification_config(request=request)
- Parameters
request (Optional[Union[google.cloud.securitycenter_v2.types.DeleteNotificationConfigRequest, dict]]) – The request object. Request message for deleting a notification config.
name (
str
) –Required. Name of the notification config to delete. The following list shows some examples of the format:
organizations/[organization_id]/locations/[location_id]/notificationConfigs/[config_id]
+folders/[folder_id]/locations/[location_id]notificationConfigs/[config_id]
+projects/[project_id]/locations/[location_id]notificationConfigs/[config_id]
This corresponds to the
name
field on therequest
instance; ifrequest
is provided, this should not be set.retry (google.api_core.retry_async.AsyncRetry) – 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.
- async delete_operation(request: Optional[google.longrunning.operations_pb2.DeleteOperationRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) None [source]¶
Deletes a long-running operation.
This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn’t support this method, it returns google.rpc.Code.UNIMPLEMENTED.
- Parameters
request (
DeleteOperationRequest
) – The request object. Request message for DeleteOperation method.retry (google.api_core.retry_async.AsyncRetry) – 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
None
- async delete_resource_value_config(request: Optional[Union[google.cloud.securitycenter_v2.types.securitycenter_service.DeleteResourceValueConfigRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) None [source]¶
Deletes a ResourceValueConfig.
# 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_v2 async def sample_delete_resource_value_config(): # Create a client client = securitycenter_v2.SecurityCenterAsyncClient() # Initialize request argument(s) request = securitycenter_v2.DeleteResourceValueConfigRequest( name="name_value", ) # Make the request await client.delete_resource_value_config(request=request)
- Parameters
request (Optional[Union[google.cloud.securitycenter_v2.types.DeleteResourceValueConfigRequest, dict]]) – The request object. Request message to delete resource value config
name (
str
) –Required. Name of the ResourceValueConfig to delete
This corresponds to the
name
field on therequest
instance; ifrequest
is provided, this should not be set.retry (google.api_core.retry_async.AsyncRetry) – 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.
- static external_system_path(organization: str, source: str, finding: str, externalsystem: str) str ¶
Returns a fully-qualified external_system string.
- static finding_path(organization: str, source: str, finding: str) str ¶
Returns a fully-qualified finding string.
- classmethod from_service_account_file(filename: str, *args, **kwargs)[source]¶
- Creates an instance of this client using the provided credentials
file.
- Parameters
filename (str) – The path to the service account private key json file.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.
- Returns
The constructed client.
- Return type
- classmethod from_service_account_info(info: dict, *args, **kwargs)[source]¶
- Creates an instance of this client using the provided credentials
info.
- Parameters
info (dict) – The service account private key info.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.
- Returns
The constructed client.
- Return type
- classmethod from_service_account_json(filename: str, *args, **kwargs)¶
- Creates an instance of this client using the provided credentials
file.
- Parameters
filename (str) – The path to the service account private key json file.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.
- Returns
The constructed client.
- Return type
- async get_big_query_export(request: Optional[Union[google.cloud.securitycenter_v2.types.securitycenter_service.GetBigQueryExportRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.securitycenter_v2.types.bigquery_export.BigQueryExport [source]¶
Gets a BigQuery 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_v2 async def sample_get_big_query_export(): # Create a client client = securitycenter_v2.SecurityCenterAsyncClient() # Initialize request argument(s) request = securitycenter_v2.GetBigQueryExportRequest( name="name_value", ) # Make the request response = await client.get_big_query_export(request=request) # Handle the response print(response)
- Parameters
request (Optional[Union[google.cloud.securitycenter_v2.types.GetBigQueryExportRequest, dict]]) – The request object. Request message for retrieving a BigQuery export.
name (
str
) –Required. Name of the BigQuery export to retrieve. The following list shows some examples of the format:
organizations/{organization}/locations/{location}/bigQueryExports/{export_id}
folders/{folder}/locations/{location}/bigQueryExports/{export_id}
projects/{project}locations/{location}//bigQueryExports/{export_id}
This corresponds to the
name
field on therequest
instance; ifrequest
is provided, this should not be set.retry (google.api_core.retry_async.AsyncRetry) – 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
Configures how to deliver Findings to BigQuery Instance.
- Return type
- async get_iam_policy(request: Optional[Union[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest, dict]] = None, *, resource: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.iam.v1.policy_pb2.Policy [source]¶
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_v2 from google.iam.v1 import iam_policy_pb2 # type: ignore async def sample_get_iam_policy(): # Create a client client = securitycenter_v2.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
request (Optional[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 therequest
instance; ifrequest
is provided, this should not be set.retry (google.api_core.retry_async.AsyncRetry) – 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
- An 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](https://cloud.google.com/iam/docs/).
- Return type
google.iam.v1.policy_pb2.Policy
- classmethod get_mtls_endpoint_and_cert_source(client_options: Optional[google.api_core.client_options.ClientOptions] = None)[source]¶
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 variable 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.
- Parameters
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.
- Returns
- returns the API endpoint and the
client cert source to use.
- Return type
- Raises
google.auth.exceptions.MutualTLSChannelError – If any errors happen.
- async get_mute_config(request: Optional[Union[google.cloud.securitycenter_v2.types.securitycenter_service.GetMuteConfigRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.securitycenter_v2.types.mute_config.MuteConfig [source]¶
Gets a mute config. If no location is specified, default is global.
# 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_v2 async def sample_get_mute_config(): # Create a client client = securitycenter_v2.SecurityCenterAsyncClient() # Initialize request argument(s) request = securitycenter_v2.GetMuteConfigRequest( name="name_value", ) # Make the request response = await client.get_mute_config(request=request) # Handle the response print(response)
- Parameters
request (Optional[Union[google.cloud.securitycenter_v2.types.GetMuteConfigRequest, dict]]) – The request object. Request message for retrieving a mute config. If no location is specified, default is global.
name (
str
) –Required. Name of the mute config to retrieve. The following list shows some examples of the format:
organizations/{organization}/muteConfigs/{config_id}
organizations/{organization}/locations/{location}/muteConfigs/{config_id}
folders/{folder}/muteConfigs/{config_id}
folders/{folder}/locations/{location}/muteConfigs/{config_id}
projects/{project}/muteConfigs/{config_id}
projects/{project}/locations/{location}/muteConfigs/{config_id}
This corresponds to the
name
field on therequest
instance; ifrequest
is provided, this should not be set.retry (google.api_core.retry_async.AsyncRetry) – 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
A mute config is a Cloud SCC resource that contains the configuration to mute create/update events of findings.
- Return type
- async get_notification_config(request: Optional[Union[google.cloud.securitycenter_v2.types.securitycenter_service.GetNotificationConfigRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.securitycenter_v2.types.notification_config.NotificationConfig [source]¶
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_v2 async def sample_get_notification_config(): # Create a client client = securitycenter_v2.SecurityCenterAsyncClient() # Initialize request argument(s) request = securitycenter_v2.GetNotificationConfigRequest( name="name_value", ) # Make the request response = await client.get_notification_config(request=request) # Handle the response print(response)
- Parameters
request (Optional[Union[google.cloud.securitycenter_v2.types.GetNotificationConfigRequest, dict]]) – The request object. Request message for getting a notification config.
name (
str
) –Required. Name of the notification config to get. The following list shows some examples of the format:
organizations/[organization_id]/locations/[location_id]/notificationConfigs/[config_id]
+folders/[folder_id]/locations/[location_id]/notificationConfigs/[config_id]
+projects/[project_id]/locations/[location_id]/notificationConfigs/[config_id]
This corresponds to the
name
field on therequest
instance; ifrequest
is provided, this should not be set.retry (google.api_core.retry_async.AsyncRetry) – 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
Cloud 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.
- Return type
- async get_operation(request: Optional[google.longrunning.operations_pb2.GetOperationRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.longrunning.operations_pb2.Operation [source]¶
Gets the latest state of a long-running operation.
- Parameters
request (
GetOperationRequest
) – The request object. Request message for GetOperation method.retry (google.api_core.retry_async.AsyncRetry) – 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
An
Operation
object.- Return type
Operation
- async get_resource_value_config(request: Optional[Union[google.cloud.securitycenter_v2.types.securitycenter_service.GetResourceValueConfigRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.securitycenter_v2.types.resource_value_config.ResourceValueConfig [source]¶
Gets a ResourceValueConfig.
# 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_v2 async def sample_get_resource_value_config(): # Create a client client = securitycenter_v2.SecurityCenterAsyncClient() # Initialize request argument(s) request = securitycenter_v2.GetResourceValueConfigRequest( name="name_value", ) # Make the request response = await client.get_resource_value_config(request=request) # Handle the response print(response)
- Parameters
request (Optional[Union[google.cloud.securitycenter_v2.types.GetResourceValueConfigRequest, dict]]) – The request object. Request message to get resource value config
name (
str
) –Required. Name of the resource value config to retrieve. Its format is organizations/{organization}/resourceValueConfigs/{config_id}.
This corresponds to the
name
field on therequest
instance; ifrequest
is provided, this should not be set.retry (google.api_core.retry_async.AsyncRetry) – 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
A resource value configuration (RVC) is a mapping configuration of user’s resources to resource values. Used in Attack path simulations.
- Return type
- async get_simulation(request: Optional[Union[google.cloud.securitycenter_v2.types.securitycenter_service.GetSimulationRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.securitycenter_v2.types.simulation.Simulation [source]¶
Get the simulation by name or the latest simulation for the given 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_v2 async def sample_get_simulation(): # Create a client client = securitycenter_v2.SecurityCenterAsyncClient() # Initialize request argument(s) request = securitycenter_v2.GetSimulationRequest( name="name_value", ) # Make the request response = await client.get_simulation(request=request) # Handle the response print(response)
- Parameters
request (Optional[Union[google.cloud.securitycenter_v2.types.GetSimulationRequest, dict]]) – The request object. Request message for getting simulation. Simulation name can include “latest” to retrieve the latest simulation For example, “organizations/123/simulations/latest”.
name (
str
) –Required. The organization name or simulation name of this simulation
Valid format:
organizations/{organization}/simulations/latest
organizations/{organization}/simulations/{simulation}
This corresponds to the
name
field on therequest
instance; ifrequest
is provided, this should not be set.retry (google.api_core.retry_async.AsyncRetry) – 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
Attack path simulation
- Return type
- async get_source(request: Optional[Union[google.cloud.securitycenter_v2.types.securitycenter_service.GetSourceRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.securitycenter_v2.types.source.Source [source]¶
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_v2 async def sample_get_source(): # Create a client client = securitycenter_v2.SecurityCenterAsyncClient() # Initialize request argument(s) request = securitycenter_v2.GetSourceRequest( name="name_value", ) # Make the request response = await client.get_source(request=request) # Handle the response print(response)
- Parameters
request (Optional[Union[google.cloud.securitycenter_v2.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 therequest
instance; ifrequest
is provided, this should not be set.retry (google.api_core.retry_async.AsyncRetry) – 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
Security 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.
- Return type
- classmethod get_transport_class(label: Optional[str] = None) Type[google.cloud.securitycenter_v2.services.security_center.transports.base.SecurityCenterTransport] ¶
Returns an appropriate transport class.
- Parameters
label – The name of the desired transport. If none is provided, then the first transport in the registry is used.
- Returns
The transport class to use.
- async get_valued_resource(request: Optional[Union[google.cloud.securitycenter_v2.types.securitycenter_service.GetValuedResourceRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.securitycenter_v2.types.valued_resource.ValuedResource [source]¶
Get the valued resource by name
# 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_v2 async def sample_get_valued_resource(): # Create a client client = securitycenter_v2.SecurityCenterAsyncClient() # Initialize request argument(s) request = securitycenter_v2.GetValuedResourceRequest( name="name_value", ) # Make the request response = await client.get_valued_resource(request=request) # Handle the response print(response)
- Parameters
request (Optional[Union[google.cloud.securitycenter_v2.types.GetValuedResourceRequest, dict]]) – The request object. Request message for getting a valued resource.
name (
str
) –Required. The name of this valued resource
Valid format:
organizations/{organization}/simulations/{simulation}/valuedResources/{valued_resource}
This corresponds to the
name
field on therequest
instance; ifrequest
is provided, this should not be set.retry (google.api_core.retry_async.AsyncRetry) – 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
A resource that is determined to have value to a user’s system
- Return type
- async group_findings(request: Optional[Union[google.cloud.securitycenter_v2.types.securitycenter_service.GroupFindingsRequest, dict]] = None, *, parent: Optional[str] = None, group_by: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.securitycenter_v2.services.security_center.pagers.GroupFindingsAsyncPager [source]¶
Filters an organization or source’s findings and groups them by their specified properties in a location. If no location is specified, findings are assumed to be in global
To group across all sources provide a
-
as the source id. The following list shows some examples:/v2/organizations/{organization_id}/sources/-/findings
/v2/organizations/{organization_id}/sources/-/locations/{location_id}/findings
/v2/folders/{folder_id}/sources/-/findings
/v2/folders/{folder_id}/sources/-/locations/{location_id}/findings
/v2/projects/{project_id}/sources/-/findings
/v2/projects/{project_id}/sources/-/locations/{location_id}/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_v2 async def sample_group_findings(): # Create a client client = securitycenter_v2.SecurityCenterAsyncClient() # Initialize request argument(s) request = securitycenter_v2.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
request (Optional[Union[google.cloud.securitycenter_v2.types.GroupFindingsRequest, dict]]) – The request object. Request message for grouping by findings.
parent (
str
) –Required. Name of the source to groupBy. If no location is specified, finding is assumed to be in global. The following list shows some examples:
organizations/[organization_id]/sources/[source_id]
organizations/[organization_id]/sources/[source_id]/locations/[location_id]
folders/[folder_id]/sources/[source_id]
folders/[folder_id]/sources/[source_id]/locations/[location_id]
projects/[project_id]/sources/[source_id]
projects/[project_id]/sources/[source_id]/locations/[location_id]
To groupBy across all sources provide a source_id of
-
. The following list shows some examples:organizations/{organization_id}/sources/-
organizations/{organization_id}/sources/-/locations/[location_id]
folders/{folder_id}/sources/-
folders/{folder_id}/sources/-/locations/[location_id]
projects/{project_id}/sources/-
projects/{project_id}/sources/-/locations/[location_id]
This corresponds to the
parent
field on therequest
instance; ifrequest
is provided, this should not be set.group_by (
str
) –Required. Expression that defines what assets fields to use for grouping. The string value should follow SQL syntax: comma separated list of fields. For example: “parent,resource_name”.
This corresponds to the
group_by
field on therequest
instance; ifrequest
is provided, this should not be set.retry (google.api_core.retry_async.AsyncRetry) – 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
Response message for group by findings. Iterating over this object will yield results and resolve additional pages automatically.
- Return type
google.cloud.securitycenter_v2.services.security_center.pagers.GroupFindingsAsyncPager
- async list_attack_paths(request: Optional[Union[google.cloud.securitycenter_v2.types.securitycenter_service.ListAttackPathsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.securitycenter_v2.services.security_center.pagers.ListAttackPathsAsyncPager [source]¶
Lists the attack paths for a set of simulation results or valued resources and filter.
# 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_v2 async def sample_list_attack_paths(): # Create a client client = securitycenter_v2.SecurityCenterAsyncClient() # Initialize request argument(s) request = securitycenter_v2.ListAttackPathsRequest( parent="parent_value", ) # Make the request page_result = client.list_attack_paths(request=request) # Handle the response async for response in page_result: print(response)
- Parameters
request (Optional[Union[google.cloud.securitycenter_v2.types.ListAttackPathsRequest, dict]]) – The request object. Request message for listing the attack paths for a given simulation or valued resource.
parent (
str
) –Required. Name of parent to list attack paths.
Valid formats:
organizations/{organization}
,organizations/{organization}/simulations/{simulation}
organizations/{organization}/simulations/{simulation}/attackExposureResults/{attack_exposure_result_v2}
organizations/{organization}/simulations/{simulation}/valuedResources/{valued_resource}
This corresponds to the
parent
field on therequest
instance; ifrequest
is provided, this should not be set.retry (google.api_core.retry_async.AsyncRetry) – 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
Response message for listing the attack paths for a given simulation or valued resource.
Iterating over this object will yield results and resolve additional pages automatically.
- Return type
google.cloud.securitycenter_v2.services.security_center.pagers.ListAttackPathsAsyncPager
- async list_big_query_exports(request: Optional[Union[google.cloud.securitycenter_v2.types.securitycenter_service.ListBigQueryExportsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.securitycenter_v2.services.security_center.pagers.ListBigQueryExportsAsyncPager [source]¶
Lists BigQuery exports. Note that when requesting BigQuery exports at a given level all exports under that level are also returned e.g. if requesting BigQuery exports under a folder, then all BigQuery exports immediately under the folder plus the ones created under the projects within the folder are returned.
# 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_v2 async def sample_list_big_query_exports(): # Create a client client = securitycenter_v2.SecurityCenterAsyncClient() # Initialize request argument(s) request = securitycenter_v2.ListBigQueryExportsRequest( parent="parent_value", ) # Make the request page_result = client.list_big_query_exports(request=request) # Handle the response async for response in page_result: print(response)
- Parameters
request (Optional[Union[google.cloud.securitycenter_v2.types.ListBigQueryExportsRequest, dict]]) – The request object. Request message for listing BigQuery exports at a given scope e.g. organization, folder or project.
parent (
str
) –Required. The parent, which owns the collection of BigQuery exports. Its format is
organizations/[organization_id]/locations/[location_id]
,folders/[folder_id]/locations/[location_id]
, orprojects/[project_id]/locations/[location_id]
.This corresponds to the
parent
field on therequest
instance; ifrequest
is provided, this should not be set.retry (google.api_core.retry_async.AsyncRetry) – 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
Response message for listing BigQuery exports. Iterating over this object will yield results and resolve additional pages automatically.
- Return type
google.cloud.securitycenter_v2.services.security_center.pagers.ListBigQueryExportsAsyncPager
- async list_findings(request: Optional[Union[google.cloud.securitycenter_v2.types.securitycenter_service.ListFindingsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.securitycenter_v2.services.security_center.pagers.ListFindingsAsyncPager [source]¶
Lists an organization or source’s findings.
To list across all sources for a given location provide a
-
as the source id. If no location is specified, finding are assumed to be in global. The following list shows some examples:/v2/organizations/{organization_id}/sources/-/findings
/v2/organizations/{organization_id}/sources/-/locations/{location_id}/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_v2 async def sample_list_findings(): # Create a client client = securitycenter_v2.SecurityCenterAsyncClient() # Initialize request argument(s) request = securitycenter_v2.ListFindingsRequest( parent="parent_value", ) # Make the request page_result = client.list_findings(request=request) # Handle the response async for response in page_result: print(response)
- Parameters
request (Optional[Union[google.cloud.securitycenter_v2.types.ListFindingsRequest, dict]]) – The request object. Request message for listing findings.
parent (
str
) –Required. Name of the source the findings belong to. If no location is specified, the default is global. The following list shows some examples:
organizations/[organization_id]/sources/[source_id]
organizations/[organization_id]/sources/[source_id]/locations/[location_id]
folders/[folder_id]/sources/[source_id]
folders/[folder_id]/sources/[source_id]/locations/[location_id]
projects/[project_id]/sources/[source_id]
projects/[project_id]/sources/[source_id]/locations/[location_id]
To list across all sources provide a source_id of
-
. The following list shows some examples:organizations/{organization_id}/sources/-
organizations/{organization_id}/sources/-/locations/{location_id}
folders/{folder_id}/sources/-
folders/{folder_id}/sources/-locations/{location_id}
projects/{projects_id}/sources/-
projects/{projects_id}/sources/-/locations/{location_id}
This corresponds to the
parent
field on therequest
instance; ifrequest
is provided, this should not be set.retry (google.api_core.retry_async.AsyncRetry) – 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
Response message for listing findings. Iterating over this object will yield results and resolve additional pages automatically.
- Return type
google.cloud.securitycenter_v2.services.security_center.pagers.ListFindingsAsyncPager
- async list_mute_configs(request: Optional[Union[google.cloud.securitycenter_v2.types.securitycenter_service.ListMuteConfigsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.securitycenter_v2.services.security_center.pagers.ListMuteConfigsAsyncPager [source]¶
Lists mute configs. If no location is specified, default is global.
# 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_v2 async def sample_list_mute_configs(): # Create a client client = securitycenter_v2.SecurityCenterAsyncClient() # Initialize request argument(s) request = securitycenter_v2.ListMuteConfigsRequest( parent="parent_value", ) # Make the request page_result = client.list_mute_configs(request=request) # Handle the response async for response in page_result: print(response)
- Parameters
request (Optional[Union[google.cloud.securitycenter_v2.types.ListMuteConfigsRequest, dict]]) – The request object. Request message for listing mute configs at a given scope e.g. organization, folder or project. If no location is specified, default is global.
parent (
str
) –Required. The parent, which owns the collection of mute configs. Its format is
organizations/[organization_id]", "folders/[folder_id]
,projects/[project_id]
,organizations/[organization_id]/locations/[location_id]
,folders/[folder_id]/locations/[location_id]
,projects/[project_id]/locations/[location_id]
.This corresponds to the
parent
field on therequest
instance; ifrequest
is provided, this should not be set.retry (google.api_core.retry_async.AsyncRetry) – 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
Response message for listing mute configs. Iterating over this object will yield results and resolve additional pages automatically.
- Return type
google.cloud.securitycenter_v2.services.security_center.pagers.ListMuteConfigsAsyncPager
- async list_notification_configs(request: Optional[Union[google.cloud.securitycenter_v2.types.securitycenter_service.ListNotificationConfigsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.securitycenter_v2.services.security_center.pagers.ListNotificationConfigsAsyncPager [source]¶
Lists notification configs.
# 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_v2 async def sample_list_notification_configs(): # Create a client client = securitycenter_v2.SecurityCenterAsyncClient() # Initialize request argument(s) request = securitycenter_v2.ListNotificationConfigsRequest( parent="parent_value", ) # Make the request page_result = client.list_notification_configs(request=request) # Handle the response async for response in page_result: print(response)
- Parameters
request (Optional[Union[google.cloud.securitycenter_v2.types.ListNotificationConfigsRequest, dict]]) – The request object. Request message for listing notification configs.
parent (
str
) –Required. The name of the parent in which to list the notification configurations. Its format is “organizations/[organization_id]/locations/[location_id]”, “folders/[folder_id]/locations/[location_id]”, or “projects/[project_id]/locations/[location_id]”.
This corresponds to the
parent
field on therequest
instance; ifrequest
is provided, this should not be set.retry (google.api_core.retry_async.AsyncRetry) – 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
Response message for listing notification configs. Iterating over this object will yield results and resolve additional pages automatically.
- Return type
google.cloud.securitycenter_v2.services.security_center.pagers.ListNotificationConfigsAsyncPager
- async list_operations(request: Optional[google.longrunning.operations_pb2.ListOperationsRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.longrunning.operations_pb2.ListOperationsResponse [source]¶
Lists operations that match the specified filter in the request.
- Parameters
request (
ListOperationsRequest
) – The request object. Request message for ListOperations method.retry (google.api_core.retry_async.AsyncRetry) – 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
Response message for
ListOperations
method.- Return type
ListOperationsResponse
- async list_resource_value_configs(request: Optional[Union[google.cloud.securitycenter_v2.types.securitycenter_service.ListResourceValueConfigsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.securitycenter_v2.services.security_center.pagers.ListResourceValueConfigsAsyncPager [source]¶
Lists all ResourceValueConfigs.
# 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_v2 async def sample_list_resource_value_configs(): # Create a client client = securitycenter_v2.SecurityCenterAsyncClient() # Initialize request argument(s) request = securitycenter_v2.ListResourceValueConfigsRequest( parent="parent_value", ) # Make the request page_result = client.list_resource_value_configs(request=request) # Handle the response async for response in page_result: print(response)
- Parameters
request (Optional[Union[google.cloud.securitycenter_v2.types.ListResourceValueConfigsRequest, dict]]) – The request object. Request message to list resource value configs of a parent
parent (
str
) –Required. The parent, which owns the collection of resource value configs. Its format is
organizations/[organization_id]
This corresponds to the
parent
field on therequest
instance; ifrequest
is provided, this should not be set.retry (google.api_core.retry_async.AsyncRetry) – 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
Response message to list resource value configs Iterating over this object will yield results and resolve additional pages automatically.
- Return type
google.cloud.securitycenter_v2.services.security_center.pagers.ListResourceValueConfigsAsyncPager
- async list_sources(request: Optional[Union[google.cloud.securitycenter_v2.types.securitycenter_service.ListSourcesRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.securitycenter_v2.services.security_center.pagers.ListSourcesAsyncPager [source]¶
Lists all sources belonging to 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_v2 async def sample_list_sources(): # Create a client client = securitycenter_v2.SecurityCenterAsyncClient() # Initialize request argument(s) request = securitycenter_v2.ListSourcesRequest( parent="parent_value", ) # Make the request page_result = client.list_sources(request=request) # Handle the response async for response in page_result: print(response)
- Parameters
request (Optional[Union[google.cloud.securitycenter_v2.types.ListSourcesRequest, dict]]) – The request object. Request message for listing sources.
parent (
str
) –Required. Resource name of the parent of sources to list. Its format should be
organizations/[organization_id]
,folders/[folder_id]
, orprojects/[project_id]
.This corresponds to the
parent
field on therequest
instance; ifrequest
is provided, this should not be set.retry (google.api_core.retry_async.AsyncRetry) – 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
Response message for listing sources.
Iterating over this object will yield results and resolve additional pages automatically.
- Return type
google.cloud.securitycenter_v2.services.security_center.pagers.ListSourcesAsyncPager
- async list_valued_resources(request: Optional[Union[google.cloud.securitycenter_v2.types.securitycenter_service.ListValuedResourcesRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.securitycenter_v2.services.security_center.pagers.ListValuedResourcesAsyncPager [source]¶
Lists the valued resources for a set of simulation results and filter.
# 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_v2 async def sample_list_valued_resources(): # Create a client client = securitycenter_v2.SecurityCenterAsyncClient() # Initialize request argument(s) request = securitycenter_v2.ListValuedResourcesRequest( parent="parent_value", ) # Make the request page_result = client.list_valued_resources(request=request) # Handle the response async for response in page_result: print(response)
- Parameters
request (Optional[Union[google.cloud.securitycenter_v2.types.ListValuedResourcesRequest, dict]]) – The request object. Request message for listing the valued resources for a given simulation.
parent (
str
) –Required. Name of parent to list exposed resources.
Valid formats:
organizations/{organization}
,organizations/{organization}/simulations/{simulation}
organizations/{organization}/simulations/{simulation}/attackExposureResults/{attack_exposure_result_v2}
This corresponds to the
parent
field on therequest
instance; ifrequest
is provided, this should not be set.retry (google.api_core.retry_async.AsyncRetry) – 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
Response message for listing the valued resources for a given simulation. Iterating over this object will yield results and resolve additional pages automatically.
- Return type
google.cloud.securitycenter_v2.services.security_center.pagers.ListValuedResourcesAsyncPager
- static mute_config_path(organization: str, mute_config: str) str ¶
Returns a fully-qualified mute_config string.
- static notification_config_path(organization: str, location: str, notification_config: str) str ¶
Returns a fully-qualified notification_config string.
- static parse_attack_path_path(path: str) Dict[str, str] ¶
Parses a attack_path path into its component segments.
- static parse_big_query_export_path(path: str) Dict[str, str] ¶
Parses a big_query_export path into its component segments.
- static parse_common_billing_account_path(path: str) Dict[str, str] ¶
Parse a billing_account path into its component segments.
- static parse_common_folder_path(path: str) Dict[str, str] ¶
Parse a folder path into its component segments.
- static parse_common_location_path(path: str) Dict[str, str] ¶
Parse a location path into its component segments.
- static parse_common_organization_path(path: str) Dict[str, str] ¶
Parse a organization path into its component segments.
- static parse_common_project_path(path: str) Dict[str, str] ¶
Parse a project path into its component segments.
- static parse_dlp_job_path(path: str) Dict[str, str] ¶
Parses a dlp_job path into its component segments.
- static parse_external_system_path(path: str) Dict[str, str] ¶
Parses a external_system path into its component segments.
- static parse_finding_path(path: str) Dict[str, str] ¶
Parses a finding path into its component segments.
- static parse_mute_config_path(path: str) Dict[str, str] ¶
Parses a mute_config path into its component segments.
- static parse_notification_config_path(path: str) Dict[str, str] ¶
Parses a notification_config path into its component segments.
- static parse_policy_path(path: str) Dict[str, str] ¶
Parses a policy path into its component segments.
- static parse_resource_value_config_path(path: str) Dict[str, str] ¶
Parses a resource_value_config path into its component segments.
- static parse_security_marks_path(path: str) Dict[str, str] ¶
Parses a security_marks path into its component segments.
- static parse_simulation_path(path: str) Dict[str, str] ¶
Parses a simulation path into its component segments.
- static parse_source_path(path: str) Dict[str, str] ¶
Parses a source path into its component segments.
- static parse_table_data_profile_path(path: str) Dict[str, str] ¶
Parses a table_data_profile path into its component segments.
- static parse_topic_path(path: str) Dict[str, str] ¶
Parses a topic path into its component segments.
- static parse_valued_resource_path(path: str) Dict[str, str] ¶
Parses a valued_resource path into its component segments.
- static policy_path(organization: str, constraint_name: str) str ¶
Returns a fully-qualified policy string.
- static resource_value_config_path(organization: str, resource_value_config: str) str ¶
Returns a fully-qualified resource_value_config string.
- static security_marks_path(organization: str, asset: str) str ¶
Returns a fully-qualified security_marks string.
- async set_finding_state(request: Optional[Union[google.cloud.securitycenter_v2.types.securitycenter_service.SetFindingStateRequest, dict]] = None, *, name: Optional[str] = None, state: Optional[google.cloud.securitycenter_v2.types.finding.Finding.State] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.securitycenter_v2.types.finding.Finding [source]¶
Updates the state of a finding. If no location is specified, finding is assumed to be in global
# 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_v2 async def sample_set_finding_state(): # Create a client client = securitycenter_v2.SecurityCenterAsyncClient() # Initialize request argument(s) request = securitycenter_v2.SetFindingStateRequest( name="name_value", state="INACTIVE", ) # Make the request response = await client.set_finding_state(request=request) # Handle the response print(response)
- Parameters
request (Optional[Union[google.cloud.securitycenter_v2.types.SetFindingStateRequest, dict]]) – The request object. Request message for updating a finding’s state.
name (
str
) –Required. The relative resource name of the finding. If no location is specified, finding is assumed to be in global. The following list shows some examples:
organizations/{organization_id}/sources/{source_id}/findings/{finding_id}
+organizations/{organization_id}/sources/{source_id}/locations/{location_id}/findings/{finding_id}
folders/{folder_id}/sources/{source_id}/findings/{finding_id}
folders/{folder_id}/sources/{source_id}/locations/{location_id}/findings/{finding_id}
projects/{project_id}/sources/{source_id}/findings/{finding_id}
projects/{project_id}/sources/{source_id}/locations/{location_id}/findings/{finding_id}
This corresponds to the
name
field on therequest
instance; ifrequest
is provided, this should not be set.state (
google.cloud.securitycenter_v2.types.Finding.State
) –Required. The desired State of the finding.
This corresponds to the
state
field on therequest
instance; ifrequest
is provided, this should not be set.retry (google.api_core.retry_async.AsyncRetry) – 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
Security 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.
- Return type
- async set_iam_policy(request: Optional[Union[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest, dict]] = None, *, resource: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.iam.v1.policy_pb2.Policy [source]¶
Sets 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_v2 from google.iam.v1 import iam_policy_pb2 # type: ignore async def sample_set_iam_policy(): # Create a client client = securitycenter_v2.SecurityCenterAsyncClient() # Initialize request argument(s) request = iam_policy_pb2.SetIamPolicyRequest( resource="resource_value", ) # Make the request response = await client.set_iam_policy(request=request) # Handle the response print(response)
- Parameters
request (Optional[Union[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest, dict]]) – The request object. Request message for
SetIamPolicy
method.resource (
str
) –REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.
This corresponds to the
resource
field on therequest
instance; ifrequest
is provided, this should not be set.retry (google.api_core.retry_async.AsyncRetry) – 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
- An 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](https://cloud.google.com/iam/docs/).
- Return type
google.iam.v1.policy_pb2.Policy
- async set_mute(request: Optional[Union[google.cloud.securitycenter_v2.types.securitycenter_service.SetMuteRequest, dict]] = None, *, name: Optional[str] = None, mute: Optional[google.cloud.securitycenter_v2.types.finding.Finding.Mute] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.securitycenter_v2.types.finding.Finding [source]¶
Updates the mute state of a finding. If no location is specified, finding is assumed to be in global
# 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_v2 async def sample_set_mute(): # Create a client client = securitycenter_v2.SecurityCenterAsyncClient() # Initialize request argument(s) request = securitycenter_v2.SetMuteRequest( name="name_value", mute="UNDEFINED", ) # Make the request response = await client.set_mute(request=request) # Handle the response print(response)
- Parameters
request (Optional[Union[google.cloud.securitycenter_v2.types.SetMuteRequest, dict]]) – The request object. Request message for updating a finding’s mute status.
name (
str
) –Required. The relative resource name of the finding. If no location is specified, finding is assumed to be in global. The following list shows some examples:
organizations/{organization_id}/sources/{source_id}/findings/{finding_id}
+organizations/{organization_id}/sources/{source_id}/locations/{location_id}/findings/{finding_id}
folders/{folder_id}/sources/{source_id}/findings/{finding_id}
folders/{folder_id}/sources/{source_id}/locations/{location_id}/findings/{finding_id}
projects/{project_id}/sources/{source_id}/findings/{finding_id}
projects/{project_id}/sources/{source_id}/locations/{location_id}/findings/{finding_id}
This corresponds to the
name
field on therequest
instance; ifrequest
is provided, this should not be set.mute (
google.cloud.securitycenter_v2.types.Finding.Mute
) –Required. The desired state of the Mute.
This corresponds to the
mute
field on therequest
instance; ifrequest
is provided, this should not be set.retry (google.api_core.retry_async.AsyncRetry) – 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
Security 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.
- Return type
- static simulation_path(organization: str, simulation: str) str ¶
Returns a fully-qualified simulation string.
- static table_data_profile_path(project: str, table_profile: str) str ¶
Returns a fully-qualified table_data_profile string.
- async test_iam_permissions(request: Optional[Union[google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest, dict]] = None, *, resource: Optional[str] = None, permissions: Optional[MutableSequence[str]] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse [source]¶
Returns the permissions that a caller has 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_v2 from google.iam.v1 import iam_policy_pb2 # type: ignore async def sample_test_iam_permissions(): # Create a client client = securitycenter_v2.SecurityCenterAsyncClient() # Initialize request argument(s) request = iam_policy_pb2.TestIamPermissionsRequest( resource="resource_value", permissions=['permissions_value1', 'permissions_value2'], ) # Make the request response = await client.test_iam_permissions(request=request) # Handle the response print(response)
- Parameters
request (Optional[Union[google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest, dict]]) – The request object. Request message for
TestIamPermissions
method.resource (
str
) –REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.
This corresponds to the
resource
field on therequest
instance; ifrequest
is provided, this should not be set.permissions (
MutableSequence[str]
) –The set of permissions to check for the
resource
. Permissions with wildcards (such as ‘*’ or ‘storage.*’) are not allowed. For more information see IAM Overview.This corresponds to the
permissions
field on therequest
instance; ifrequest
is provided, this should not be set.retry (google.api_core.retry_async.AsyncRetry) – 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
Response message for TestIamPermissions method.
- Return type
google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse
- property transport: google.cloud.securitycenter_v2.services.security_center.transports.base.SecurityCenterTransport¶
Returns the transport used by the client instance.
- Returns
The transport used by the client instance.
- Return type
SecurityCenterTransport
- property universe_domain: str¶
Return the universe domain used by the client instance.
- Returns
- The universe domain used
by the client instance.
- Return type
- async update_big_query_export(request: Optional[Union[google.cloud.securitycenter_v2.types.securitycenter_service.UpdateBigQueryExportRequest, dict]] = None, *, big_query_export: Optional[google.cloud.securitycenter_v2.types.bigquery_export.BigQueryExport] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.securitycenter_v2.types.bigquery_export.BigQueryExport [source]¶
Updates a BigQuery 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_v2 async def sample_update_big_query_export(): # Create a client client = securitycenter_v2.SecurityCenterAsyncClient() # Initialize request argument(s) request = securitycenter_v2.UpdateBigQueryExportRequest( ) # Make the request response = await client.update_big_query_export(request=request) # Handle the response print(response)
- Parameters
request (Optional[Union[google.cloud.securitycenter_v2.types.UpdateBigQueryExportRequest, dict]]) – The request object. Request message for updating a BigQuery export.
big_query_export (
google.cloud.securitycenter_v2.types.BigQueryExport
) –Required. The BigQuery export being updated.
This corresponds to the
big_query_export
field on therequest
instance; ifrequest
is provided, this should not be set.update_mask (
google.protobuf.field_mask_pb2.FieldMask
) –The list of fields to be updated. If empty all mutable fields will be updated.
This corresponds to the
update_mask
field on therequest
instance; ifrequest
is provided, this should not be set.retry (google.api_core.retry_async.AsyncRetry) – 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
Configures how to deliver Findings to BigQuery Instance.
- Return type
- async update_external_system(request: Optional[Union[google.cloud.securitycenter_v2.types.securitycenter_service.UpdateExternalSystemRequest, dict]] = None, *, external_system: Optional[google.cloud.securitycenter_v2.types.external_system.ExternalSystem] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.securitycenter_v2.types.external_system.ExternalSystem [source]¶
Updates external system. This is for a given finding. If no location is specified, finding is assumed to be in global
# 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_v2 async def sample_update_external_system(): # Create a client client = securitycenter_v2.SecurityCenterAsyncClient() # Initialize request argument(s) request = securitycenter_v2.UpdateExternalSystemRequest( ) # Make the request response = await client.update_external_system(request=request) # Handle the response print(response)
- Parameters
request (Optional[Union[google.cloud.securitycenter_v2.types.UpdateExternalSystemRequest, dict]]) – The request object. Request message for updating a ExternalSystem resource.
external_system (
google.cloud.securitycenter_v2.types.ExternalSystem
) –Required. The external system resource to update.
This corresponds to the
external_system
field on therequest
instance; ifrequest
is provided, this should not be set.update_mask (
google.protobuf.field_mask_pb2.FieldMask
) –The FieldMask to use when updating the external system resource. If empty all mutable fields will be updated.
This corresponds to the
update_mask
field on therequest
instance; ifrequest
is provided, this should not be set.retry (google.api_core.retry_async.AsyncRetry) – 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
Representation of third party SIEM/SOAR fields within SCC.
- Return type
- async update_finding(request: Optional[Union[google.cloud.securitycenter_v2.types.securitycenter_service.UpdateFindingRequest, dict]] = None, *, finding: Optional[google.cloud.securitycenter_v2.types.finding.Finding] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.securitycenter_v2.types.finding.Finding [source]¶
Creates or updates a finding. If no location is specified, finding is assumed to be in global. The corresponding source must exist for a 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_v2 async def sample_update_finding(): # Create a client client = securitycenter_v2.SecurityCenterAsyncClient() # Initialize request argument(s) request = securitycenter_v2.UpdateFindingRequest( ) # Make the request response = await client.update_finding(request=request) # Handle the response print(response)
- Parameters
request (Optional[Union[google.cloud.securitycenter_v2.types.UpdateFindingRequest, dict]]) – The request object. Request message for updating or creating a finding.
finding (
google.cloud.securitycenter_v2.types.Finding
) –Required. The finding resource to update or create if it does not already exist. parent, security_marks, and update_time will be ignored.
In the case of creation, the finding id portion of the name must be alphanumeric and less than or equal to 32 characters and greater than 0 characters in length.
This corresponds to the
finding
field on therequest
instance; ifrequest
is provided, this should not be set.update_mask (
google.protobuf.field_mask_pb2.FieldMask
) –The FieldMask to use when updating the finding resource. This field should not be specified when creating a finding.
When updating a finding, an empty mask is treated as updating all mutable fields and replacing source_properties. Individual source_properties can be added/updated by using “source_properties.” in the field mask.
This corresponds to the
update_mask
field on therequest
instance; ifrequest
is provided, this should not be set.retry (google.api_core.retry_async.AsyncRetry) – 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
Security 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.
- Return type
- async update_mute_config(request: Optional[Union[google.cloud.securitycenter_v2.types.securitycenter_service.UpdateMuteConfigRequest, dict]] = None, *, mute_config: Optional[google.cloud.securitycenter_v2.types.mute_config.MuteConfig] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.securitycenter_v2.types.mute_config.MuteConfig [source]¶
Updates a mute config. If no location is specified, default is global.
# 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_v2 async def sample_update_mute_config(): # Create a client client = securitycenter_v2.SecurityCenterAsyncClient() # Initialize request argument(s) mute_config = securitycenter_v2.MuteConfig() mute_config.filter = "filter_value" mute_config.type_ = "DYNAMIC" request = securitycenter_v2.UpdateMuteConfigRequest( mute_config=mute_config, ) # Make the request response = await client.update_mute_config(request=request) # Handle the response print(response)
- Parameters
request (Optional[Union[google.cloud.securitycenter_v2.types.UpdateMuteConfigRequest, dict]]) – The request object. Request message for updating a mute config.
mute_config (
google.cloud.securitycenter_v2.types.MuteConfig
) –Required. The mute config being updated.
This corresponds to the
mute_config
field on therequest
instance; ifrequest
is provided, this should not be set.update_mask (
google.protobuf.field_mask_pb2.FieldMask
) –The list of fields to be updated. If empty all mutable fields will be updated.
This corresponds to the
update_mask
field on therequest
instance; ifrequest
is provided, this should not be set.retry (google.api_core.retry_async.AsyncRetry) – 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
A mute config is a Cloud SCC resource that contains the configuration to mute create/update events of findings.
- Return type
- async update_notification_config(request: Optional[Union[google.cloud.securitycenter_v2.types.securitycenter_service.UpdateNotificationConfigRequest, dict]] = None, *, notification_config: Optional[google.cloud.securitycenter_v2.types.notification_config.NotificationConfig] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.securitycenter_v2.types.notification_config.NotificationConfig [source]¶
Updates a notification config. The following update fields are allowed: description, pubsub_topic, streaming_config.filter
# 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_v2 async def sample_update_notification_config(): # Create a client client = securitycenter_v2.SecurityCenterAsyncClient() # Initialize request argument(s) request = securitycenter_v2.UpdateNotificationConfigRequest( ) # Make the request response = await client.update_notification_config(request=request) # Handle the response print(response)
- Parameters
request (Optional[Union[google.cloud.securitycenter_v2.types.UpdateNotificationConfigRequest, dict]]) – The request object. Request message for updating a notification config.
notification_config (
google.cloud.securitycenter_v2.types.NotificationConfig
) –Required. The notification config to update.
This corresponds to the
notification_config
field on therequest
instance; ifrequest
is provided, this should not be set.update_mask (
google.protobuf.field_mask_pb2.FieldMask
) –The FieldMask to use when updating the notification config. If empty all mutable fields will be updated.
This corresponds to the
update_mask
field on therequest
instance; ifrequest
is provided, this should not be set.retry (google.api_core.retry_async.AsyncRetry) – 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
Cloud 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.
- Return type
- async update_resource_value_config(request: Optional[Union[google.cloud.securitycenter_v2.types.securitycenter_service.UpdateResourceValueConfigRequest, dict]] = None, *, resource_value_config: Optional[google.cloud.securitycenter_v2.types.resource_value_config.ResourceValueConfig] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.securitycenter_v2.types.resource_value_config.ResourceValueConfig [source]¶
Updates an existing ResourceValueConfigs with new rules.
# 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_v2 async def sample_update_resource_value_config(): # Create a client client = securitycenter_v2.SecurityCenterAsyncClient() # Initialize request argument(s) request = securitycenter_v2.UpdateResourceValueConfigRequest( ) # Make the request response = await client.update_resource_value_config(request=request) # Handle the response print(response)
- Parameters
request (Optional[Union[google.cloud.securitycenter_v2.types.UpdateResourceValueConfigRequest, dict]]) – The request object. Request message to update resource value config
resource_value_config (
google.cloud.securitycenter_v2.types.ResourceValueConfig
) –Required. The resource value config being updated.
This corresponds to the
resource_value_config
field on therequest
instance; ifrequest
is provided, this should not be set.update_mask (
google.protobuf.field_mask_pb2.FieldMask
) –The list of fields to be updated. If empty all mutable fields will be updated.
To update nested fields, include the top level field in the mask For example, to update gcp_metadata.resource_type, include the “gcp_metadata” field mask
This corresponds to the
update_mask
field on therequest
instance; ifrequest
is provided, this should not be set.retry (google.api_core.retry_async.AsyncRetry) – 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
A resource value configuration (RVC) is a mapping configuration of user’s resources to resource values. Used in Attack path simulations.
- Return type
- async update_security_marks(request: Optional[Union[google.cloud.securitycenter_v2.types.securitycenter_service.UpdateSecurityMarksRequest, dict]] = None, *, security_marks: Optional[google.cloud.securitycenter_v2.types.security_marks.SecurityMarks] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.securitycenter_v2.types.security_marks.SecurityMarks [source]¶
Updates security marks. For Finding Security marks, if no location is specified, finding is assumed to be in global. Assets Security Marks can only be accessed through global endpoint.
# 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_v2 async def sample_update_security_marks(): # Create a client client = securitycenter_v2.SecurityCenterAsyncClient() # Initialize request argument(s) request = securitycenter_v2.UpdateSecurityMarksRequest( ) # Make the request response = await client.update_security_marks(request=request) # Handle the response print(response)
- Parameters
request (Optional[Union[google.cloud.securitycenter_v2.types.UpdateSecurityMarksRequest, dict]]) – The request object. Request message for updating a SecurityMarks resource.
security_marks (
google.cloud.securitycenter_v2.types.SecurityMarks
) –Required. The security marks resource to update.
This corresponds to the
security_marks
field on therequest
instance; ifrequest
is provided, this should not be set.update_mask (
google.protobuf.field_mask_pb2.FieldMask
) –The FieldMask to use when updating the security marks resource.
The field mask must not contain duplicate fields. If empty or set to “marks”, all marks will be replaced. Individual marks can be updated using “marks.<mark_key>”.
This corresponds to the
update_mask
field on therequest
instance; ifrequest
is provided, this should not be set.retry (google.api_core.retry_async.AsyncRetry) – 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
User specified security marks that are attached to the parent Security Command Center resource. Security marks are scoped within a Security Command Center organization – they can be modified and viewed by all users who have proper permissions on the organization.
- Return type
- async update_source(request: Optional[Union[google.cloud.securitycenter_v2.types.securitycenter_service.UpdateSourceRequest, dict]] = None, *, source: Optional[google.cloud.securitycenter_v2.types.source.Source] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.securitycenter_v2.types.source.Source [source]¶
Updates 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_v2 async def sample_update_source(): # Create a client client = securitycenter_v2.SecurityCenterAsyncClient() # Initialize request argument(s) request = securitycenter_v2.UpdateSourceRequest( ) # Make the request response = await client.update_source(request=request) # Handle the response print(response)
- Parameters
request (Optional[Union[google.cloud.securitycenter_v2.types.UpdateSourceRequest, dict]]) – The request object. Request message for updating a source.
source (
google.cloud.securitycenter_v2.types.Source
) –Required. The source resource to update.
This corresponds to the
source
field on therequest
instance; ifrequest
is provided, this should not be set.update_mask (
google.protobuf.field_mask_pb2.FieldMask
) –The FieldMask to use when updating the source resource. If empty all mutable fields will be updated.
This corresponds to the
update_mask
field on therequest
instance; ifrequest
is provided, this should not be set.retry (google.api_core.retry_async.AsyncRetry) – 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
Security 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.
- Return type
- class google.cloud.securitycenter_v2.services.security_center.SecurityCenterClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.securitycenter_v2.services.security_center.transports.base.SecurityCenterTransport, typing.Callable[[...], google.cloud.securitycenter_v2.services.security_center.transports.base.SecurityCenterTransport]]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)[source]¶
V2 APIs for Security Center service.
Instantiates the security center client.
- Parameters
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 (Optional[Union[str,SecurityCenterTransport,Callable[..., SecurityCenterTransport]]]) – The transport to use, or a Callable that constructs and returns a new transport. If a Callable is given, it will be called with the same set of initialization arguments as used in the SecurityCenterTransport constructor. If set to None, a transport is chosen automatically.
client_options (Optional[Union[google.api_core.client_options.ClientOptions, dict]]) –
Custom options for the client.
1. The
api_endpoint
property can be used to override the default endpoint provided by the client whentransport
is not explicitly provided. Only if this property is not set andtransport
was not explicitly provided, the endpoint is determined by the GOOGLE_API_USE_MTLS_ENDPOINT environment variable, which have one of the following values: “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).2. If the GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “true”, then the
client_cert_source
property can be used to provide a client certificate for mTLS 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.3. The
universe_domain
property can be used to override the default “googleapis.com” universe. Note that theapi_endpoint
property still takes precedence; anduniverse_domain
is currently not supported for mTLS.client_info (google.api_core.gapic_v1.client_info.ClientInfo) – The client info used to send a user-agent string along with API requests. If
None
, then default info will be used. Generally, you only need to set this if you’re developing your own client library.
- Raises
google.auth.exceptions.MutualTLSChannelError – If mutual TLS transport creation failed for any reason.
- __exit__(type, value, traceback)[source]¶
Releases underlying transport’s resources.
Warning
ONLY use as a context manager if the transport is NOT shared with other clients! Exiting the with block will CLOSE the transport and may cause errors in other clients!
- property api_endpoint¶
Return the API endpoint used by the client instance.
- Returns
The API endpoint used by the client instance.
- Return type
- static attack_path_path(organization: str, simulation: str, valued_resource: str, attack_path: str) str [source]¶
Returns a fully-qualified attack_path string.
- batch_create_resource_value_configs(request: Optional[Union[google.cloud.securitycenter_v2.types.securitycenter_service.BatchCreateResourceValueConfigsRequest, dict]] = None, *, parent: Optional[str] = None, requests: Optional[MutableSequence[google.cloud.securitycenter_v2.types.securitycenter_service.CreateResourceValueConfigRequest]] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.securitycenter_v2.types.securitycenter_service.BatchCreateResourceValueConfigsResponse [source]¶
Creates a ResourceValueConfig for an organization. Maps user’s tags to difference resource values for use by the attack path simulation.
# 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_v2 def sample_batch_create_resource_value_configs(): # Create a client client = securitycenter_v2.SecurityCenterClient() # Initialize request argument(s) requests = securitycenter_v2.CreateResourceValueConfigRequest() requests.parent = "parent_value" request = securitycenter_v2.BatchCreateResourceValueConfigsRequest( parent="parent_value", requests=requests, ) # Make the request response = client.batch_create_resource_value_configs(request=request) # Handle the response print(response)
- Parameters
request (Union[google.cloud.securitycenter_v2.types.BatchCreateResourceValueConfigsRequest, dict]) – The request object. Request message to create multiple resource value configs
parent (str) –
Required. Resource name of the new ResourceValueConfig’s parent. The parent field in the CreateResourceValueConfigRequest messages must either be empty or match this field.
This corresponds to the
parent
field on therequest
instance; ifrequest
is provided, this should not be set.requests (MutableSequence[google.cloud.securitycenter_v2.types.CreateResourceValueConfigRequest]) –
Required. The resource value configs to be created.
This corresponds to the
requests
field on therequest
instance; ifrequest
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
Response message for BatchCreateResourceValueConfigs
- Return type
google.cloud.securitycenter_v2.types.BatchCreateResourceValueConfigsResponse
- static big_query_export_path(organization: str, location: str, export: str) str [source]¶
Returns a fully-qualified big_query_export string.
- bulk_mute_findings(request: Optional[Union[google.cloud.securitycenter_v2.types.securitycenter_service.BulkMuteFindingsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.api_core.operation.Operation [source]¶
Kicks off an LRO to bulk mute findings for a parent based on a filter. If no location is specified, findings are muted in global. 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_v2 def sample_bulk_mute_findings(): # Create a client client = securitycenter_v2.SecurityCenterClient() # Initialize request argument(s) request = securitycenter_v2.BulkMuteFindingsRequest( parent="parent_value", ) # Make the request operation = client.bulk_mute_findings(request=request) print("Waiting for operation to complete...") response = operation.result() # Handle the response print(response)
- Parameters
request (Union[google.cloud.securitycenter_v2.types.BulkMuteFindingsRequest, dict]) –
The request object. Request message for bulk findings update. Note:
- If multiple bulk update requests
match the same resource, the order in which they get executed is not defined.
- 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. If no location is specified, findings are updated in global. The following list shows some examples:
organizations/[organization_id]
organizations/[organization_id]/locations/[location_id]
folders/[folder_id]
folders/[folder_id]/locations/[location_id]
projects/[project_id]
projects/[project_id]/locations/[location_id]
This corresponds to the
parent
field on therequest
instance; ifrequest
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
An object representing a long-running operation.
The result type for the operation will be
google.cloud.securitycenter_v2.types.BulkMuteFindingsResponse
The response to a BulkMute request. Contains the LRO information.- Return type
- cancel_operation(request: Optional[google.longrunning.operations_pb2.CancelOperationRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) None [source]¶
Starts asynchronous cancellation on a long-running operation.
The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn’t support this method, it returns google.rpc.Code.UNIMPLEMENTED.
- Parameters
request (
CancelOperationRequest
) – The request object. Request message for CancelOperation method.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
None
- static common_billing_account_path(billing_account: str) str [source]¶
Returns a fully-qualified billing_account string.
- static common_location_path(project: str, location: str) str [source]¶
Returns a fully-qualified location string.
- static common_organization_path(organization: str) str [source]¶
Returns a fully-qualified organization string.
- create_big_query_export(request: Optional[Union[google.cloud.securitycenter_v2.types.securitycenter_service.CreateBigQueryExportRequest, dict]] = None, *, parent: Optional[str] = None, big_query_export: Optional[google.cloud.securitycenter_v2.types.bigquery_export.BigQueryExport] = None, big_query_export_id: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.securitycenter_v2.types.bigquery_export.BigQueryExport [source]¶
Creates a BigQuery 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_v2 def sample_create_big_query_export(): # Create a client client = securitycenter_v2.SecurityCenterClient() # Initialize request argument(s) request = securitycenter_v2.CreateBigQueryExportRequest( parent="parent_value", big_query_export_id="big_query_export_id_value", ) # Make the request response = client.create_big_query_export(request=request) # Handle the response print(response)
- Parameters
request (Union[google.cloud.securitycenter_v2.types.CreateBigQueryExportRequest, dict]) – The request object. Request message for creating a BigQuery export.
parent (str) –
Required. The name of the parent resource of the new BigQuery export. Its format is
organizations/[organization_id]/locations/[location_id]
,folders/[folder_id]/locations/[location_id]
, orprojects/[project_id]/locations/[location_id]
.This corresponds to the
parent
field on therequest
instance; ifrequest
is provided, this should not be set.big_query_export (google.cloud.securitycenter_v2.types.BigQueryExport) –
Required. The BigQuery export being created.
This corresponds to the
big_query_export
field on therequest
instance; ifrequest
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 only lowercase letters, numbers, and hyphens, must start with a letter, must end with either a letter or a number, and must be 63 characters or less.
This corresponds to the
big_query_export_id
field on therequest
instance; ifrequest
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
Configures how to deliver Findings to BigQuery Instance.
- Return type
- create_finding(request: Optional[Union[google.cloud.securitycenter_v2.types.securitycenter_service.CreateFindingRequest, dict]] = None, *, parent: Optional[str] = None, finding: Optional[google.cloud.securitycenter_v2.types.finding.Finding] = None, finding_id: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.securitycenter_v2.types.finding.Finding [source]¶
Creates a finding in a location. 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_v2 def sample_create_finding(): # Create a client client = securitycenter_v2.SecurityCenterClient() # Initialize request argument(s) request = securitycenter_v2.CreateFindingRequest( parent="parent_value", finding_id="finding_id_value", ) # Make the request response = client.create_finding(request=request) # Handle the response print(response)
- Parameters
request (Union[google.cloud.securitycenter_v2.types.CreateFindingRequest, dict]) – The request object. Request message for creating a finding.
parent (str) –
Required. Resource name of the new finding’s parent. The following list shows some examples of the format: +
organizations/[organization_id]/sources/[source_id]
+organizations/[organization_id]/sources/[source_id]/locations/[location_id]
This corresponds to the
parent
field on therequest
instance; ifrequest
is provided, this should not be set.finding (google.cloud.securitycenter_v2.types.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 therequest
instance; ifrequest
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 therequest
instance; ifrequest
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
Security 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.
- Return type
- create_mute_config(request: Optional[Union[google.cloud.securitycenter_v2.types.securitycenter_service.CreateMuteConfigRequest, dict]] = None, *, parent: Optional[str] = None, mute_config: Optional[google.cloud.securitycenter_v2.types.mute_config.MuteConfig] = None, mute_config_id: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.securitycenter_v2.types.mute_config.MuteConfig [source]¶
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_v2 def sample_create_mute_config(): # Create a client client = securitycenter_v2.SecurityCenterClient() # Initialize request argument(s) mute_config = securitycenter_v2.MuteConfig() mute_config.filter = "filter_value" mute_config.type_ = "DYNAMIC" request = securitycenter_v2.CreateMuteConfigRequest( parent="parent_value", mute_config=mute_config, mute_config_id="mute_config_id_value", ) # Make the request response = client.create_mute_config(request=request) # Handle the response print(response)
- Parameters
request (Union[google.cloud.securitycenter_v2.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]/locations/[location_id]
,folders/[folder_id]/locations/[location_id]
, orprojects/[project_id]/locations/[location_id]
.This corresponds to the
parent
field on therequest
instance; ifrequest
is provided, this should not be set.mute_config (google.cloud.securitycenter_v2.types.MuteConfig) –
Required. The mute config being created.
This corresponds to the
mute_config
field on therequest
instance; ifrequest
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 only lowercase letters, numbers, and hyphens, must start with a letter, must end with either a letter or a number, and must be 63 characters or less.
This corresponds to the
mute_config_id
field on therequest
instance; ifrequest
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
A mute config is a Cloud SCC resource that contains the configuration to mute create/update events of findings.
- Return type
- create_notification_config(request: Optional[Union[google.cloud.securitycenter_v2.types.securitycenter_service.CreateNotificationConfigRequest, dict]] = None, *, parent: Optional[str] = None, notification_config: Optional[google.cloud.securitycenter_v2.types.notification_config.NotificationConfig] = None, config_id: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.securitycenter_v2.types.notification_config.NotificationConfig [source]¶
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_v2 def sample_create_notification_config(): # Create a client client = securitycenter_v2.SecurityCenterClient() # Initialize request argument(s) request = securitycenter_v2.CreateNotificationConfigRequest( parent="parent_value", config_id="config_id_value", ) # Make the request response = client.create_notification_config(request=request) # Handle the response print(response)
- Parameters
request (Union[google.cloud.securitycenter_v2.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]/locations/[location_id]
,folders/[folder_id]/locations/[location_id]
, orprojects/[project_id]/locations/[location_id]
.This corresponds to the
parent
field on therequest
instance; ifrequest
is provided, this should not be set.notification_config (google.cloud.securitycenter_v2.types.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 therequest
instance; ifrequest
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 contain alphanumeric characters, underscores, or hyphens only.
This corresponds to the
config_id
field on therequest
instance; ifrequest
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
Cloud 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.
- Return type
- create_source(request: Optional[Union[google.cloud.securitycenter_v2.types.securitycenter_service.CreateSourceRequest, dict]] = None, *, parent: Optional[str] = None, source: Optional[google.cloud.securitycenter_v2.types.source.Source] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.securitycenter_v2.types.source.Source [source]¶
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_v2 def sample_create_source(): # Create a client client = securitycenter_v2.SecurityCenterClient() # Initialize request argument(s) request = securitycenter_v2.CreateSourceRequest( parent="parent_value", ) # Make the request response = client.create_source(request=request) # Handle the response print(response)
- Parameters
request (Union[google.cloud.securitycenter_v2.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 therequest
instance; ifrequest
is provided, this should not be set.source (google.cloud.securitycenter_v2.types.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 therequest
instance; ifrequest
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
Security 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.
- Return type
- delete_big_query_export(request: Optional[Union[google.cloud.securitycenter_v2.types.securitycenter_service.DeleteBigQueryExportRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) None [source]¶
Deletes an existing BigQuery 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_v2 def sample_delete_big_query_export(): # Create a client client = securitycenter_v2.SecurityCenterClient() # Initialize request argument(s) request = securitycenter_v2.DeleteBigQueryExportRequest( name="name_value", ) # Make the request client.delete_big_query_export(request=request)
- Parameters
request (Union[google.cloud.securitycenter_v2.types.DeleteBigQueryExportRequest, dict]) – The request object. Request message for deleting a BigQuery export.
name (str) –
Required. The name of the BigQuery export to delete. The following list shows some examples of the format:
organizations/{organization}/locations/{location}/bigQueryExports/{export_id}
folders/{folder}/locations/{location}/bigQueryExports/{export_id}
projects/{project}/locations/{location}/bigQueryExports/{export_id}
This corresponds to the
name
field on therequest
instance; ifrequest
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(request: Optional[Union[google.cloud.securitycenter_v2.types.securitycenter_service.DeleteMuteConfigRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) None [source]¶
Deletes an existing mute config. If no location is specified, default is global.
# 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_v2 def sample_delete_mute_config(): # Create a client client = securitycenter_v2.SecurityCenterClient() # Initialize request argument(s) request = securitycenter_v2.DeleteMuteConfigRequest( name="name_value", ) # Make the request client.delete_mute_config(request=request)
- Parameters
request (Union[google.cloud.securitycenter_v2.types.DeleteMuteConfigRequest, dict]) – The request object. Request message for deleting a mute config. If no location is specified, default is global.
name (str) –
Required. Name of the mute config to delete. The following list shows some examples of the format:
organizations/{organization}/muteConfigs/{config_id}
organizations/{organization}/locations/{location}/muteConfigs/{config_id}
folders/{folder}/muteConfigs/{config_id}
folders/{folder}/locations/{location}/muteConfigs/{config_id}
projects/{project}/muteConfigs/{config_id}
projects/{project}/locations/{location}/muteConfigs/{config_id}
This corresponds to the
name
field on therequest
instance; ifrequest
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(request: Optional[Union[google.cloud.securitycenter_v2.types.securitycenter_service.DeleteNotificationConfigRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) None [source]¶
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_v2 def sample_delete_notification_config(): # Create a client client = securitycenter_v2.SecurityCenterClient() # Initialize request argument(s) request = securitycenter_v2.DeleteNotificationConfigRequest( name="name_value", ) # Make the request client.delete_notification_config(request=request)
- Parameters
request (Union[google.cloud.securitycenter_v2.types.DeleteNotificationConfigRequest, dict]) – The request object. Request message for deleting a notification config.
name (str) –
Required. Name of the notification config to delete. The following list shows some examples of the format:
organizations/[organization_id]/locations/[location_id]/notificationConfigs/[config_id]
+folders/[folder_id]/locations/[location_id]notificationConfigs/[config_id]
+projects/[project_id]/locations/[location_id]notificationConfigs/[config_id]
This corresponds to the
name
field on therequest
instance; ifrequest
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_operation(request: Optional[google.longrunning.operations_pb2.DeleteOperationRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) None [source]¶
Deletes a long-running operation.
This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn’t support this method, it returns google.rpc.Code.UNIMPLEMENTED.
- Parameters
request (
DeleteOperationRequest
) – The request object. Request message for DeleteOperation method.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
None
- delete_resource_value_config(request: Optional[Union[google.cloud.securitycenter_v2.types.securitycenter_service.DeleteResourceValueConfigRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) None [source]¶
Deletes a ResourceValueConfig.
# 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_v2 def sample_delete_resource_value_config(): # Create a client client = securitycenter_v2.SecurityCenterClient() # Initialize request argument(s) request = securitycenter_v2.DeleteResourceValueConfigRequest( name="name_value", ) # Make the request client.delete_resource_value_config(request=request)
- Parameters
request (Union[google.cloud.securitycenter_v2.types.DeleteResourceValueConfigRequest, dict]) – The request object. Request message to delete resource value config
name (str) –
Required. Name of the ResourceValueConfig to delete
This corresponds to the
name
field on therequest
instance; ifrequest
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.
- static dlp_job_path(project: str, dlp_job: str) str [source]¶
Returns a fully-qualified dlp_job string.
- static external_system_path(organization: str, source: str, finding: str, externalsystem: str) str [source]¶
Returns a fully-qualified external_system string.
- static finding_path(organization: str, source: str, finding: str) str [source]¶
Returns a fully-qualified finding string.
- classmethod from_service_account_file(filename: str, *args, **kwargs)[source]¶
- Creates an instance of this client using the provided credentials
file.
- Parameters
filename (str) – The path to the service account private key json file.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.
- Returns
The constructed client.
- Return type
- classmethod from_service_account_info(info: dict, *args, **kwargs)[source]¶
- Creates an instance of this client using the provided credentials
info.
- Parameters
info (dict) – The service account private key info.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.
- Returns
The constructed client.
- Return type
- classmethod from_service_account_json(filename: str, *args, **kwargs)¶
- Creates an instance of this client using the provided credentials
file.
- Parameters
filename (str) – The path to the service account private key json file.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.
- Returns
The constructed client.
- Return type
- get_big_query_export(request: Optional[Union[google.cloud.securitycenter_v2.types.securitycenter_service.GetBigQueryExportRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.securitycenter_v2.types.bigquery_export.BigQueryExport [source]¶
Gets a BigQuery 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_v2 def sample_get_big_query_export(): # Create a client client = securitycenter_v2.SecurityCenterClient() # Initialize request argument(s) request = securitycenter_v2.GetBigQueryExportRequest( name="name_value", ) # Make the request response = client.get_big_query_export(request=request) # Handle the response print(response)
- Parameters
request (Union[google.cloud.securitycenter_v2.types.GetBigQueryExportRequest, dict]) – The request object. Request message for retrieving a BigQuery export.
name (str) –
Required. Name of the BigQuery export to retrieve. The following list shows some examples of the format:
organizations/{organization}/locations/{location}/bigQueryExports/{export_id}
folders/{folder}/locations/{location}/bigQueryExports/{export_id}
projects/{project}locations/{location}//bigQueryExports/{export_id}
This corresponds to the
name
field on therequest
instance; ifrequest
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
Configures how to deliver Findings to BigQuery Instance.
- Return type
- get_iam_policy(request: Optional[Union[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest, dict]] = None, *, resource: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.iam.v1.policy_pb2.Policy [source]¶
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_v2 from google.iam.v1 import iam_policy_pb2 # type: ignore def sample_get_iam_policy(): # Create a client client = securitycenter_v2.SecurityCenterClient() # Initialize request argument(s) request = iam_policy_pb2.GetIamPolicyRequest( resource="resource_value", ) # Make the request response = client.get_iam_policy(request=request) # Handle the response print(response)
- Parameters
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 therequest
instance; ifrequest
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
- An 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](https://cloud.google.com/iam/docs/).
- Return type
google.iam.v1.policy_pb2.Policy
- classmethod get_mtls_endpoint_and_cert_source(client_options: Optional[google.api_core.client_options.ClientOptions] = None)[source]¶
Deprecated. 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 variable 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.
- Parameters
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.
- Returns
- returns the API endpoint and the
client cert source to use.
- Return type
- Raises
google.auth.exceptions.MutualTLSChannelError – If any errors happen.
- get_mute_config(request: Optional[Union[google.cloud.securitycenter_v2.types.securitycenter_service.GetMuteConfigRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.securitycenter_v2.types.mute_config.MuteConfig [source]¶
Gets a mute config. If no location is specified, default is global.
# 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_v2 def sample_get_mute_config(): # Create a client client = securitycenter_v2.SecurityCenterClient() # Initialize request argument(s) request = securitycenter_v2.GetMuteConfigRequest( name="name_value", ) # Make the request response = client.get_mute_config(request=request) # Handle the response print(response)
- Parameters
request (Union[google.cloud.securitycenter_v2.types.GetMuteConfigRequest, dict]) – The request object. Request message for retrieving a mute config. If no location is specified, default is global.
name (str) –
Required. Name of the mute config to retrieve. The following list shows some examples of the format:
organizations/{organization}/muteConfigs/{config_id}
organizations/{organization}/locations/{location}/muteConfigs/{config_id}
folders/{folder}/muteConfigs/{config_id}
folders/{folder}/locations/{location}/muteConfigs/{config_id}
projects/{project}/muteConfigs/{config_id}
projects/{project}/locations/{location}/muteConfigs/{config_id}
This corresponds to the
name
field on therequest
instance; ifrequest
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
A mute config is a Cloud SCC resource that contains the configuration to mute create/update events of findings.
- Return type
- get_notification_config(request: Optional[Union[google.cloud.securitycenter_v2.types.securitycenter_service.GetNotificationConfigRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.securitycenter_v2.types.notification_config.NotificationConfig [source]¶
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_v2 def sample_get_notification_config(): # Create a client client = securitycenter_v2.SecurityCenterClient() # Initialize request argument(s) request = securitycenter_v2.GetNotificationConfigRequest( name="name_value", ) # Make the request response = client.get_notification_config(request=request) # Handle the response print(response)
- Parameters
request (Union[google.cloud.securitycenter_v2.types.GetNotificationConfigRequest, dict]) – The request object. Request message for getting a notification config.
name (str) –
Required. Name of the notification config to get. The following list shows some examples of the format:
organizations/[organization_id]/locations/[location_id]/notificationConfigs/[config_id]
+folders/[folder_id]/locations/[location_id]/notificationConfigs/[config_id]
+projects/[project_id]/locations/[location_id]/notificationConfigs/[config_id]
This corresponds to the
name
field on therequest
instance; ifrequest
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
Cloud 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.
- Return type
- get_operation(request: Optional[google.longrunning.operations_pb2.GetOperationRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.longrunning.operations_pb2.Operation [source]¶
Gets the latest state of a long-running operation.
- Parameters
request (
GetOperationRequest
) – The request object. Request message for GetOperation method.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
An
Operation
object.- Return type
Operation
- get_resource_value_config(request: Optional[Union[google.cloud.securitycenter_v2.types.securitycenter_service.GetResourceValueConfigRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.securitycenter_v2.types.resource_value_config.ResourceValueConfig [source]¶
Gets a ResourceValueConfig.
# 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_v2 def sample_get_resource_value_config(): # Create a client client = securitycenter_v2.SecurityCenterClient() # Initialize request argument(s) request = securitycenter_v2.GetResourceValueConfigRequest( name="name_value", ) # Make the request response = client.get_resource_value_config(request=request) # Handle the response print(response)
- Parameters
request (Union[google.cloud.securitycenter_v2.types.GetResourceValueConfigRequest, dict]) – The request object. Request message to get resource value config
name (str) –
Required. Name of the resource value config to retrieve. Its format is organizations/{organization}/resourceValueConfigs/{config_id}.
This corresponds to the
name
field on therequest
instance; ifrequest
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
A resource value configuration (RVC) is a mapping configuration of user’s resources to resource values. Used in Attack path simulations.
- Return type
- get_simulation(request: Optional[Union[google.cloud.securitycenter_v2.types.securitycenter_service.GetSimulationRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.securitycenter_v2.types.simulation.Simulation [source]¶
Get the simulation by name or the latest simulation for the given 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_v2 def sample_get_simulation(): # Create a client client = securitycenter_v2.SecurityCenterClient() # Initialize request argument(s) request = securitycenter_v2.GetSimulationRequest( name="name_value", ) # Make the request response = client.get_simulation(request=request) # Handle the response print(response)
- Parameters
request (Union[google.cloud.securitycenter_v2.types.GetSimulationRequest, dict]) – The request object. Request message for getting simulation. Simulation name can include “latest” to retrieve the latest simulation For example, “organizations/123/simulations/latest”.
name (str) –
Required. The organization name or simulation name of this simulation
Valid format:
organizations/{organization}/simulations/latest
organizations/{organization}/simulations/{simulation}
This corresponds to the
name
field on therequest
instance; ifrequest
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
Attack path simulation
- Return type
- get_source(request: Optional[Union[google.cloud.securitycenter_v2.types.securitycenter_service.GetSourceRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.securitycenter_v2.types.source.Source [source]¶
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_v2 def sample_get_source(): # Create a client client = securitycenter_v2.SecurityCenterClient() # Initialize request argument(s) request = securitycenter_v2.GetSourceRequest( name="name_value", ) # Make the request response = client.get_source(request=request) # Handle the response print(response)
- Parameters
request (Union[google.cloud.securitycenter_v2.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 therequest
instance; ifrequest
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
Security 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.
- Return type
- get_valued_resource(request: Optional[Union[google.cloud.securitycenter_v2.types.securitycenter_service.GetValuedResourceRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.securitycenter_v2.types.valued_resource.ValuedResource [source]¶
Get the valued resource by name
# 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_v2 def sample_get_valued_resource(): # Create a client client = securitycenter_v2.SecurityCenterClient() # Initialize request argument(s) request = securitycenter_v2.GetValuedResourceRequest( name="name_value", ) # Make the request response = client.get_valued_resource(request=request) # Handle the response print(response)
- Parameters
request (Union[google.cloud.securitycenter_v2.types.GetValuedResourceRequest, dict]) – The request object. Request message for getting a valued resource.
name (str) –
Required. The name of this valued resource
Valid format:
organizations/{organization}/simulations/{simulation}/valuedResources/{valued_resource}
This corresponds to the
name
field on therequest
instance; ifrequest
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
A resource that is determined to have value to a user’s system
- Return type
- group_findings(request: Optional[Union[google.cloud.securitycenter_v2.types.securitycenter_service.GroupFindingsRequest, dict]] = None, *, parent: Optional[str] = None, group_by: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.securitycenter_v2.services.security_center.pagers.GroupFindingsPager [source]¶
Filters an organization or source’s findings and groups them by their specified properties in a location. If no location is specified, findings are assumed to be in global
To group across all sources provide a
-
as the source id. The following list shows some examples:/v2/organizations/{organization_id}/sources/-/findings
/v2/organizations/{organization_id}/sources/-/locations/{location_id}/findings
/v2/folders/{folder_id}/sources/-/findings
/v2/folders/{folder_id}/sources/-/locations/{location_id}/findings
/v2/projects/{project_id}/sources/-/findings
/v2/projects/{project_id}/sources/-/locations/{location_id}/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_v2 def sample_group_findings(): # Create a client client = securitycenter_v2.SecurityCenterClient() # Initialize request argument(s) request = securitycenter_v2.GroupFindingsRequest( parent="parent_value", group_by="group_by_value", ) # Make the request page_result = client.group_findings(request=request) # Handle the response for response in page_result: print(response)
- Parameters
request (Union[google.cloud.securitycenter_v2.types.GroupFindingsRequest, dict]) – The request object. Request message for grouping by findings.
parent (str) –
Required. Name of the source to groupBy. If no location is specified, finding is assumed to be in global. The following list shows some examples:
organizations/[organization_id]/sources/[source_id]
organizations/[organization_id]/sources/[source_id]/locations/[location_id]
folders/[folder_id]/sources/[source_id]
folders/[folder_id]/sources/[source_id]/locations/[location_id]
projects/[project_id]/sources/[source_id]
projects/[project_id]/sources/[source_id]/locations/[location_id]
To groupBy across all sources provide a source_id of
-
. The following list shows some examples:organizations/{organization_id}/sources/-
organizations/{organization_id}/sources/-/locations/[location_id]
folders/{folder_id}/sources/-
folders/{folder_id}/sources/-/locations/[location_id]
projects/{project_id}/sources/-
projects/{project_id}/sources/-/locations/[location_id]
This corresponds to the
parent
field on therequest
instance; ifrequest
is provided, this should not be set.group_by (str) –
Required. Expression that defines what assets fields to use for grouping. The string value should follow SQL syntax: comma separated list of fields. For example: “parent,resource_name”.
This corresponds to the
group_by
field on therequest
instance; ifrequest
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
Response message for group by findings. Iterating over this object will yield results and resolve additional pages automatically.
- Return type
google.cloud.securitycenter_v2.services.security_center.pagers.GroupFindingsPager
- list_attack_paths(request: Optional[Union[google.cloud.securitycenter_v2.types.securitycenter_service.ListAttackPathsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.securitycenter_v2.services.security_center.pagers.ListAttackPathsPager [source]¶
Lists the attack paths for a set of simulation results or valued resources and filter.
# 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_v2 def sample_list_attack_paths(): # Create a client client = securitycenter_v2.SecurityCenterClient() # Initialize request argument(s) request = securitycenter_v2.ListAttackPathsRequest( parent="parent_value", ) # Make the request page_result = client.list_attack_paths(request=request) # Handle the response for response in page_result: print(response)
- Parameters
request (Union[google.cloud.securitycenter_v2.types.ListAttackPathsRequest, dict]) – The request object. Request message for listing the attack paths for a given simulation or valued resource.
parent (str) –
Required. Name of parent to list attack paths.
Valid formats:
organizations/{organization}
,organizations/{organization}/simulations/{simulation}
organizations/{organization}/simulations/{simulation}/attackExposureResults/{attack_exposure_result_v2}
organizations/{organization}/simulations/{simulation}/valuedResources/{valued_resource}
This corresponds to the
parent
field on therequest
instance; ifrequest
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
Response message for listing the attack paths for a given simulation or valued resource.
Iterating over this object will yield results and resolve additional pages automatically.
- Return type
google.cloud.securitycenter_v2.services.security_center.pagers.ListAttackPathsPager
- list_big_query_exports(request: Optional[Union[google.cloud.securitycenter_v2.types.securitycenter_service.ListBigQueryExportsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.securitycenter_v2.services.security_center.pagers.ListBigQueryExportsPager [source]¶
Lists BigQuery exports. Note that when requesting BigQuery exports at a given level all exports under that level are also returned e.g. if requesting BigQuery exports under a folder, then all BigQuery exports immediately under the folder plus the ones created under the projects within the folder are returned.
# 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_v2 def sample_list_big_query_exports(): # Create a client client = securitycenter_v2.SecurityCenterClient() # Initialize request argument(s) request = securitycenter_v2.ListBigQueryExportsRequest( parent="parent_value", ) # Make the request page_result = client.list_big_query_exports(request=request) # Handle the response for response in page_result: print(response)
- Parameters
request (Union[google.cloud.securitycenter_v2.types.ListBigQueryExportsRequest, dict]) – The request object. Request message for listing BigQuery exports at a given scope e.g. organization, folder or project.
parent (str) –
Required. The parent, which owns the collection of BigQuery exports. Its format is
organizations/[organization_id]/locations/[location_id]
,folders/[folder_id]/locations/[location_id]
, orprojects/[project_id]/locations/[location_id]
.This corresponds to the
parent
field on therequest
instance; ifrequest
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
Response message for listing BigQuery exports. Iterating over this object will yield results and resolve additional pages automatically.
- Return type
google.cloud.securitycenter_v2.services.security_center.pagers.ListBigQueryExportsPager
- list_findings(request: Optional[Union[google.cloud.securitycenter_v2.types.securitycenter_service.ListFindingsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.securitycenter_v2.services.security_center.pagers.ListFindingsPager [source]¶
Lists an organization or source’s findings.
To list across all sources for a given location provide a
-
as the source id. If no location is specified, finding are assumed to be in global. The following list shows some examples:/v2/organizations/{organization_id}/sources/-/findings
/v2/organizations/{organization_id}/sources/-/locations/{location_id}/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_v2 def sample_list_findings(): # Create a client client = securitycenter_v2.SecurityCenterClient() # Initialize request argument(s) request = securitycenter_v2.ListFindingsRequest( parent="parent_value", ) # Make the request page_result = client.list_findings(request=request) # Handle the response for response in page_result: print(response)
- Parameters
request (Union[google.cloud.securitycenter_v2.types.ListFindingsRequest, dict]) – The request object. Request message for listing findings.
parent (str) –
Required. Name of the source the findings belong to. If no location is specified, the default is global. The following list shows some examples:
organizations/[organization_id]/sources/[source_id]
organizations/[organization_id]/sources/[source_id]/locations/[location_id]
folders/[folder_id]/sources/[source_id]
folders/[folder_id]/sources/[source_id]/locations/[location_id]
projects/[project_id]/sources/[source_id]
projects/[project_id]/sources/[source_id]/locations/[location_id]
To list across all sources provide a source_id of
-
. The following list shows some examples:organizations/{organization_id}/sources/-
organizations/{organization_id}/sources/-/locations/{location_id}
folders/{folder_id}/sources/-
folders/{folder_id}/sources/-locations/{location_id}
projects/{projects_id}/sources/-
projects/{projects_id}/sources/-/locations/{location_id}
This corresponds to the
parent
field on therequest
instance; ifrequest
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
Response message for listing findings. Iterating over this object will yield results and resolve additional pages automatically.
- Return type
google.cloud.securitycenter_v2.services.security_center.pagers.ListFindingsPager
- list_mute_configs(request: Optional[Union[google.cloud.securitycenter_v2.types.securitycenter_service.ListMuteConfigsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.securitycenter_v2.services.security_center.pagers.ListMuteConfigsPager [source]¶
Lists mute configs. If no location is specified, default is global.
# 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_v2 def sample_list_mute_configs(): # Create a client client = securitycenter_v2.SecurityCenterClient() # Initialize request argument(s) request = securitycenter_v2.ListMuteConfigsRequest( parent="parent_value", ) # Make the request page_result = client.list_mute_configs(request=request) # Handle the response for response in page_result: print(response)
- Parameters
request (Union[google.cloud.securitycenter_v2.types.ListMuteConfigsRequest, dict]) – The request object. Request message for listing mute configs at a given scope e.g. organization, folder or project. If no location is specified, default is global.
parent (str) –
Required. The parent, which owns the collection of mute configs. Its format is
organizations/[organization_id]", "folders/[folder_id]
,projects/[project_id]
,organizations/[organization_id]/locations/[location_id]
,folders/[folder_id]/locations/[location_id]
,projects/[project_id]/locations/[location_id]
.This corresponds to the
parent
field on therequest
instance; ifrequest
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
Response message for listing mute configs. Iterating over this object will yield results and resolve additional pages automatically.
- Return type
google.cloud.securitycenter_v2.services.security_center.pagers.ListMuteConfigsPager
- list_notification_configs(request: Optional[Union[google.cloud.securitycenter_v2.types.securitycenter_service.ListNotificationConfigsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.securitycenter_v2.services.security_center.pagers.ListNotificationConfigsPager [source]¶
Lists notification configs.
# 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_v2 def sample_list_notification_configs(): # Create a client client = securitycenter_v2.SecurityCenterClient() # Initialize request argument(s) request = securitycenter_v2.ListNotificationConfigsRequest( parent="parent_value", ) # Make the request page_result = client.list_notification_configs(request=request) # Handle the response for response in page_result: print(response)
- Parameters
request (Union[google.cloud.securitycenter_v2.types.ListNotificationConfigsRequest, dict]) – The request object. Request message for listing notification configs.
parent (str) –
Required. The name of the parent in which to list the notification configurations. Its format is “organizations/[organization_id]/locations/[location_id]”, “folders/[folder_id]/locations/[location_id]”, or “projects/[project_id]/locations/[location_id]”.
This corresponds to the
parent
field on therequest
instance; ifrequest
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
Response message for listing notification configs. Iterating over this object will yield results and resolve additional pages automatically.
- Return type
google.cloud.securitycenter_v2.services.security_center.pagers.ListNotificationConfigsPager
- list_operations(request: Optional[google.longrunning.operations_pb2.ListOperationsRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.longrunning.operations_pb2.ListOperationsResponse [source]¶
Lists operations that match the specified filter in the request.
- Parameters
request (
ListOperationsRequest
) – The request object. Request message for ListOperations method.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
Response message for
ListOperations
method.- Return type
ListOperationsResponse
- list_resource_value_configs(request: Optional[Union[google.cloud.securitycenter_v2.types.securitycenter_service.ListResourceValueConfigsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.securitycenter_v2.services.security_center.pagers.ListResourceValueConfigsPager [source]¶
Lists all ResourceValueConfigs.
# 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_v2 def sample_list_resource_value_configs(): # Create a client client = securitycenter_v2.SecurityCenterClient() # Initialize request argument(s) request = securitycenter_v2.ListResourceValueConfigsRequest( parent="parent_value", ) # Make the request page_result = client.list_resource_value_configs(request=request) # Handle the response for response in page_result: print(response)
- Parameters
request (Union[google.cloud.securitycenter_v2.types.ListResourceValueConfigsRequest, dict]) – The request object. Request message to list resource value configs of a parent
parent (str) –
Required. The parent, which owns the collection of resource value configs. Its format is
organizations/[organization_id]
This corresponds to the
parent
field on therequest
instance; ifrequest
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
Response message to list resource value configs Iterating over this object will yield results and resolve additional pages automatically.
- Return type
google.cloud.securitycenter_v2.services.security_center.pagers.ListResourceValueConfigsPager
- list_sources(request: Optional[Union[google.cloud.securitycenter_v2.types.securitycenter_service.ListSourcesRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.securitycenter_v2.services.security_center.pagers.ListSourcesPager [source]¶
Lists all sources belonging to 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_v2 def sample_list_sources(): # Create a client client = securitycenter_v2.SecurityCenterClient() # Initialize request argument(s) request = securitycenter_v2.ListSourcesRequest( parent="parent_value", ) # Make the request page_result = client.list_sources(request=request) # Handle the response for response in page_result: print(response)
- Parameters
request (Union[google.cloud.securitycenter_v2.types.ListSourcesRequest, dict]) – The request object. Request message for listing sources.
parent (str) –
Required. Resource name of the parent of sources to list. Its format should be
organizations/[organization_id]
,folders/[folder_id]
, orprojects/[project_id]
.This corresponds to the
parent
field on therequest
instance; ifrequest
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
Response message for listing sources.
Iterating over this object will yield results and resolve additional pages automatically.
- Return type
google.cloud.securitycenter_v2.services.security_center.pagers.ListSourcesPager
- list_valued_resources(request: Optional[Union[google.cloud.securitycenter_v2.types.securitycenter_service.ListValuedResourcesRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.securitycenter_v2.services.security_center.pagers.ListValuedResourcesPager [source]¶
Lists the valued resources for a set of simulation results and filter.
# 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_v2 def sample_list_valued_resources(): # Create a client client = securitycenter_v2.SecurityCenterClient() # Initialize request argument(s) request = securitycenter_v2.ListValuedResourcesRequest( parent="parent_value", ) # Make the request page_result = client.list_valued_resources(request=request) # Handle the response for response in page_result: print(response)
- Parameters
request (Union[google.cloud.securitycenter_v2.types.ListValuedResourcesRequest, dict]) – The request object. Request message for listing the valued resources for a given simulation.
parent (str) –
Required. Name of parent to list exposed resources.
Valid formats:
organizations/{organization}
,organizations/{organization}/simulations/{simulation}
organizations/{organization}/simulations/{simulation}/attackExposureResults/{attack_exposure_result_v2}
This corresponds to the
parent
field on therequest
instance; ifrequest
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
Response message for listing the valued resources for a given simulation. Iterating over this object will yield results and resolve additional pages automatically.
- Return type
google.cloud.securitycenter_v2.services.security_center.pagers.ListValuedResourcesPager
- static mute_config_path(organization: str, mute_config: str) str [source]¶
Returns a fully-qualified mute_config string.
- static notification_config_path(organization: str, location: str, notification_config: str) str [source]¶
Returns a fully-qualified notification_config string.
- static parse_attack_path_path(path: str) Dict[str, str] [source]¶
Parses a attack_path path into its component segments.
- static parse_big_query_export_path(path: str) Dict[str, str] [source]¶
Parses a big_query_export path into its component segments.
- static parse_common_billing_account_path(path: str) Dict[str, str] [source]¶
Parse a billing_account path into its component segments.
- static parse_common_folder_path(path: str) Dict[str, str] [source]¶
Parse a folder path into its component segments.
- static parse_common_location_path(path: str) Dict[str, str] [source]¶
Parse a location path into its component segments.
- static parse_common_organization_path(path: str) Dict[str, str] [source]¶
Parse a organization path into its component segments.
- static parse_common_project_path(path: str) Dict[str, str] [source]¶
Parse a project path into its component segments.
- static parse_dlp_job_path(path: str) Dict[str, str] [source]¶
Parses a dlp_job path into its component segments.
- static parse_external_system_path(path: str) Dict[str, str] [source]¶
Parses a external_system path into its component segments.
- static parse_finding_path(path: str) Dict[str, str] [source]¶
Parses a finding path into its component segments.
- static parse_mute_config_path(path: str) Dict[str, str] [source]¶
Parses a mute_config path into its component segments.
- static parse_notification_config_path(path: str) Dict[str, str] [source]¶
Parses a notification_config path into its component segments.
- static parse_policy_path(path: str) Dict[str, str] [source]¶
Parses a policy path into its component segments.
- static parse_resource_value_config_path(path: str) Dict[str, str] [source]¶
Parses a resource_value_config path into its component segments.
- static parse_security_marks_path(path: str) Dict[str, str] [source]¶
Parses a security_marks path into its component segments.
- static parse_simulation_path(path: str) Dict[str, str] [source]¶
Parses a simulation path into its component segments.
- static parse_source_path(path: str) Dict[str, str] [source]¶
Parses a source path into its component segments.
- static parse_table_data_profile_path(path: str) Dict[str, str] [source]¶
Parses a table_data_profile path into its component segments.
- static parse_topic_path(path: str) Dict[str, str] [source]¶
Parses a topic path into its component segments.
- static parse_valued_resource_path(path: str) Dict[str, str] [source]¶
Parses a valued_resource path into its component segments.
- static policy_path(organization: str, constraint_name: str) str [source]¶
Returns a fully-qualified policy string.
- static resource_value_config_path(organization: str, resource_value_config: str) str [source]¶
Returns a fully-qualified resource_value_config string.
- static security_marks_path(organization: str, asset: str) str [source]¶
Returns a fully-qualified security_marks string.
- set_finding_state(request: Optional[Union[google.cloud.securitycenter_v2.types.securitycenter_service.SetFindingStateRequest, dict]] = None, *, name: Optional[str] = None, state: Optional[google.cloud.securitycenter_v2.types.finding.Finding.State] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.securitycenter_v2.types.finding.Finding [source]¶
Updates the state of a finding. If no location is specified, finding is assumed to be in global
# 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_v2 def sample_set_finding_state(): # Create a client client = securitycenter_v2.SecurityCenterClient() # Initialize request argument(s) request = securitycenter_v2.SetFindingStateRequest( name="name_value", state="INACTIVE", ) # Make the request response = client.set_finding_state(request=request) # Handle the response print(response)
- Parameters
request (Union[google.cloud.securitycenter_v2.types.SetFindingStateRequest, dict]) – The request object. Request message for updating a finding’s state.
name (str) –
Required. The relative resource name of the finding. If no location is specified, finding is assumed to be in global. The following list shows some examples:
organizations/{organization_id}/sources/{source_id}/findings/{finding_id}
+organizations/{organization_id}/sources/{source_id}/locations/{location_id}/findings/{finding_id}
folders/{folder_id}/sources/{source_id}/findings/{finding_id}
folders/{folder_id}/sources/{source_id}/locations/{location_id}/findings/{finding_id}
projects/{project_id}/sources/{source_id}/findings/{finding_id}
projects/{project_id}/sources/{source_id}/locations/{location_id}/findings/{finding_id}
This corresponds to the
name
field on therequest
instance; ifrequest
is provided, this should not be set.state (google.cloud.securitycenter_v2.types.Finding.State) –
Required. The desired State of the finding.
This corresponds to the
state
field on therequest
instance; ifrequest
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
Security 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.
- Return type
- set_iam_policy(request: Optional[Union[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest, dict]] = None, *, resource: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.iam.v1.policy_pb2.Policy [source]¶
Sets 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_v2 from google.iam.v1 import iam_policy_pb2 # type: ignore def sample_set_iam_policy(): # Create a client client = securitycenter_v2.SecurityCenterClient() # Initialize request argument(s) request = iam_policy_pb2.SetIamPolicyRequest( resource="resource_value", ) # Make the request response = client.set_iam_policy(request=request) # Handle the response print(response)
- Parameters
request (Union[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest, dict]) – The request object. Request message for
SetIamPolicy
method.resource (str) –
REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.
This corresponds to the
resource
field on therequest
instance; ifrequest
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
- An 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](https://cloud.google.com/iam/docs/).
- Return type
google.iam.v1.policy_pb2.Policy
- set_mute(request: Optional[Union[google.cloud.securitycenter_v2.types.securitycenter_service.SetMuteRequest, dict]] = None, *, name: Optional[str] = None, mute: Optional[google.cloud.securitycenter_v2.types.finding.Finding.Mute] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.securitycenter_v2.types.finding.Finding [source]¶
Updates the mute state of a finding. If no location is specified, finding is assumed to be in global
# 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_v2 def sample_set_mute(): # Create a client client = securitycenter_v2.SecurityCenterClient() # Initialize request argument(s) request = securitycenter_v2.SetMuteRequest( name="name_value", mute="UNDEFINED", ) # Make the request response = client.set_mute(request=request) # Handle the response print(response)
- Parameters
request (Union[google.cloud.securitycenter_v2.types.SetMuteRequest, dict]) – The request object. Request message for updating a finding’s mute status.
name (str) –
Required. The relative resource name of the finding. If no location is specified, finding is assumed to be in global. The following list shows some examples:
organizations/{organization_id}/sources/{source_id}/findings/{finding_id}
+organizations/{organization_id}/sources/{source_id}/locations/{location_id}/findings/{finding_id}
folders/{folder_id}/sources/{source_id}/findings/{finding_id}
folders/{folder_id}/sources/{source_id}/locations/{location_id}/findings/{finding_id}
projects/{project_id}/sources/{source_id}/findings/{finding_id}
projects/{project_id}/sources/{source_id}/locations/{location_id}/findings/{finding_id}
This corresponds to the
name
field on therequest
instance; ifrequest
is provided, this should not be set.mute (google.cloud.securitycenter_v2.types.Finding.Mute) –
Required. The desired state of the Mute.
This corresponds to the
mute
field on therequest
instance; ifrequest
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
Security 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.
- Return type
- static simulation_path(organization: str, simulation: str) str [source]¶
Returns a fully-qualified simulation string.
- static source_path(organization: str, source: str) str [source]¶
Returns a fully-qualified source string.
- static table_data_profile_path(project: str, table_profile: str) str [source]¶
Returns a fully-qualified table_data_profile string.
- test_iam_permissions(request: Optional[Union[google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest, dict]] = None, *, resource: Optional[str] = None, permissions: Optional[MutableSequence[str]] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse [source]¶
Returns the permissions that a caller has 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_v2 from google.iam.v1 import iam_policy_pb2 # type: ignore def sample_test_iam_permissions(): # Create a client client = securitycenter_v2.SecurityCenterClient() # Initialize request argument(s) request = iam_policy_pb2.TestIamPermissionsRequest( resource="resource_value", permissions=['permissions_value1', 'permissions_value2'], ) # Make the request response = client.test_iam_permissions(request=request) # Handle the response print(response)
- Parameters
request (Union[google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest, dict]) – The request object. Request message for
TestIamPermissions
method.resource (str) –
REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.
This corresponds to the
resource
field on therequest
instance; ifrequest
is provided, this should not be set.permissions (MutableSequence[str]) –
The set of permissions to check for the
resource
. Permissions with wildcards (such as ‘*’ or ‘storage.*’) are not allowed. For more information see IAM Overview.This corresponds to the
permissions
field on therequest
instance; ifrequest
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
Response message for TestIamPermissions method.
- Return type
google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse
- property transport: google.cloud.securitycenter_v2.services.security_center.transports.base.SecurityCenterTransport¶
Returns the transport used by the client instance.
- Returns
- The transport used by the client
instance.
- Return type
SecurityCenterTransport
- property universe_domain: str¶
Return the universe domain used by the client instance.
- Returns
The universe domain used by the client instance.
- Return type
- update_big_query_export(request: Optional[Union[google.cloud.securitycenter_v2.types.securitycenter_service.UpdateBigQueryExportRequest, dict]] = None, *, big_query_export: Optional[google.cloud.securitycenter_v2.types.bigquery_export.BigQueryExport] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.securitycenter_v2.types.bigquery_export.BigQueryExport [source]¶
Updates a BigQuery 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_v2 def sample_update_big_query_export(): # Create a client client = securitycenter_v2.SecurityCenterClient() # Initialize request argument(s) request = securitycenter_v2.UpdateBigQueryExportRequest( ) # Make the request response = client.update_big_query_export(request=request) # Handle the response print(response)
- Parameters
request (Union[google.cloud.securitycenter_v2.types.UpdateBigQueryExportRequest, dict]) – The request object. Request message for updating a BigQuery export.
big_query_export (google.cloud.securitycenter_v2.types.BigQueryExport) –
Required. The BigQuery export being updated.
This corresponds to the
big_query_export
field on therequest
instance; ifrequest
is provided, this should not be set.update_mask (google.protobuf.field_mask_pb2.FieldMask) –
The list of fields to be updated. If empty all mutable fields will be updated.
This corresponds to the
update_mask
field on therequest
instance; ifrequest
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
Configures how to deliver Findings to BigQuery Instance.
- Return type
- update_external_system(request: Optional[Union[google.cloud.securitycenter_v2.types.securitycenter_service.UpdateExternalSystemRequest, dict]] = None, *, external_system: Optional[google.cloud.securitycenter_v2.types.external_system.ExternalSystem] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.securitycenter_v2.types.external_system.ExternalSystem [source]¶
Updates external system. This is for a given finding. If no location is specified, finding is assumed to be in global
# 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_v2 def sample_update_external_system(): # Create a client client = securitycenter_v2.SecurityCenterClient() # Initialize request argument(s) request = securitycenter_v2.UpdateExternalSystemRequest( ) # Make the request response = client.update_external_system(request=request) # Handle the response print(response)
- Parameters
request (Union[google.cloud.securitycenter_v2.types.UpdateExternalSystemRequest, dict]) – The request object. Request message for updating a ExternalSystem resource.
external_system (google.cloud.securitycenter_v2.types.ExternalSystem) –
Required. The external system resource to update.
This corresponds to the
external_system
field on therequest
instance; ifrequest
is provided, this should not be set.update_mask (google.protobuf.field_mask_pb2.FieldMask) –
The FieldMask to use when updating the external system resource. If empty all mutable fields will be updated.
This corresponds to the
update_mask
field on therequest
instance; ifrequest
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
Representation of third party SIEM/SOAR fields within SCC.
- Return type
- update_finding(request: Optional[Union[google.cloud.securitycenter_v2.types.securitycenter_service.UpdateFindingRequest, dict]] = None, *, finding: Optional[google.cloud.securitycenter_v2.types.finding.Finding] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.securitycenter_v2.types.finding.Finding [source]¶
Creates or updates a finding. If no location is specified, finding is assumed to be in global. The corresponding source must exist for a 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_v2 def sample_update_finding(): # Create a client client = securitycenter_v2.SecurityCenterClient() # Initialize request argument(s) request = securitycenter_v2.UpdateFindingRequest( ) # Make the request response = client.update_finding(request=request) # Handle the response print(response)
- Parameters
request (Union[google.cloud.securitycenter_v2.types.UpdateFindingRequest, dict]) – The request object. Request message for updating or creating a finding.
finding (google.cloud.securitycenter_v2.types.Finding) –
Required. The finding resource to update or create if it does not already exist. parent, security_marks, and update_time will be ignored.
In the case of creation, the finding id portion of the name must be alphanumeric and less than or equal to 32 characters and greater than 0 characters in length.
This corresponds to the
finding
field on therequest
instance; ifrequest
is provided, this should not be set.update_mask (google.protobuf.field_mask_pb2.FieldMask) –
The FieldMask to use when updating the finding resource. This field should not be specified when creating a finding.
When updating a finding, an empty mask is treated as updating all mutable fields and replacing source_properties. Individual source_properties can be added/updated by using “source_properties.” in the field mask.
This corresponds to the
update_mask
field on therequest
instance; ifrequest
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
Security 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.
- Return type
- update_mute_config(request: Optional[Union[google.cloud.securitycenter_v2.types.securitycenter_service.UpdateMuteConfigRequest, dict]] = None, *, mute_config: Optional[google.cloud.securitycenter_v2.types.mute_config.MuteConfig] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.securitycenter_v2.types.mute_config.MuteConfig [source]¶
Updates a mute config. If no location is specified, default is global.
# 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_v2 def sample_update_mute_config(): # Create a client client = securitycenter_v2.SecurityCenterClient() # Initialize request argument(s) mute_config = securitycenter_v2.MuteConfig() mute_config.filter = "filter_value" mute_config.type_ = "DYNAMIC" request = securitycenter_v2.UpdateMuteConfigRequest( mute_config=mute_config, ) # Make the request response = client.update_mute_config(request=request) # Handle the response print(response)
- Parameters
request (Union[google.cloud.securitycenter_v2.types.UpdateMuteConfigRequest, dict]) – The request object. Request message for updating a mute config.
mute_config (google.cloud.securitycenter_v2.types.MuteConfig) –
Required. The mute config being updated.
This corresponds to the
mute_config
field on therequest
instance; ifrequest
is provided, this should not be set.update_mask (google.protobuf.field_mask_pb2.FieldMask) –
The list of fields to be updated. If empty all mutable fields will be updated.
This corresponds to the
update_mask
field on therequest
instance; ifrequest
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
A mute config is a Cloud SCC resource that contains the configuration to mute create/update events of findings.
- Return type
- update_notification_config(request: Optional[Union[google.cloud.securitycenter_v2.types.securitycenter_service.UpdateNotificationConfigRequest, dict]] = None, *, notification_config: Optional[google.cloud.securitycenter_v2.types.notification_config.NotificationConfig] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.securitycenter_v2.types.notification_config.NotificationConfig [source]¶
Updates a notification config. The following update fields are allowed: description, pubsub_topic, streaming_config.filter
# 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_v2 def sample_update_notification_config(): # Create a client client = securitycenter_v2.SecurityCenterClient() # Initialize request argument(s) request = securitycenter_v2.UpdateNotificationConfigRequest( ) # Make the request response = client.update_notification_config(request=request) # Handle the response print(response)
- Parameters
request (Union[google.cloud.securitycenter_v2.types.UpdateNotificationConfigRequest, dict]) – The request object. Request message for updating a notification config.
notification_config (google.cloud.securitycenter_v2.types.NotificationConfig) –
Required. The notification config to update.
This corresponds to the
notification_config
field on therequest
instance; ifrequest
is provided, this should not be set.update_mask (google.protobuf.field_mask_pb2.FieldMask) –
The FieldMask to use when updating the notification config. If empty all mutable fields will be updated.
This corresponds to the
update_mask
field on therequest
instance; ifrequest
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
Cloud 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.
- Return type
- update_resource_value_config(request: Optional[Union[google.cloud.securitycenter_v2.types.securitycenter_service.UpdateResourceValueConfigRequest, dict]] = None, *, resource_value_config: Optional[google.cloud.securitycenter_v2.types.resource_value_config.ResourceValueConfig] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.securitycenter_v2.types.resource_value_config.ResourceValueConfig [source]¶
Updates an existing ResourceValueConfigs with new rules.
# 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_v2 def sample_update_resource_value_config(): # Create a client client = securitycenter_v2.SecurityCenterClient() # Initialize request argument(s) request = securitycenter_v2.UpdateResourceValueConfigRequest( ) # Make the request response = client.update_resource_value_config(request=request) # Handle the response print(response)
- Parameters
request (Union[google.cloud.securitycenter_v2.types.UpdateResourceValueConfigRequest, dict]) – The request object. Request message to update resource value config
resource_value_config (google.cloud.securitycenter_v2.types.ResourceValueConfig) –
Required. The resource value config being updated.
This corresponds to the
resource_value_config
field on therequest
instance; ifrequest
is provided, this should not be set.update_mask (google.protobuf.field_mask_pb2.FieldMask) –
The list of fields to be updated. If empty all mutable fields will be updated.
To update nested fields, include the top level field in the mask For example, to update gcp_metadata.resource_type, include the “gcp_metadata” field mask
This corresponds to the
update_mask
field on therequest
instance; ifrequest
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
A resource value configuration (RVC) is a mapping configuration of user’s resources to resource values. Used in Attack path simulations.
- Return type
- update_security_marks(request: Optional[Union[google.cloud.securitycenter_v2.types.securitycenter_service.UpdateSecurityMarksRequest, dict]] = None, *, security_marks: Optional[google.cloud.securitycenter_v2.types.security_marks.SecurityMarks] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.securitycenter_v2.types.security_marks.SecurityMarks [source]¶
Updates security marks. For Finding Security marks, if no location is specified, finding is assumed to be in global. Assets Security Marks can only be accessed through global endpoint.
# 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_v2 def sample_update_security_marks(): # Create a client client = securitycenter_v2.SecurityCenterClient() # Initialize request argument(s) request = securitycenter_v2.UpdateSecurityMarksRequest( ) # Make the request response = client.update_security_marks(request=request) # Handle the response print(response)
- Parameters
request (Union[google.cloud.securitycenter_v2.types.UpdateSecurityMarksRequest, dict]) – The request object. Request message for updating a SecurityMarks resource.
security_marks (google.cloud.securitycenter_v2.types.SecurityMarks) –
Required. The security marks resource to update.
This corresponds to the
security_marks
field on therequest
instance; ifrequest
is provided, this should not be set.update_mask (google.protobuf.field_mask_pb2.FieldMask) –
The FieldMask to use when updating the security marks resource.
The field mask must not contain duplicate fields. If empty or set to “marks”, all marks will be replaced. Individual marks can be updated using “marks.<mark_key>”.
This corresponds to the
update_mask
field on therequest
instance; ifrequest
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
User specified security marks that are attached to the parent Security Command Center resource. Security marks are scoped within a Security Command Center organization – they can be modified and viewed by all users who have proper permissions on the organization.
- Return type
- update_source(request: Optional[Union[google.cloud.securitycenter_v2.types.securitycenter_service.UpdateSourceRequest, dict]] = None, *, source: Optional[google.cloud.securitycenter_v2.types.source.Source] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.securitycenter_v2.types.source.Source [source]¶
Updates 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_v2 def sample_update_source(): # Create a client client = securitycenter_v2.SecurityCenterClient() # Initialize request argument(s) request = securitycenter_v2.UpdateSourceRequest( ) # Make the request response = client.update_source(request=request) # Handle the response print(response)
- Parameters
request (Union[google.cloud.securitycenter_v2.types.UpdateSourceRequest, dict]) – The request object. Request message for updating a source.
source (google.cloud.securitycenter_v2.types.Source) –
Required. The source resource to update.
This corresponds to the
source
field on therequest
instance; ifrequest
is provided, this should not be set.update_mask (google.protobuf.field_mask_pb2.FieldMask) –
The FieldMask to use when updating the source resource. If empty all mutable fields will be updated.
This corresponds to the
update_mask
field on therequest
instance; ifrequest
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
Security 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.
- Return type
- class google.cloud.securitycenter_v2.services.security_center.pagers.GroupFindingsAsyncPager(method: Callable[[...], Awaitable[google.cloud.securitycenter_v2.types.securitycenter_service.GroupFindingsResponse]], request: google.cloud.securitycenter_v2.types.securitycenter_service.GroupFindingsRequest, response: google.cloud.securitycenter_v2.types.securitycenter_service.GroupFindingsResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]¶
A pager for iterating through
group_findings
requests.This class thinly wraps an initial
google.cloud.securitycenter_v2.types.GroupFindingsResponse
object, and provides an__aiter__
method to iterate through itsgroup_by_results
field.If there are more pages, the
__aiter__
method will make additionalGroupFindings
requests and continue to iterate through thegroup_by_results
field on the corresponding responses.All the usual
google.cloud.securitycenter_v2.types.GroupFindingsResponse
attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.Instantiates the pager.
- Parameters
method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.cloud.securitycenter_v2.types.GroupFindingsRequest) – The initial request object.
response (google.cloud.securitycenter_v2.types.GroupFindingsResponse) – The initial response object.
retry (google.api_core.retry.AsyncRetry) – 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.
- class google.cloud.securitycenter_v2.services.security_center.pagers.GroupFindingsPager(method: Callable[[...], google.cloud.securitycenter_v2.types.securitycenter_service.GroupFindingsResponse], request: google.cloud.securitycenter_v2.types.securitycenter_service.GroupFindingsRequest, response: google.cloud.securitycenter_v2.types.securitycenter_service.GroupFindingsResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]¶
A pager for iterating through
group_findings
requests.This class thinly wraps an initial
google.cloud.securitycenter_v2.types.GroupFindingsResponse
object, and provides an__iter__
method to iterate through itsgroup_by_results
field.If there are more pages, the
__iter__
method will make additionalGroupFindings
requests and continue to iterate through thegroup_by_results
field on the corresponding responses.All the usual
google.cloud.securitycenter_v2.types.GroupFindingsResponse
attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.Instantiate the pager.
- Parameters
method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.cloud.securitycenter_v2.types.GroupFindingsRequest) – The initial request object.
response (google.cloud.securitycenter_v2.types.GroupFindingsResponse) – The initial response object.
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.
- class google.cloud.securitycenter_v2.services.security_center.pagers.ListAttackPathsAsyncPager(method: Callable[[...], Awaitable[google.cloud.securitycenter_v2.types.securitycenter_service.ListAttackPathsResponse]], request: google.cloud.securitycenter_v2.types.securitycenter_service.ListAttackPathsRequest, response: google.cloud.securitycenter_v2.types.securitycenter_service.ListAttackPathsResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]¶
A pager for iterating through
list_attack_paths
requests.This class thinly wraps an initial
google.cloud.securitycenter_v2.types.ListAttackPathsResponse
object, and provides an__aiter__
method to iterate through itsattack_paths
field.If there are more pages, the
__aiter__
method will make additionalListAttackPaths
requests and continue to iterate through theattack_paths
field on the corresponding responses.All the usual
google.cloud.securitycenter_v2.types.ListAttackPathsResponse
attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.Instantiates the pager.
- Parameters
method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.cloud.securitycenter_v2.types.ListAttackPathsRequest) – The initial request object.
response (google.cloud.securitycenter_v2.types.ListAttackPathsResponse) – The initial response object.
retry (google.api_core.retry.AsyncRetry) – 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.
- class google.cloud.securitycenter_v2.services.security_center.pagers.ListAttackPathsPager(method: Callable[[...], google.cloud.securitycenter_v2.types.securitycenter_service.ListAttackPathsResponse], request: google.cloud.securitycenter_v2.types.securitycenter_service.ListAttackPathsRequest, response: google.cloud.securitycenter_v2.types.securitycenter_service.ListAttackPathsResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]¶
A pager for iterating through
list_attack_paths
requests.This class thinly wraps an initial
google.cloud.securitycenter_v2.types.ListAttackPathsResponse
object, and provides an__iter__
method to iterate through itsattack_paths
field.If there are more pages, the
__iter__
method will make additionalListAttackPaths
requests and continue to iterate through theattack_paths
field on the corresponding responses.All the usual
google.cloud.securitycenter_v2.types.ListAttackPathsResponse
attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.Instantiate the pager.
- Parameters
method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.cloud.securitycenter_v2.types.ListAttackPathsRequest) – The initial request object.
response (google.cloud.securitycenter_v2.types.ListAttackPathsResponse) – The initial response object.
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.
- class google.cloud.securitycenter_v2.services.security_center.pagers.ListBigQueryExportsAsyncPager(method: Callable[[...], Awaitable[google.cloud.securitycenter_v2.types.securitycenter_service.ListBigQueryExportsResponse]], request: google.cloud.securitycenter_v2.types.securitycenter_service.ListBigQueryExportsRequest, response: google.cloud.securitycenter_v2.types.securitycenter_service.ListBigQueryExportsResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]¶
A pager for iterating through
list_big_query_exports
requests.This class thinly wraps an initial
google.cloud.securitycenter_v2.types.ListBigQueryExportsResponse
object, and provides an__aiter__
method to iterate through itsbig_query_exports
field.If there are more pages, the
__aiter__
method will make additionalListBigQueryExports
requests and continue to iterate through thebig_query_exports
field on the corresponding responses.All the usual
google.cloud.securitycenter_v2.types.ListBigQueryExportsResponse
attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.Instantiates the pager.
- Parameters
method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.cloud.securitycenter_v2.types.ListBigQueryExportsRequest) – The initial request object.
response (google.cloud.securitycenter_v2.types.ListBigQueryExportsResponse) – The initial response object.
retry (google.api_core.retry.AsyncRetry) – 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.
- class google.cloud.securitycenter_v2.services.security_center.pagers.ListBigQueryExportsPager(method: Callable[[...], google.cloud.securitycenter_v2.types.securitycenter_service.ListBigQueryExportsResponse], request: google.cloud.securitycenter_v2.types.securitycenter_service.ListBigQueryExportsRequest, response: google.cloud.securitycenter_v2.types.securitycenter_service.ListBigQueryExportsResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]¶
A pager for iterating through
list_big_query_exports
requests.This class thinly wraps an initial
google.cloud.securitycenter_v2.types.ListBigQueryExportsResponse
object, and provides an__iter__
method to iterate through itsbig_query_exports
field.If there are more pages, the
__iter__
method will make additionalListBigQueryExports
requests and continue to iterate through thebig_query_exports
field on the corresponding responses.All the usual
google.cloud.securitycenter_v2.types.ListBigQueryExportsResponse
attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.Instantiate the pager.
- Parameters
method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.cloud.securitycenter_v2.types.ListBigQueryExportsRequest) – The initial request object.
response (google.cloud.securitycenter_v2.types.ListBigQueryExportsResponse) – The initial response object.
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.
- class google.cloud.securitycenter_v2.services.security_center.pagers.ListFindingsAsyncPager(method: Callable[[...], Awaitable[google.cloud.securitycenter_v2.types.securitycenter_service.ListFindingsResponse]], request: google.cloud.securitycenter_v2.types.securitycenter_service.ListFindingsRequest, response: google.cloud.securitycenter_v2.types.securitycenter_service.ListFindingsResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]¶
A pager for iterating through
list_findings
requests.This class thinly wraps an initial
google.cloud.securitycenter_v2.types.ListFindingsResponse
object, and provides an__aiter__
method to iterate through itslist_findings_results
field.If there are more pages, the
__aiter__
method will make additionalListFindings
requests and continue to iterate through thelist_findings_results
field on the corresponding responses.All the usual
google.cloud.securitycenter_v2.types.ListFindingsResponse
attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.Instantiates the pager.
- Parameters
method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.cloud.securitycenter_v2.types.ListFindingsRequest) – The initial request object.
response (google.cloud.securitycenter_v2.types.ListFindingsResponse) – The initial response object.
retry (google.api_core.retry.AsyncRetry) – 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.
- class google.cloud.securitycenter_v2.services.security_center.pagers.ListFindingsPager(method: Callable[[...], google.cloud.securitycenter_v2.types.securitycenter_service.ListFindingsResponse], request: google.cloud.securitycenter_v2.types.securitycenter_service.ListFindingsRequest, response: google.cloud.securitycenter_v2.types.securitycenter_service.ListFindingsResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]¶
A pager for iterating through
list_findings
requests.This class thinly wraps an initial
google.cloud.securitycenter_v2.types.ListFindingsResponse
object, and provides an__iter__
method to iterate through itslist_findings_results
field.If there are more pages, the
__iter__
method will make additionalListFindings
requests and continue to iterate through thelist_findings_results
field on the corresponding responses.All the usual
google.cloud.securitycenter_v2.types.ListFindingsResponse
attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.Instantiate the pager.
- Parameters
method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.cloud.securitycenter_v2.types.ListFindingsRequest) – The initial request object.
response (google.cloud.securitycenter_v2.types.ListFindingsResponse) – The initial response object.
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.
- class google.cloud.securitycenter_v2.services.security_center.pagers.ListMuteConfigsAsyncPager(method: Callable[[...], Awaitable[google.cloud.securitycenter_v2.types.securitycenter_service.ListMuteConfigsResponse]], request: google.cloud.securitycenter_v2.types.securitycenter_service.ListMuteConfigsRequest, response: google.cloud.securitycenter_v2.types.securitycenter_service.ListMuteConfigsResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]¶
A pager for iterating through
list_mute_configs
requests.This class thinly wraps an initial
google.cloud.securitycenter_v2.types.ListMuteConfigsResponse
object, and provides an__aiter__
method to iterate through itsmute_configs
field.If there are more pages, the
__aiter__
method will make additionalListMuteConfigs
requests and continue to iterate through themute_configs
field on the corresponding responses.All the usual
google.cloud.securitycenter_v2.types.ListMuteConfigsResponse
attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.Instantiates the pager.
- Parameters
method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.cloud.securitycenter_v2.types.ListMuteConfigsRequest) – The initial request object.
response (google.cloud.securitycenter_v2.types.ListMuteConfigsResponse) – The initial response object.
retry (google.api_core.retry.AsyncRetry) – 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.
- class google.cloud.securitycenter_v2.services.security_center.pagers.ListMuteConfigsPager(method: Callable[[...], google.cloud.securitycenter_v2.types.securitycenter_service.ListMuteConfigsResponse], request: google.cloud.securitycenter_v2.types.securitycenter_service.ListMuteConfigsRequest, response: google.cloud.securitycenter_v2.types.securitycenter_service.ListMuteConfigsResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]¶
A pager for iterating through
list_mute_configs
requests.This class thinly wraps an initial
google.cloud.securitycenter_v2.types.ListMuteConfigsResponse
object, and provides an__iter__
method to iterate through itsmute_configs
field.If there are more pages, the
__iter__
method will make additionalListMuteConfigs
requests and continue to iterate through themute_configs
field on the corresponding responses.All the usual
google.cloud.securitycenter_v2.types.ListMuteConfigsResponse
attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.Instantiate the pager.
- Parameters
method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.cloud.securitycenter_v2.types.ListMuteConfigsRequest) – The initial request object.
response (google.cloud.securitycenter_v2.types.ListMuteConfigsResponse) – The initial response object.
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.
- class google.cloud.securitycenter_v2.services.security_center.pagers.ListNotificationConfigsAsyncPager(method: Callable[[...], Awaitable[google.cloud.securitycenter_v2.types.securitycenter_service.ListNotificationConfigsResponse]], request: google.cloud.securitycenter_v2.types.securitycenter_service.ListNotificationConfigsRequest, response: google.cloud.securitycenter_v2.types.securitycenter_service.ListNotificationConfigsResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]¶
A pager for iterating through
list_notification_configs
requests.This class thinly wraps an initial
google.cloud.securitycenter_v2.types.ListNotificationConfigsResponse
object, and provides an__aiter__
method to iterate through itsnotification_configs
field.If there are more pages, the
__aiter__
method will make additionalListNotificationConfigs
requests and continue to iterate through thenotification_configs
field on the corresponding responses.All the usual
google.cloud.securitycenter_v2.types.ListNotificationConfigsResponse
attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.Instantiates the pager.
- Parameters
method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.cloud.securitycenter_v2.types.ListNotificationConfigsRequest) – The initial request object.
response (google.cloud.securitycenter_v2.types.ListNotificationConfigsResponse) – The initial response object.
retry (google.api_core.retry.AsyncRetry) – 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.
- class google.cloud.securitycenter_v2.services.security_center.pagers.ListNotificationConfigsPager(method: Callable[[...], google.cloud.securitycenter_v2.types.securitycenter_service.ListNotificationConfigsResponse], request: google.cloud.securitycenter_v2.types.securitycenter_service.ListNotificationConfigsRequest, response: google.cloud.securitycenter_v2.types.securitycenter_service.ListNotificationConfigsResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]¶
A pager for iterating through
list_notification_configs
requests.This class thinly wraps an initial
google.cloud.securitycenter_v2.types.ListNotificationConfigsResponse
object, and provides an__iter__
method to iterate through itsnotification_configs
field.If there are more pages, the
__iter__
method will make additionalListNotificationConfigs
requests and continue to iterate through thenotification_configs
field on the corresponding responses.All the usual
google.cloud.securitycenter_v2.types.ListNotificationConfigsResponse
attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.Instantiate the pager.
- Parameters
method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.cloud.securitycenter_v2.types.ListNotificationConfigsRequest) – The initial request object.
response (google.cloud.securitycenter_v2.types.ListNotificationConfigsResponse) – The initial response object.
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.
- class google.cloud.securitycenter_v2.services.security_center.pagers.ListResourceValueConfigsAsyncPager(method: Callable[[...], Awaitable[google.cloud.securitycenter_v2.types.securitycenter_service.ListResourceValueConfigsResponse]], request: google.cloud.securitycenter_v2.types.securitycenter_service.ListResourceValueConfigsRequest, response: google.cloud.securitycenter_v2.types.securitycenter_service.ListResourceValueConfigsResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]¶
A pager for iterating through
list_resource_value_configs
requests.This class thinly wraps an initial
google.cloud.securitycenter_v2.types.ListResourceValueConfigsResponse
object, and provides an__aiter__
method to iterate through itsresource_value_configs
field.If there are more pages, the
__aiter__
method will make additionalListResourceValueConfigs
requests and continue to iterate through theresource_value_configs
field on the corresponding responses.All the usual
google.cloud.securitycenter_v2.types.ListResourceValueConfigsResponse
attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.Instantiates the pager.
- Parameters
method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.cloud.securitycenter_v2.types.ListResourceValueConfigsRequest) – The initial request object.
response (google.cloud.securitycenter_v2.types.ListResourceValueConfigsResponse) – The initial response object.
retry (google.api_core.retry.AsyncRetry) – 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.
- class google.cloud.securitycenter_v2.services.security_center.pagers.ListResourceValueConfigsPager(method: Callable[[...], google.cloud.securitycenter_v2.types.securitycenter_service.ListResourceValueConfigsResponse], request: google.cloud.securitycenter_v2.types.securitycenter_service.ListResourceValueConfigsRequest, response: google.cloud.securitycenter_v2.types.securitycenter_service.ListResourceValueConfigsResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]¶
A pager for iterating through
list_resource_value_configs
requests.This class thinly wraps an initial
google.cloud.securitycenter_v2.types.ListResourceValueConfigsResponse
object, and provides an__iter__
method to iterate through itsresource_value_configs
field.If there are more pages, the
__iter__
method will make additionalListResourceValueConfigs
requests and continue to iterate through theresource_value_configs
field on the corresponding responses.All the usual
google.cloud.securitycenter_v2.types.ListResourceValueConfigsResponse
attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.Instantiate the pager.
- Parameters
method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.cloud.securitycenter_v2.types.ListResourceValueConfigsRequest) – The initial request object.
response (google.cloud.securitycenter_v2.types.ListResourceValueConfigsResponse) – The initial response object.
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.
- class google.cloud.securitycenter_v2.services.security_center.pagers.ListSourcesAsyncPager(method: Callable[[...], Awaitable[google.cloud.securitycenter_v2.types.securitycenter_service.ListSourcesResponse]], request: google.cloud.securitycenter_v2.types.securitycenter_service.ListSourcesRequest, response: google.cloud.securitycenter_v2.types.securitycenter_service.ListSourcesResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]¶
A pager for iterating through
list_sources
requests.This class thinly wraps an initial
google.cloud.securitycenter_v2.types.ListSourcesResponse
object, and provides an__aiter__
method to iterate through itssources
field.If there are more pages, the
__aiter__
method will make additionalListSources
requests and continue to iterate through thesources
field on the corresponding responses.All the usual
google.cloud.securitycenter_v2.types.ListSourcesResponse
attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.Instantiates the pager.
- Parameters
method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.cloud.securitycenter_v2.types.ListSourcesRequest) – The initial request object.
response (google.cloud.securitycenter_v2.types.ListSourcesResponse) – The initial response object.
retry (google.api_core.retry.AsyncRetry) – 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.
- class google.cloud.securitycenter_v2.services.security_center.pagers.ListSourcesPager(method: Callable[[...], google.cloud.securitycenter_v2.types.securitycenter_service.ListSourcesResponse], request: google.cloud.securitycenter_v2.types.securitycenter_service.ListSourcesRequest, response: google.cloud.securitycenter_v2.types.securitycenter_service.ListSourcesResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]¶
A pager for iterating through
list_sources
requests.This class thinly wraps an initial
google.cloud.securitycenter_v2.types.ListSourcesResponse
object, and provides an__iter__
method to iterate through itssources
field.If there are more pages, the
__iter__
method will make additionalListSources
requests and continue to iterate through thesources
field on the corresponding responses.All the usual
google.cloud.securitycenter_v2.types.ListSourcesResponse
attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.Instantiate the pager.
- Parameters
method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.cloud.securitycenter_v2.types.ListSourcesRequest) – The initial request object.
response (google.cloud.securitycenter_v2.types.ListSourcesResponse) – The initial response object.
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.
- class google.cloud.securitycenter_v2.services.security_center.pagers.ListValuedResourcesAsyncPager(method: Callable[[...], Awaitable[google.cloud.securitycenter_v2.types.securitycenter_service.ListValuedResourcesResponse]], request: google.cloud.securitycenter_v2.types.securitycenter_service.ListValuedResourcesRequest, response: google.cloud.securitycenter_v2.types.securitycenter_service.ListValuedResourcesResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]¶
A pager for iterating through
list_valued_resources
requests.This class thinly wraps an initial
google.cloud.securitycenter_v2.types.ListValuedResourcesResponse
object, and provides an__aiter__
method to iterate through itsvalued_resources
field.If there are more pages, the
__aiter__
method will make additionalListValuedResources
requests and continue to iterate through thevalued_resources
field on the corresponding responses.All the usual
google.cloud.securitycenter_v2.types.ListValuedResourcesResponse
attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.Instantiates the pager.
- Parameters
method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.cloud.securitycenter_v2.types.ListValuedResourcesRequest) – The initial request object.
response (google.cloud.securitycenter_v2.types.ListValuedResourcesResponse) – The initial response object.
retry (google.api_core.retry.AsyncRetry) – 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.
- class google.cloud.securitycenter_v2.services.security_center.pagers.ListValuedResourcesPager(method: Callable[[...], google.cloud.securitycenter_v2.types.securitycenter_service.ListValuedResourcesResponse], request: google.cloud.securitycenter_v2.types.securitycenter_service.ListValuedResourcesRequest, response: google.cloud.securitycenter_v2.types.securitycenter_service.ListValuedResourcesResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]¶
A pager for iterating through
list_valued_resources
requests.This class thinly wraps an initial
google.cloud.securitycenter_v2.types.ListValuedResourcesResponse
object, and provides an__iter__
method to iterate through itsvalued_resources
field.If there are more pages, the
__iter__
method will make additionalListValuedResources
requests and continue to iterate through thevalued_resources
field on the corresponding responses.All the usual
google.cloud.securitycenter_v2.types.ListValuedResourcesResponse
attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.Instantiate the pager.
- Parameters
method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.cloud.securitycenter_v2.types.ListValuedResourcesRequest) – The initial request object.
response (google.cloud.securitycenter_v2.types.ListValuedResourcesResponse) – The initial response object.
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.