SecurityCenterAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.securitycenter_v1.services.security_center.transports.base.SecurityCenterTransport, typing.Callable[[...], google.cloud.securitycenter_v1.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>)
V1 APIs for Security Center service.
Properties
api_endpoint
Return the API endpoint used by the client instance.
Returns | |
---|---|
Type | Description |
str |
The API endpoint used by the client instance. |
transport
Returns the transport used by the client instance.
Returns | |
---|---|
Type | Description |
SecurityCenterTransport |
The transport used by the client instance. |
universe_domain
Return the universe domain used by the client instance.
Returns | |
---|---|
Type | Description |
str |
The universe domain used by the client instance. |
Methods
SecurityCenterAsyncClient
SecurityCenterAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.securitycenter_v1.services.security_center.transports.base.SecurityCenterTransport, typing.Callable[[...], google.cloud.securitycenter_v1.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>)
Instantiates the security center async client.
Parameters | |
---|---|
Name | Description |
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 |
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 |
Exceptions | |
---|---|
Type | Description |
google.auth.exceptions.MutualTlsChannelError |
If mutual TLS transport creation failed for any reason. |
asset_path
asset_path(organization: str, asset: str) -> str
Returns a fully-qualified asset string.
attack_path_path
attack_path_path(
organization: str, simulation: str, valued_resource: str, attack_path: str
) -> str
Returns a fully-qualified attack_path string.
batch_create_resource_value_configs
batch_create_resource_value_configs(
request: typing.Optional[
typing.Union[
google.cloud.securitycenter_v1.types.securitycenter_service.BatchCreateResourceValueConfigsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
requests: typing.Optional[
typing.MutableSequence[
google.cloud.securitycenter_v1.types.securitycenter_service.CreateResourceValueConfigRequest
]
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.securitycenter_v1.types.securitycenter_service.BatchCreateResourceValueConfigsResponse
)
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_v1
async def sample_batch_create_resource_value_configs():
# Create a client
client = securitycenter_v1.SecurityCenterAsyncClient()
# Initialize request argument(s)
requests = securitycenter_v1.CreateResourceValueConfigRequest()
requests.parent = "parent_value"
requests.resource_value_config.resource_value = "NONE"
requests.resource_value_config.tag_values = ['tag_values_value1', 'tag_values_value2']
request = securitycenter_v1.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 | |
---|---|
Name | Description |
request |
Optional[Union[google.cloud.securitycenter_v1.types.BatchCreateResourceValueConfigsRequest, dict]]
The request object. Request message to create multiple resource value configs |
parent |
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 |
requests |
:class:
Required. The resource value configs to be created. This corresponds to the |
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 | |
---|---|
Type | Description |
google.cloud.securitycenter_v1.types.BatchCreateResourceValueConfigsResponse |
Response message for BatchCreateResourceValueConfigs |
big_query_export_path
big_query_export_path(organization: str, export: str) -> str
Returns a fully-qualified big_query_export string.
bulk_mute_findings
bulk_mute_findings(
request: typing.Optional[
typing.Union[
google.cloud.securitycenter_v1.types.securitycenter_service.BulkMuteFindingsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Kicks off an LRO to bulk mute findings for a parent based on a filter. The parent can be either an organization, folder or project. The findings matched by the filter will be muted after the LRO is done.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import securitycenter_v1
async def sample_bulk_mute_findings():
# Create a client
client = securitycenter_v1.SecurityCenterAsyncClient()
# Initialize request argument(s)
request = securitycenter_v1.BulkMuteFindingsRequest(
parent="parent_value",
)
# Make the request
operation = client.bulk_mute_findings(request=request)
print("Waiting for operation to complete...")
response = (await operation).result()
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Optional[Union[google.cloud.securitycenter_v1.types.BulkMuteFindingsRequest, dict]]
The request object. Request message for bulk findings update. Note: 1. If multiple bulk update requests match the same resource, the order in which they get executed is not defined. 2. Once a bulk operation is started, there is no way to stop it. |
parent |
Required. The parent, at which bulk action needs to be applied. Its format is |
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 | |
---|---|
Type | Description |
google.api_core.operation_async.AsyncOperation |
An object representing a long-running operation. The result type for the operation will be BulkMuteFindingsResponse The response to a BulkMute request. Contains the LRO information. |
cancel_operation
cancel_operation(
request: typing.Optional[
google.longrunning.operations_pb2.CancelOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
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 | |
---|---|
Name | Description |
request |
The request object. Request message for |
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. |
common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
create_big_query_export
create_big_query_export(
request: typing.Optional[
typing.Union[
google.cloud.securitycenter_v1.types.securitycenter_service.CreateBigQueryExportRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
big_query_export: typing.Optional[
google.cloud.securitycenter_v1.types.bigquery_export.BigQueryExport
] = None,
big_query_export_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.securitycenter_v1.types.bigquery_export.BigQueryExport
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_v1
async def sample_create_big_query_export():
# Create a client
client = securitycenter_v1.SecurityCenterAsyncClient()
# Initialize request argument(s)
request = securitycenter_v1.CreateBigQueryExportRequest(
parent="parent_value",
big_query_export_id="big_query_export_id_value",
)
# Make the request
response = await client.create_big_query_export(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Optional[Union[google.cloud.securitycenter_v1.types.CreateBigQueryExportRequest, dict]]
The request object. Request message for creating a BigQuery export. |
parent |
Required. The name of the parent resource of the new BigQuery export. Its format is |
big_query_export |
BigQueryExport
Required. The BigQuery export being created. This corresponds to the |
big_query_export_id |
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 |
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 | |
---|---|
Type | Description |
google.cloud.securitycenter_v1.types.BigQueryExport |
Configures how to deliver Findings to BigQuery Instance. |
create_event_threat_detection_custom_module
create_event_threat_detection_custom_module(
request: typing.Optional[
typing.Union[
google.cloud.securitycenter_v1.types.securitycenter_service.CreateEventThreatDetectionCustomModuleRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
event_threat_detection_custom_module: typing.Optional[
google.cloud.securitycenter_v1.types.event_threat_detection_custom_module.EventThreatDetectionCustomModule
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.securitycenter_v1.types.event_threat_detection_custom_module.EventThreatDetectionCustomModule
)
Creates a resident Event Threat Detection custom module at the scope of the given Resource Manager parent, and also creates inherited custom modules for all descendants of the given parent. These modules are enabled by default.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import securitycenter_v1
async def sample_create_event_threat_detection_custom_module():
# Create a client
client = securitycenter_v1.SecurityCenterAsyncClient()
# Initialize request argument(s)
request = securitycenter_v1.CreateEventThreatDetectionCustomModuleRequest(
parent="parent_value",
)
# Make the request
response = await client.create_event_threat_detection_custom_module(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Optional[Union[google.cloud.securitycenter_v1.types.CreateEventThreatDetectionCustomModuleRequest, dict]]
The request object. Request to create an Event Threat Detection custom module. |
parent |
Required. The new custom module's parent. Its format is: - |
event_threat_detection_custom_module |
EventThreatDetectionCustomModule
Required. The module to create. The event_threat_detection_custom_module.name will be ignored and server generated. This corresponds to the |
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 | |
---|---|
Type | Description |
google.cloud.securitycenter_v1.types.EventThreatDetectionCustomModule |
Represents an instance of an Event Threat Detection custom module, including its full module name, display name, enablement state, and last updated time. You can create a custom module at the organization, folder, or project level. Custom modules that you create at the organization or folder level are inherited by child folders and projects. |
create_finding
create_finding(
request: typing.Optional[
typing.Union[
google.cloud.securitycenter_v1.types.securitycenter_service.CreateFindingRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
finding_id: typing.Optional[str] = None,
finding: typing.Optional[
google.cloud.securitycenter_v1.types.finding.Finding
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.securitycenter_v1.types.finding.Finding
Creates a finding. The corresponding source must exist for finding creation to succeed.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import securitycenter_v1
async def sample_create_finding():
# Create a client
client = securitycenter_v1.SecurityCenterAsyncClient()
# Initialize request argument(s)
request = securitycenter_v1.CreateFindingRequest(
parent="parent_value",
finding_id="finding_id_value",
)
# Make the request
response = await client.create_finding(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Optional[Union[google.cloud.securitycenter_v1.types.CreateFindingRequest, dict]]
The request object. Request message for creating a finding. |
parent |
Required. Resource name of the new finding's parent. Its format should be |
finding_id |
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 |
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 |
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 | |
---|---|
Type | Description |
google.cloud.securitycenter_v1.types.Finding |
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. |
create_mute_config
create_mute_config(
request: typing.Optional[
typing.Union[
google.cloud.securitycenter_v1.types.securitycenter_service.CreateMuteConfigRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
mute_config: typing.Optional[
google.cloud.securitycenter_v1.types.mute_config.MuteConfig
] = None,
mute_config_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.securitycenter_v1.types.mute_config.MuteConfig
Creates a mute config.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import securitycenter_v1
async def sample_create_mute_config():
# Create a client
client = securitycenter_v1.SecurityCenterAsyncClient()
# Initialize request argument(s)
mute_config = securitycenter_v1.MuteConfig()
mute_config.filter = "filter_value"
request = securitycenter_v1.CreateMuteConfigRequest(
parent="parent_value",
mute_config=mute_config,
mute_config_id="mute_config_id_value",
)
# Make the request
response = await client.create_mute_config(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Optional[Union[google.cloud.securitycenter_v1.types.CreateMuteConfigRequest, dict]]
The request object. Request message for creating a mute config. |
parent |
Required. Resource name of the new mute configs's parent. Its format is |
mute_config |
MuteConfig
Required. The mute config being created. This corresponds to the |
mute_config_id |
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 |
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 | |
---|---|
Type | Description |
google.cloud.securitycenter_v1.types.MuteConfig |
A mute config is a Cloud SCC resource that contains the configuration to mute create/update events of findings. |
create_notification_config
create_notification_config(
request: typing.Optional[
typing.Union[
google.cloud.securitycenter_v1.types.securitycenter_service.CreateNotificationConfigRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
config_id: typing.Optional[str] = None,
notification_config: typing.Optional[
google.cloud.securitycenter_v1.types.notification_config.NotificationConfig
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.securitycenter_v1.types.notification_config.NotificationConfig
Creates a notification config.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import securitycenter_v1
async def sample_create_notification_config():
# Create a client
client = securitycenter_v1.SecurityCenterAsyncClient()
# Initialize request argument(s)
request = securitycenter_v1.CreateNotificationConfigRequest(
parent="parent_value",
config_id="config_id_value",
)
# Make the request
response = await client.create_notification_config(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Optional[Union[google.cloud.securitycenter_v1.types.CreateNotificationConfigRequest, dict]]
The request object. Request message for creating a notification config. |
parent |
Required. Resource name of the new notification config's parent. Its format is |
config_id |
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 |
notification_config |
NotificationConfig
Required. The notification config being created. The name and the service account will be ignored as they are both output only fields on this resource. This corresponds to the |
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 | |
---|---|
Type | Description |
google.cloud.securitycenter_v1.types.NotificationConfig |
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. |
create_security_health_analytics_custom_module
create_security_health_analytics_custom_module(
request: typing.Optional[
typing.Union[
google.cloud.securitycenter_v1.types.securitycenter_service.CreateSecurityHealthAnalyticsCustomModuleRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
security_health_analytics_custom_module: typing.Optional[
google.cloud.securitycenter_v1.types.security_health_analytics_custom_module.SecurityHealthAnalyticsCustomModule
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.securitycenter_v1.types.security_health_analytics_custom_module.SecurityHealthAnalyticsCustomModule
)
Creates a resident SecurityHealthAnalyticsCustomModule at the scope of the given CRM parent, and also creates inherited SecurityHealthAnalyticsCustomModules for all CRM descendants of the given parent. These modules are enabled by default.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import securitycenter_v1
async def sample_create_security_health_analytics_custom_module():
# Create a client
client = securitycenter_v1.SecurityCenterAsyncClient()
# Initialize request argument(s)
request = securitycenter_v1.CreateSecurityHealthAnalyticsCustomModuleRequest(
parent="parent_value",
)
# Make the request
response = await client.create_security_health_analytics_custom_module(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Optional[Union[google.cloud.securitycenter_v1.types.CreateSecurityHealthAnalyticsCustomModuleRequest, dict]]
The request object. Request message for creating Security Health Analytics custom modules. |
parent |
Required. Resource name of the new custom module's parent. Its format is |
security_health_analytics_custom_module |
SecurityHealthAnalyticsCustomModule
Required. SecurityHealthAnalytics custom module to create. The provided name is ignored and reset with provided parent information and server-generated ID. This corresponds to the |
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 | |
---|---|
Type | Description |
google.cloud.securitycenter_v1.types.SecurityHealthAnalyticsCustomModule |
Represents an instance of a Security Health Analytics custom module, including its full module name, display name, enablement state, and last updated time. You can create a custom module at the organization, folder, or project level. Custom modules that you create at the organization or folder level are inherited by the child folders and projects. |
create_source
create_source(
request: typing.Optional[
typing.Union[
google.cloud.securitycenter_v1.types.securitycenter_service.CreateSourceRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
source: typing.Optional[google.cloud.securitycenter_v1.types.source.Source] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.securitycenter_v1.types.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_v1
async def sample_create_source():
# Create a client
client = securitycenter_v1.SecurityCenterAsyncClient()
# Initialize request argument(s)
request = securitycenter_v1.CreateSourceRequest(
parent="parent_value",
)
# Make the request
response = await client.create_source(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Optional[Union[google.cloud.securitycenter_v1.types.CreateSourceRequest, dict]]
The request object. Request message for creating a source. |
parent |
Required. Resource name of the new source's parent. Its format should be |
source |
Source
Required. The Source being created, only the display_name and description will be used. All other fields will be ignored. This corresponds to the |
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 | |
---|---|
Type | Description |
google.cloud.securitycenter_v1.types.Source |
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. |
delete_big_query_export
delete_big_query_export(
request: typing.Optional[
typing.Union[
google.cloud.securitycenter_v1.types.securitycenter_service.DeleteBigQueryExportRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
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_v1
async def sample_delete_big_query_export():
# Create a client
client = securitycenter_v1.SecurityCenterAsyncClient()
# Initialize request argument(s)
request = securitycenter_v1.DeleteBigQueryExportRequest(
name="name_value",
)
# Make the request
await client.delete_big_query_export(request=request)
Parameters | |
---|---|
Name | Description |
request |
Optional[Union[google.cloud.securitycenter_v1.types.DeleteBigQueryExportRequest, dict]]
The request object. Request message for deleting a BigQuery export. |
name |
Required. The name of the BigQuery export to delete. Its format is |
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. |
delete_event_threat_detection_custom_module
delete_event_threat_detection_custom_module(
request: typing.Optional[
typing.Union[
google.cloud.securitycenter_v1.types.securitycenter_service.DeleteEventThreatDetectionCustomModuleRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Deletes the specified Event Threat Detection custom module and all of its descendants in the Resource Manager hierarchy. This method is only supported for resident custom modules.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import securitycenter_v1
async def sample_delete_event_threat_detection_custom_module():
# Create a client
client = securitycenter_v1.SecurityCenterAsyncClient()
# Initialize request argument(s)
request = securitycenter_v1.DeleteEventThreatDetectionCustomModuleRequest(
name="name_value",
)
# Make the request
await client.delete_event_threat_detection_custom_module(request=request)
Parameters | |
---|---|
Name | Description |
request |
Optional[Union[google.cloud.securitycenter_v1.types.DeleteEventThreatDetectionCustomModuleRequest, dict]]
The request object. Request to delete an Event Threat Detection custom module. |
name |
Required. Name of the custom module to delete. Its format is: - "organizations/{organization}/eventThreatDetectionSettings/customModules/{module}". - "folders/{folder}/eventThreatDetectionSettings/customModules/{module}". - "projects/{project}/eventThreatDetectionSettings/customModules/{module}". This corresponds to the |
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. |
delete_mute_config
delete_mute_config(
request: typing.Optional[
typing.Union[
google.cloud.securitycenter_v1.types.securitycenter_service.DeleteMuteConfigRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Deletes an existing mute config.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import securitycenter_v1
async def sample_delete_mute_config():
# Create a client
client = securitycenter_v1.SecurityCenterAsyncClient()
# Initialize request argument(s)
request = securitycenter_v1.DeleteMuteConfigRequest(
name="name_value",
)
# Make the request
await client.delete_mute_config(request=request)
Parameters | |
---|---|
Name | Description |
request |
Optional[Union[google.cloud.securitycenter_v1.types.DeleteMuteConfigRequest, dict]]
The request object. Request message for deleting a mute config. |
name |
Required. Name of the mute config to delete. Its format is |
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. |
delete_notification_config
delete_notification_config(
request: typing.Optional[
typing.Union[
google.cloud.securitycenter_v1.types.securitycenter_service.DeleteNotificationConfigRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Deletes a notification config.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import securitycenter_v1
async def sample_delete_notification_config():
# Create a client
client = securitycenter_v1.SecurityCenterAsyncClient()
# Initialize request argument(s)
request = securitycenter_v1.DeleteNotificationConfigRequest(
name="name_value",
)
# Make the request
await client.delete_notification_config(request=request)
Parameters | |
---|---|
Name | Description |
request |
Optional[Union[google.cloud.securitycenter_v1.types.DeleteNotificationConfigRequest, dict]]
The request object. Request message for deleting a notification config. |
name |
Required. Name of the notification config to delete. Its format is |
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. |
delete_operation
delete_operation(
request: typing.Optional[
google.longrunning.operations_pb2.DeleteOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
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 | |
---|---|
Name | Description |
request |
The request object. Request message for |
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. |
delete_resource_value_config
delete_resource_value_config(
request: typing.Optional[
typing.Union[
google.cloud.securitycenter_v1.types.securitycenter_service.DeleteResourceValueConfigRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
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_v1
async def sample_delete_resource_value_config():
# Create a client
client = securitycenter_v1.SecurityCenterAsyncClient()
# Initialize request argument(s)
request = securitycenter_v1.DeleteResourceValueConfigRequest(
name="name_value",
)
# Make the request
await client.delete_resource_value_config(request=request)
Parameters | |
---|---|
Name | Description |
request |
Optional[Union[google.cloud.securitycenter_v1.types.DeleteResourceValueConfigRequest, dict]]
The request object. Request message to delete resource value config |
name |
Required. Name of the ResourceValueConfig to delete This corresponds to the |
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. |
delete_security_health_analytics_custom_module
delete_security_health_analytics_custom_module(
request: typing.Optional[
typing.Union[
google.cloud.securitycenter_v1.types.securitycenter_service.DeleteSecurityHealthAnalyticsCustomModuleRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Deletes the specified SecurityHealthAnalyticsCustomModule and all of its descendants in the CRM hierarchy. This method is only supported for resident custom modules.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import securitycenter_v1
async def sample_delete_security_health_analytics_custom_module():
# Create a client
client = securitycenter_v1.SecurityCenterAsyncClient()
# Initialize request argument(s)
request = securitycenter_v1.DeleteSecurityHealthAnalyticsCustomModuleRequest(
name="name_value",
)
# Make the request
await client.delete_security_health_analytics_custom_module(request=request)
Parameters | |
---|---|
Name | Description |
request |
Optional[Union[google.cloud.securitycenter_v1.types.DeleteSecurityHealthAnalyticsCustomModuleRequest, dict]]
The request object. Request message for deleting Security Health Analytics custom modules. |
name |
Required. Name of the custom module to delete. Its format is |
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. |
dlp_job_path
dlp_job_path(project: str, dlp_job: str) -> str
Returns a fully-qualified dlp_job string.
effective_event_threat_detection_custom_module_path
effective_event_threat_detection_custom_module_path(
organization: str, module: str
) -> str
Returns a fully-qualified effective_event_threat_detection_custom_module string.
effective_security_health_analytics_custom_module_path
effective_security_health_analytics_custom_module_path(
organization: str, effective_custom_module: str
) -> str
Returns a fully-qualified effective_security_health_analytics_custom_module string.
event_threat_detection_custom_module_path
event_threat_detection_custom_module_path(organization: str, module: str) -> str
Returns a fully-qualified event_threat_detection_custom_module string.
external_system_path
external_system_path(
organization: str, source: str, finding: str, externalsystem: str
) -> str
Returns a fully-qualified external_system string.
finding_path
finding_path(organization: str, source: str, finding: str) -> str
Returns a fully-qualified finding string.
from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
Parameter | |
---|---|
Name | Description |
filename |
str
The path to the service account private key json file. |
Returns | |
---|---|
Type | Description |
SecurityCenterAsyncClient |
The constructed client. |
from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
Parameter | |
---|---|
Name | Description |
info |
dict
The service account private key info. |
Returns | |
---|---|
Type | Description |
SecurityCenterAsyncClient |
The constructed client. |
from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
Parameter | |
---|---|
Name | Description |
filename |
str
The path to the service account private key json file. |
Returns | |
---|---|
Type | Description |
SecurityCenterAsyncClient |
The constructed client. |
get_big_query_export
get_big_query_export(
request: typing.Optional[
typing.Union[
google.cloud.securitycenter_v1.types.securitycenter_service.GetBigQueryExportRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.securitycenter_v1.types.bigquery_export.BigQueryExport
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_v1
async def sample_get_big_query_export():
# Create a client
client = securitycenter_v1.SecurityCenterAsyncClient()
# Initialize request argument(s)
request = securitycenter_v1.GetBigQueryExportRequest(
name="name_value",
)
# Make the request
response = await client.get_big_query_export(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Optional[Union[google.cloud.securitycenter_v1.types.GetBigQueryExportRequest, dict]]
The request object. Request message for retrieving a BigQuery export. |
name |
Required. Name of the BigQuery export to retrieve. Its format is |
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 | |
---|---|
Type | Description |
google.cloud.securitycenter_v1.types.BigQueryExport |
Configures how to deliver Findings to BigQuery Instance. |
get_effective_event_threat_detection_custom_module
get_effective_event_threat_detection_custom_module(
request: typing.Optional[
typing.Union[
google.cloud.securitycenter_v1.types.securitycenter_service.GetEffectiveEventThreatDetectionCustomModuleRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.securitycenter_v1.types.effective_event_threat_detection_custom_module.EffectiveEventThreatDetectionCustomModule
)
Gets an effective Event Threat Detection custom module at the given level.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import securitycenter_v1
async def sample_get_effective_event_threat_detection_custom_module():
# Create a client
client = securitycenter_v1.SecurityCenterAsyncClient()
# Initialize request argument(s)
request = securitycenter_v1.GetEffectiveEventThreatDetectionCustomModuleRequest(
name="name_value",
)
# Make the request
response = await client.get_effective_event_threat_detection_custom_module(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Optional[Union[google.cloud.securitycenter_v1.types.GetEffectiveEventThreatDetectionCustomModuleRequest, dict]]
The request object. Request to get an EffectiveEventThreatDetectionCustomModule. |
name |
Required. The resource name of the effective Event Threat Detection custom module. Its format is: - |
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 | |
---|---|
Type | Description |
google.cloud.securitycenter_v1.types.EffectiveEventThreatDetectionCustomModule |
An EffectiveEventThreatDetectionCustomModule is the representation of an Event Threat Detection custom module at a specified level of the resource hierarchy: organization, folder, or project. If a custom module is inherited from a parent organization or folder, the value of the enablement_state property in EffectiveEventThreatDetectionCustomModule is set to the value that is effective in the parent, instead of INHERITED. For example, if the module is enabled in a parent organization or folder, the effective enablement_state for the module in all child folders or projects is also enabled. EffectiveEventThreatDetectionCustomModule is read-only. |
get_effective_security_health_analytics_custom_module
get_effective_security_health_analytics_custom_module(
request: typing.Optional[
typing.Union[
google.cloud.securitycenter_v1.types.securitycenter_service.GetEffectiveSecurityHealthAnalyticsCustomModuleRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.securitycenter_v1.types.effective_security_health_analytics_custom_module.EffectiveSecurityHealthAnalyticsCustomModule
)
Retrieves an EffectiveSecurityHealthAnalyticsCustomModule.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import securitycenter_v1
async def sample_get_effective_security_health_analytics_custom_module():
# Create a client
client = securitycenter_v1.SecurityCenterAsyncClient()
# Initialize request argument(s)
request = securitycenter_v1.GetEffectiveSecurityHealthAnalyticsCustomModuleRequest(
name="name_value",
)
# Make the request
response = await client.get_effective_security_health_analytics_custom_module(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Optional[Union[google.cloud.securitycenter_v1.types.GetEffectiveSecurityHealthAnalyticsCustomModuleRequest, dict]]
The request object. Request message for getting effective Security Health Analytics custom modules. |
name |
Required. Name of the effective custom module to get. Its format is |
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 | |
---|---|
Type | Description |
google.cloud.securitycenter_v1.types.EffectiveSecurityHealthAnalyticsCustomModule |
An EffectiveSecurityHealthAnalyticsCustomModule is the representation of a Security Health Analytics custom module at a specified level of the resource hierarchy: organization, folder, or project. If a custom module is inherited from a parent organization or folder, the value of the enablementState property in EffectiveSecurityHealthAnalyticsCustomModule is set to the value that is effective in the parent, instead of INHERITED. For example, if the module is enabled in a parent organization or folder, the effective enablement_state for the module in all child folders or projects is also enabled. EffectiveSecurityHealthAnalyticsCustomModule is read-only. |
get_event_threat_detection_custom_module
get_event_threat_detection_custom_module(
request: typing.Optional[
typing.Union[
google.cloud.securitycenter_v1.types.securitycenter_service.GetEventThreatDetectionCustomModuleRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.securitycenter_v1.types.event_threat_detection_custom_module.EventThreatDetectionCustomModule
)
Gets an Event Threat Detection custom module.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import securitycenter_v1
async def sample_get_event_threat_detection_custom_module():
# Create a client
client = securitycenter_v1.SecurityCenterAsyncClient()
# Initialize request argument(s)
request = securitycenter_v1.GetEventThreatDetectionCustomModuleRequest(
name="name_value",
)
# Make the request
response = await client.get_event_threat_detection_custom_module(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Optional[Union[google.cloud.securitycenter_v1.types.GetEventThreatDetectionCustomModuleRequest, dict]]
The request object. Request to get an Event Threat Detection custom module. |
name |
Required. Name of the custom module to get. Its format is: - |
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 | |
---|---|
Type | Description |
google.cloud.securitycenter_v1.types.EventThreatDetectionCustomModule |
Represents an instance of an Event Threat Detection custom module, including its full module name, display name, enablement state, and last updated time. You can create a custom module at the organization, folder, or project level. Custom modules that you create at the organization or folder level are inherited by child folders and projects. |
get_iam_policy
get_iam_policy(
request: typing.Optional[
typing.Union[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest, dict]
] = None,
*,
resource: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Gets the access control policy on the specified Source.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import securitycenter_v1
from google.iam.v1 import iam_policy_pb2 # type: ignore
async def sample_get_iam_policy():
# Create a client
client = securitycenter_v1.SecurityCenterAsyncClient()
# Initialize request argument(s)
request = iam_policy_pb2.GetIamPolicyRequest(
resource="resource_value",
)
# Make the request
response = await client.get_iam_policy(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Optional[Union[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest, dict]]
The request object. Request message for |
resource |
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 |
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 | |
---|---|
Type | Description |
google.iam.v1.policy_pb2.Policy |
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:** :literal:\ { "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:** :literal:\ 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:">\ \ For a description of IAM and its features, see the [IAM documentation](\ https://cloud.google.com/iam/docs/). |
get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Return the API endpoint and client cert source for mutual TLS.
The client cert source is determined in the following order:
(1) if GOOGLE_API_USE_CLIENT_CERTIFICATE
environment variable is not "true", the
client cert source is None.
(2) if client_options.client_cert_source
is provided, use the provided one; if the
default client cert source exists, use the default one; otherwise the client cert
source is None.
The API endpoint is determined in the following order:
(1) if client_options.api_endpoint
if provided, use the provided one.
(2) if GOOGLE_API_USE_CLIENT_CERTIFICATE
environment variable is "always", use the
default mTLS endpoint; if the environment 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.
Parameter | |
---|---|
Name | Description |
client_options |
google.api_core.client_options.ClientOptions
Custom options for the client. Only the |
Exceptions | |
---|---|
Type | Description |
google.auth.exceptions.MutualTLSChannelError |
If any errors happen. |
Returns | |
---|---|
Type | Description |
Tuple[str, Callable[[], Tuple[bytes, bytes]]] |
returns the API endpoint and the client cert source to use. |
get_mute_config
get_mute_config(
request: typing.Optional[
typing.Union[
google.cloud.securitycenter_v1.types.securitycenter_service.GetMuteConfigRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.securitycenter_v1.types.mute_config.MuteConfig
Gets a mute config.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import securitycenter_v1
async def sample_get_mute_config():
# Create a client
client = securitycenter_v1.SecurityCenterAsyncClient()
# Initialize request argument(s)
request = securitycenter_v1.GetMuteConfigRequest(
name="name_value",
)
# Make the request
response = await client.get_mute_config(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Optional[Union[google.cloud.securitycenter_v1.types.GetMuteConfigRequest, dict]]
The request object. Request message for retrieving a mute config. |
name |
Required. Name of the mute config to retrieve. Its format is |
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 | |
---|---|
Type | Description |
google.cloud.securitycenter_v1.types.MuteConfig |
A mute config is a Cloud SCC resource that contains the configuration to mute create/update events of findings. |
get_notification_config
get_notification_config(
request: typing.Optional[
typing.Union[
google.cloud.securitycenter_v1.types.securitycenter_service.GetNotificationConfigRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.securitycenter_v1.types.notification_config.NotificationConfig
Gets a notification config.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import securitycenter_v1
async def sample_get_notification_config():
# Create a client
client = securitycenter_v1.SecurityCenterAsyncClient()
# Initialize request argument(s)
request = securitycenter_v1.GetNotificationConfigRequest(
name="name_value",
)
# Make the request
response = await client.get_notification_config(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Optional[Union[google.cloud.securitycenter_v1.types.GetNotificationConfigRequest, dict]]
The request object. Request message for getting a notification config. |
name |
Required. Name of the notification config to get. Its format is |
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 | |
---|---|
Type | Description |
google.cloud.securitycenter_v1.types.NotificationConfig |
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. |
get_operation
get_operation(
request: typing.Optional[
google.longrunning.operations_pb2.GetOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
Parameters | |
---|---|
Name | Description |
request |
The request object. Request message for |
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 | |
---|---|
Type | Description |
|
An Operation object. |
get_organization_settings
get_organization_settings(
request: typing.Optional[
typing.Union[
google.cloud.securitycenter_v1.types.securitycenter_service.GetOrganizationSettingsRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.securitycenter_v1.types.organization_settings.OrganizationSettings
Gets the settings for an organization.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import securitycenter_v1
async def sample_get_organization_settings():
# Create a client
client = securitycenter_v1.SecurityCenterAsyncClient()
# Initialize request argument(s)
request = securitycenter_v1.GetOrganizationSettingsRequest(
name="name_value",
)
# Make the request
response = await client.get_organization_settings(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Optional[Union[google.cloud.securitycenter_v1.types.GetOrganizationSettingsRequest, dict]]
The request object. Request message for getting organization settings. |
name |
Required. Name of the organization to get organization settings for. Its format is |
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 | |
---|---|
Type | Description |
google.cloud.securitycenter_v1.types.OrganizationSettings |
User specified settings that are attached to the Security Command Center organization. |
get_resource_value_config
get_resource_value_config(
request: typing.Optional[
typing.Union[
google.cloud.securitycenter_v1.types.securitycenter_service.GetResourceValueConfigRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.securitycenter_v1.types.resource_value_config.ResourceValueConfig
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_v1
async def sample_get_resource_value_config():
# Create a client
client = securitycenter_v1.SecurityCenterAsyncClient()
# Initialize request argument(s)
request = securitycenter_v1.GetResourceValueConfigRequest(
name="name_value",
)
# Make the request
response = await client.get_resource_value_config(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Optional[Union[google.cloud.securitycenter_v1.types.GetResourceValueConfigRequest, dict]]
The request object. Request message to get resource value config |
name |
Required. Name of the resource value config to retrieve. Its format is |
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 | |
---|---|
Type | Description |
google.cloud.securitycenter_v1.types.ResourceValueConfig |
A resource value configuration (RVC) is a mapping configuration of user's resources to resource values. Used in Attack path simulations. |
get_security_health_analytics_custom_module
get_security_health_analytics_custom_module(
request: typing.Optional[
typing.Union[
google.cloud.securitycenter_v1.types.securitycenter_service.GetSecurityHealthAnalyticsCustomModuleRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.securitycenter_v1.types.security_health_analytics_custom_module.SecurityHealthAnalyticsCustomModule
)
Retrieves a SecurityHealthAnalyticsCustomModule.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import securitycenter_v1
async def sample_get_security_health_analytics_custom_module():
# Create a client
client = securitycenter_v1.SecurityCenterAsyncClient()
# Initialize request argument(s)
request = securitycenter_v1.GetSecurityHealthAnalyticsCustomModuleRequest(
name="name_value",
)
# Make the request
response = await client.get_security_health_analytics_custom_module(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Optional[Union[google.cloud.securitycenter_v1.types.GetSecurityHealthAnalyticsCustomModuleRequest, dict]]
The request object. Request message for getting Security Health Analytics custom modules. |
name |
Required. Name of the custom module to get. Its format is |
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 | |
---|---|
Type | Description |
google.cloud.securitycenter_v1.types.SecurityHealthAnalyticsCustomModule |
Represents an instance of a Security Health Analytics custom module, including its full module name, display name, enablement state, and last updated time. You can create a custom module at the organization, folder, or project level. Custom modules that you create at the organization or folder level are inherited by the child folders and projects. |
get_simulation
get_simulation(
request: typing.Optional[
typing.Union[
google.cloud.securitycenter_v1.types.securitycenter_service.GetSimulationRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.securitycenter_v1.types.simulation.Simulation
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_v1
async def sample_get_simulation():
# Create a client
client = securitycenter_v1.SecurityCenterAsyncClient()
# Initialize request argument(s)
request = securitycenter_v1.GetSimulationRequest(
name="name_value",
)
# Make the request
response = await client.get_simulation(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Optional[Union[google.cloud.securitycenter_v1.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 |
Required. The organization name or simulation name of this simulation Valid format: |
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 | |
---|---|
Type | Description |
google.cloud.securitycenter_v1.types.Simulation |
Attack path simulation |
get_source
get_source(
request: typing.Optional[
typing.Union[
google.cloud.securitycenter_v1.types.securitycenter_service.GetSourceRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.securitycenter_v1.types.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_v1
async def sample_get_source():
# Create a client
client = securitycenter_v1.SecurityCenterAsyncClient()
# Initialize request argument(s)
request = securitycenter_v1.GetSourceRequest(
name="name_value",
)
# Make the request
response = await client.get_source(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Optional[Union[google.cloud.securitycenter_v1.types.GetSourceRequest, dict]]
The request object. Request message for getting a source. |
name |
Required. Relative resource name of the source. Its format is |
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 | |
---|---|
Type | Description |
google.cloud.securitycenter_v1.types.Source |
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. |
get_transport_class
get_transport_class() -> (
typing.Type[
google.cloud.securitycenter_v1.services.security_center.transports.base.SecurityCenterTransport
]
)
Returns an appropriate transport class.
Parameter | |
---|---|
Name | Description |
label |
typing.Optional[str]
The name of the desired transport. If none is provided, then the first transport in the registry is used. |
get_valued_resource
get_valued_resource(
request: typing.Optional[
typing.Union[
google.cloud.securitycenter_v1.types.securitycenter_service.GetValuedResourceRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.securitycenter_v1.types.valued_resource.ValuedResource
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_v1
async def sample_get_valued_resource():
# Create a client
client = securitycenter_v1.SecurityCenterAsyncClient()
# Initialize request argument(s)
request = securitycenter_v1.GetValuedResourceRequest(
name="name_value",
)
# Make the request
response = await client.get_valued_resource(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Optional[Union[google.cloud.securitycenter_v1.types.GetValuedResourceRequest, dict]]
The request object. Request message for getting a valued resource. |
name |
Required. The name of this valued resource Valid format: |
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 | |
---|---|
Type | Description |
google.cloud.securitycenter_v1.types.ValuedResource |
A resource that is determined to have value to a user's system |
group_assets
group_assets(
request: typing.Optional[
typing.Union[
google.cloud.securitycenter_v1.types.securitycenter_service.GroupAssetsRequest,
dict,
]
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.securitycenter_v1.services.security_center.pagers.GroupAssetsAsyncPager
)
Filters an organization's assets and groups them by their specified properties.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import securitycenter_v1
async def sample_group_assets():
# Create a client
client = securitycenter_v1.SecurityCenterAsyncClient()
# Initialize request argument(s)
request = securitycenter_v1.GroupAssetsRequest(
parent="parent_value",
group_by="group_by_value",
)
# Make the request
page_result = client.group_assets(request=request)
# Handle the response
async for response in page_result:
print(response)
Parameters | |
---|---|
Name | Description |
request |
Optional[Union[google.cloud.securitycenter_v1.types.GroupAssetsRequest, dict]]
The request object. Request message for grouping by assets. |
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 | |
---|---|
Type | Description |
google.cloud.securitycenter_v1.services.security_center.pagers.GroupAssetsAsyncPager |
Response message for grouping by assets. Iterating over this object will yield results and resolve additional pages automatically. |
group_findings
group_findings(
request: typing.Optional[
typing.Union[
google.cloud.securitycenter_v1.types.securitycenter_service.GroupFindingsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
group_by: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.securitycenter_v1.services.security_center.pagers.GroupFindingsAsyncPager
)
Filters an organization or source's findings and groups them by their specified properties.
To group across all sources provide a -
as the source id.
Example: /v1/organizations/{organization_id}/sources/-/findings,
/v1/folders/{folder_id}/sources/-/findings,
/v1/projects/{project_id}/sources/-/findings
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import securitycenter_v1
async def sample_group_findings():
# Create a client
client = securitycenter_v1.SecurityCenterAsyncClient()
# Initialize request argument(s)
request = securitycenter_v1.GroupFindingsRequest(
parent="parent_value",
group_by="group_by_value",
)
# Make the request
page_result = client.group_findings(request=request)
# Handle the response
async for response in page_result:
print(response)
Parameters | |
---|---|
Name | Description |
request |
Optional[Union[google.cloud.securitycenter_v1.types.GroupFindingsRequest, dict]]
The request object. Request message for grouping by findings. |
parent |
Required. Name of the source to groupBy. Its format is |
group_by |
Required. Expression that defines what assets fields to use for grouping (including |
retry |
google.api_core.retry_async.AsyncRetry
Designation of what errors, if any, should be retried. |
timeo |