As of January 1, 2020 this library no longer supports Python 2 on the latest released version. Library versions released prior to that date will continue to be available. For more information please visit Python 2 support on Google Cloud.

SecurityCenter¶

class google.cloud.securitycenter_v1beta1.services.security_center.SecurityCenterAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.securitycenter_v1beta1.services.security_center.transports.base.SecurityCenterTransport, typing.Callable[[...], google.cloud.securitycenter_v1beta1.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]¶

V1 Beta 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 when transport is not explicitly provided. Only if this property is not set and transport 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 api_endpoint property still takes precedence; and universe_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: str

static asset_path(organization: str, asset: str) → str¶: Returns a fully-qualified asset string.

static common_billing_account_path(billing_account: str) → str¶: Returns a fully-qualified billing_account string.

static common_folder_path(folder: str) → str¶: Returns a fully-qualified folder 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.

static common_project_path(project: str) → str¶: Returns a fully-qualified project string.

async create_finding(request: Optional[Union[google.cloud.securitycenter_v1beta1.types.securitycenter_service.CreateFindingRequest, dict]] = None, *, parent: Optional[str] = None, finding_id: Optional[str] = None, finding: Optional[google.cloud.securitycenter_v1beta1.types.finding.Finding] = 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_v1beta1.types.finding.Finding[source]¶

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_v1beta1

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

    # Initialize request argument(s)
    request = securitycenter_v1beta1.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_v1beta1.types.CreateFindingRequest, dict]]) – The request object. Request message for creating a finding.
parent (str) –
Required. Resource name of the new finding’s parent. Its format should be “organizations/[organization_id]/sources/[source_id]”.

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

This corresponds to the finding_id field on the request instance; if request is provided, this should not be set.
finding (google.cloud.securitycenter_v1beta1.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 the request instance; if request 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 (security, risk, health or privacy) ingested into Security Command Center for presentation, notification, analysis, policy testing, and enforcement. For example, an XSS vulnerability in an App Engine application is a finding.

Return type

google.cloud.securitycenter_v1beta1.types.Finding

async create_source(request: Optional[Union[google.cloud.securitycenter_v1beta1.types.securitycenter_service.CreateSourceRequest, dict]] = None, *, parent: Optional[str] = None, source: Optional[google.cloud.securitycenter_v1beta1.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_v1beta1.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_v1beta1

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

    # Initialize request argument(s)
    request = securitycenter_v1beta1.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_v1beta1.types.CreateSourceRequest, dict]]) – The request object. Request message for creating a source.
parent (str) –
Required. Resource name of the new source’s parent. Its format should be “organizations/[organization_id]”.

This corresponds to the parent field on the request instance; if request is provided, this should not be set.
source (google.cloud.securitycenter_v1beta1.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 the request instance; if request 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, etc.

Return type

google.cloud.securitycenter_v1beta1.types.Source

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

SecurityCenterAsyncClient

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

SecurityCenterAsyncClient

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

SecurityCenterAsyncClient

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_v1beta1
from google.iam.v1 import iam_policy_pb2  # type: ignore

async def sample_get_iam_policy():
    # Create a client
    client = securitycenter_v1beta1.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 the request instance; if request 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

Tuple[str, Callable[[], Tuple[bytes, bytes]]]

Raises

google.auth.exceptions.MutualTLSChannelError – If any errors happen.

async get_organization_settings(request: Optional[Union[google.cloud.securitycenter_v1beta1.types.securitycenter_service.GetOrganizationSettingsRequest, 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_v1beta1.types.organization_settings.OrganizationSettings[source]¶

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_v1beta1

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

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

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

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.securitycenter_v1beta1.types.GetOrganizationSettingsRequest, dict]]) – The request object. Request message for getting organization settings.
name (str) –
Required. Name of the organization to get organization settings for. Its format is “organizations/[organization_id]/organizationSettings”.

This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_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 settings that are attached to the Security Command Center organization.

Return type

google.cloud.securitycenter_v1beta1.types.OrganizationSettings

async get_source(request: Optional[Union[google.cloud.securitycenter_v1beta1.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_v1beta1.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_v1beta1

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

    # Initialize request argument(s)
    request = securitycenter_v1beta1.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_v1beta1.types.GetSourceRequest, dict]]) – The request object. Request message for getting a source.
name (str) –
Required. Relative resource name of the source. Its format is “organizations/[organization_id]/source/[source_id]”.

This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_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, etc.

Return type

google.cloud.securitycenter_v1beta1.types.Source

classmethod get_transport_class(label: Optional[str] = None) → Type[google.cloud.securitycenter_v1beta1.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 group_assets(request: Optional[Union[google.cloud.securitycenter_v1beta1.types.securitycenter_service.GroupAssetsRequest, dict]] = 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_v1beta1.services.security_center.pagers.GroupAssetsAsyncPager[source]¶

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_v1beta1

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

    # Initialize request argument(s)
    request = securitycenter_v1beta1.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

request (Optional[Union[google.cloud.securitycenter_v1beta1.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

Response message for grouping by assets. Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.securitycenter_v1beta1.services.security_center.pagers.GroupAssetsAsyncPager

async group_findings(request: Optional[Union[google.cloud.securitycenter_v1beta1.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_v1beta1.services.security_center.pagers.GroupFindingsAsyncPager[source]¶

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: /v1beta1/organizations/{organization_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_v1beta1

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

    # Initialize request argument(s)
    request = securitycenter_v1beta1.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_v1beta1.types.GroupFindingsRequest, dict]]) – The request object. Request message for grouping by findings.
parent (str) –
Required. Name of the source to groupBy. Its format is “organizations/[organization_id]/sources/[source_id]”. To groupBy across all sources provide a source_id of -. For example: organizations/{organization_id}/sources/-

This corresponds to the parent field on the request instance; if request is provided, this should not be set.
group_by (str) –
Required. Expression that defines what assets fields to use for grouping (including state). The string value should follow SQL syntax: comma separated list of fields. For example: “parent,resource_name”.

The following fields are supported:
- resource_name
- category
- state
- parent
This corresponds to the group_by field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_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_v1beta1.services.security_center.pagers.GroupFindingsAsyncPager

async list_assets(request: Optional[Union[google.cloud.securitycenter_v1beta1.types.securitycenter_service.ListAssetsRequest, dict]] = 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_v1beta1.services.security_center.pagers.ListAssetsAsyncPager[source]¶

Lists an organization’s assets.

# 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_v1beta1

async def sample_list_assets():
    # Create a client
    client = securitycenter_v1beta1.SecurityCenterAsyncClient()

    # Initialize request argument(s)
    request = securitycenter_v1beta1.ListAssetsRequest(
        parent="parent_value",
    )

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

    # Handle the response
    async for response in page_result:
        print(response)

Parameters

request (Optional[Union[google.cloud.securitycenter_v1beta1.types.ListAssetsRequest, dict]]) – The request object. Request message for listing 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

Response message for listing assets.

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.securitycenter_v1beta1.services.security_center.pagers.ListAssetsAsyncPager

async list_findings(request: Optional[Union[google.cloud.securitycenter_v1beta1.types.securitycenter_service.ListFindingsRequest, dict]] = 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_v1beta1.services.security_center.pagers.ListFindingsAsyncPager[source]¶

Lists an organization or source’s findings.

To list across all sources provide a - as the source id. Example: /v1beta1/organizations/{organization_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_v1beta1

async def sample_list_findings():
    # Create a client
    client = securitycenter_v1beta1.SecurityCenterAsyncClient()

    # Initialize request argument(s)
    request = securitycenter_v1beta1.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_v1beta1.types.ListFindingsRequest, dict]]) – The request object. Request message for listing findings.
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_v1beta1.services.security_center.pagers.ListFindingsAsyncPager

async list_sources(request: Optional[Union[google.cloud.securitycenter_v1beta1.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_v1beta1.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_v1beta1

async def sample_list_sources():
    # Create a client
    client = securitycenter_v1beta1.SecurityCenterAsyncClient()

    # Initialize request argument(s)
    request = securitycenter_v1beta1.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_v1beta1.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]”.

This corresponds to the parent field on the request instance; if request 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_v1beta1.services.security_center.pagers.ListSourcesAsyncPager

static organization_settings_path(organization: str) → str¶: Returns a fully-qualified organization_settings string.

static parse_asset_path(path: str) → Dict[str, str]¶: Parses a asset 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_finding_path(path: str) → Dict[str, str]¶: Parses a finding path into its component segments.

static parse_organization_settings_path(path: str) → Dict[str, str]¶: Parses a organization_settings 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_source_path(path: str) → Dict[str, str]¶: Parses a source path into its component segments.

async run_asset_discovery(request: Optional[Union[google.cloud.securitycenter_v1beta1.types.securitycenter_service.RunAssetDiscoveryRequest, 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]¶

Runs asset discovery. The discovery is tracked with a long-running operation.

This API can only be called with limited frequency for an organization. If it is called too frequently the caller will receive a TOO_MANY_REQUESTS error.

# 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_v1beta1

async def sample_run_asset_discovery():
    # Create a client
    client = securitycenter_v1beta1.SecurityCenterAsyncClient()

    # Initialize request argument(s)
    request = securitycenter_v1beta1.RunAssetDiscoveryRequest(
        parent="parent_value",
    )

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

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

    response = (await operation).result()

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.securitycenter_v1beta1.types.RunAssetDiscoveryRequest, dict]]) – The request object. Request message for running asset discovery for an organization.
parent (str) –
Required. Name of the organization to run asset discovery for. Its format is “organizations/[organization_id]”.

This corresponds to the parent field on the request instance; if request is provided, this should not be set.
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.protobuf.empty_pb2.Empty A generic empty message that you can re-use to avoid defining duplicated

empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance:

service Foo {
rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);

}

Return type

google.api_core.operation_async.AsyncOperation

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_v1beta1.types.securitycenter_service.SetFindingStateRequest, dict]] = None, *, name: Optional[str] = None, state: Optional[google.cloud.securitycenter_v1beta1.types.finding.Finding.State] = None, start_time: Optional[google.protobuf.timestamp_pb2.Timestamp] = 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_v1beta1.types.finding.Finding[source]¶

Updates the state of a finding.

# 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_v1beta1

async def sample_set_finding_state():
    # Create a client
    client = securitycenter_v1beta1.SecurityCenterAsyncClient()

    # Initialize request argument(s)
    request = securitycenter_v1beta1.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_v1beta1.types.SetFindingStateRequest, dict]]) – The request object. Request message for updating a finding’s state.
name (str) –
Required. The relative resource name of the finding. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: “organizations/{organization_id}/sources/{source_id}/finding/{finding_id}”.

This corresponds to the name field on the request instance; if request is provided, this should not be set.
state (google.cloud.securitycenter_v1beta1.types.Finding.State) –
Required. The desired State of the finding.

This corresponds to the state field on the request instance; if request is provided, this should not be set.
start_time (google.protobuf.timestamp_pb2.Timestamp) –
Required. The time at which the updated state takes effect.

This corresponds to the start_time field on the request instance; if request 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 (security, risk, health or privacy) ingested into Security Command Center for presentation, notification, analysis, policy testing, and enforcement. For example, an XSS vulnerability in an App Engine application is a finding.

Return type

google.cloud.securitycenter_v1beta1.types.Finding

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_v1beta1
from google.iam.v1 import iam_policy_pb2  # type: ignore

async def sample_set_iam_policy():
    # Create a client
    client = securitycenter_v1beta1.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 the request instance; if request 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

static source_path(organization: str, source: str) → str¶: Returns a fully-qualified source 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_v1beta1
from google.iam.v1 import iam_policy_pb2  # type: ignore

async def sample_test_iam_permissions():
    # Create a client
    client = securitycenter_v1beta1.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 the request instance; if request 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 the request instance; if request 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_v1beta1.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

str

async update_finding(request: Optional[Union[google.cloud.securitycenter_v1beta1.types.securitycenter_service.UpdateFindingRequest, dict]] = None, *, finding: Optional[google.cloud.securitycenter_v1beta1.types.finding.Finding] = 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_v1beta1.types.finding.Finding[source]¶

Creates or updates a finding. 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_v1beta1

async def sample_update_finding():
    # Create a client
    client = securitycenter_v1beta1.SecurityCenterAsyncClient()

    # Initialize request argument(s)
    request = securitycenter_v1beta1.UpdateFindingRequest(
    )

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

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.securitycenter_v1beta1.types.UpdateFindingRequest, dict]]) – The request object. Request message for updating or creating a finding.
finding (google.cloud.securitycenter_v1beta1.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 alphanumeric and less than or equal to 32 characters and greater than 0 characters in length.

This corresponds to the finding field on the request instance; if request 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 (security, risk, health or privacy) ingested into Security Command Center for presentation, notification, analysis, policy testing, and enforcement. For example, an XSS vulnerability in an App Engine application is a finding.

Return type

google.cloud.securitycenter_v1beta1.types.Finding

async update_organization_settings(request: Optional[Union[google.cloud.securitycenter_v1beta1.types.securitycenter_service.UpdateOrganizationSettingsRequest, dict]] = None, *, organization_settings: Optional[google.cloud.securitycenter_v1beta1.types.organization_settings.OrganizationSettings] = 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_v1beta1.types.organization_settings.OrganizationSettings[source]¶

Updates an organization’s settings.

# 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_v1beta1

async def sample_update_organization_settings():
    # Create a client
    client = securitycenter_v1beta1.SecurityCenterAsyncClient()

    # Initialize request argument(s)
    request = securitycenter_v1beta1.UpdateOrganizationSettingsRequest(
    )

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

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.securitycenter_v1beta1.types.UpdateOrganizationSettingsRequest, dict]]) – The request object. Request message for updating an organization’s settings.
organization_settings (google.cloud.securitycenter_v1beta1.types.OrganizationSettings) –
Required. The organization settings resource to update.

This corresponds to the organization_settings field on the request instance; if request 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 settings that are attached to the Security Command Center organization.

Return type

google.cloud.securitycenter_v1beta1.types.OrganizationSettings

async update_security_marks(request: Optional[Union[google.cloud.securitycenter_v1beta1.types.securitycenter_service.UpdateSecurityMarksRequest, dict]] = None, *, security_marks: Optional[google.cloud.securitycenter_v1beta1.types.security_marks.SecurityMarks] = 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_v1beta1.types.security_marks.SecurityMarks[source]¶

Updates security marks.

# 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_v1beta1

async def sample_update_security_marks():
    # Create a client
    client = securitycenter_v1beta1.SecurityCenterAsyncClient()

    # Initialize request argument(s)
    request = securitycenter_v1beta1.UpdateSecurityMarksRequest(
    )

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

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.securitycenter_v1beta1.types.UpdateSecurityMarksRequest, dict]]) – The request object. Request message for updating a SecurityMarks resource.
security_marks (google.cloud.securitycenter_v1beta1.types.SecurityMarks) –
Required. The security marks resource to update.

This corresponds to the security_marks field on the request instance; if request 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

google.cloud.securitycenter_v1beta1.types.SecurityMarks

async update_source(request: Optional[Union[google.cloud.securitycenter_v1beta1.types.securitycenter_service.UpdateSourceRequest, dict]] = None, *, source: Optional[google.cloud.securitycenter_v1beta1.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_v1beta1.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_v1beta1

async def sample_update_source():
    # Create a client
    client = securitycenter_v1beta1.SecurityCenterAsyncClient()

    # Initialize request argument(s)
    request = securitycenter_v1beta1.UpdateSourceRequest(
    )

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

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.securitycenter_v1beta1.types.UpdateSourceRequest, dict]]) – The request object. Request message for updating a source.
source (google.cloud.securitycenter_v1beta1.types.Source) –
Required. The source resource to update.

This corresponds to the source field on the request instance; if request 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, etc.

Return type

google.cloud.securitycenter_v1beta1.types.Source

class google.cloud.securitycenter_v1beta1.services.security_center.SecurityCenterClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.securitycenter_v1beta1.services.security_center.transports.base.SecurityCenterTransport, typing.Callable[[...], google.cloud.securitycenter_v1beta1.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]¶

V1 Beta 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 when transport is not explicitly provided. Only if this property is not set and transport 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 the api_endpoint property still takes precedence; and universe_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: str

static asset_path(organization: str, asset: str) → str[source]¶: Returns a fully-qualified asset string.

static common_billing_account_path(billing_account: str) → str[source]¶: Returns a fully-qualified billing_account string.

static common_folder_path(folder: str) → str[source]¶: Returns a fully-qualified folder 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.

static common_project_path(project: str) → str[source]¶: Returns a fully-qualified project string.

create_finding(request: Optional[Union[google.cloud.securitycenter_v1beta1.types.securitycenter_service.CreateFindingRequest, dict]] = None, *, parent: Optional[str] = None, finding_id: Optional[str] = None, finding: Optional[google.cloud.securitycenter_v1beta1.types.finding.Finding] = 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_v1beta1.types.finding.Finding[source]¶

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_v1beta1

def sample_create_finding():
    # Create a client
    client = securitycenter_v1beta1.SecurityCenterClient()

    # Initialize request argument(s)
    request = securitycenter_v1beta1.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_v1beta1.types.CreateFindingRequest, dict]) – The request object. Request message for creating a finding.
parent (str) –
Required. Resource name of the new finding’s parent. Its format should be “organizations/[organization_id]/sources/[source_id]”.

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

This corresponds to the finding_id field on the request instance; if request is provided, this should not be set.
finding (google.cloud.securitycenter_v1beta1.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 the request instance; if request is provided, this should not be set.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Security Command Center finding.

A finding is a record of assessment data (security, risk, health or privacy) ingested into Security Command Center for presentation, notification, analysis, policy testing, and enforcement. For example, an XSS vulnerability in an App Engine application is a finding.

Return type

google.cloud.securitycenter_v1beta1.types.Finding

create_source(request: Optional[Union[google.cloud.securitycenter_v1beta1.types.securitycenter_service.CreateSourceRequest, dict]] = None, *, parent: Optional[str] = None, source: Optional[google.cloud.securitycenter_v1beta1.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_v1beta1.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_v1beta1

def sample_create_source():
    # Create a client
    client = securitycenter_v1beta1.SecurityCenterClient()

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

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

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.securitycenter_v1beta1.types.CreateSourceRequest, dict]) – The request object. Request message for creating a source.
parent (str) –
Required. Resource name of the new source’s parent. Its format should be “organizations/[organization_id]”.

This corresponds to the parent field on the request instance; if request is provided, this should not be set.
source (google.cloud.securitycenter_v1beta1.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 the request instance; if request is provided, this should not be set.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

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, etc.

Return type

google.cloud.securitycenter_v1beta1.types.Source

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

SecurityCenterClient

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

SecurityCenterClient

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

SecurityCenterClient

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_v1beta1
from google.iam.v1 import iam_policy_pb2  # type: ignore

def sample_get_iam_policy():
    # Create a client
    client = securitycenter_v1beta1.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 the request instance; if request is provided, this should not be set.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

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

Tuple[str, Callable[[], Tuple[bytes, bytes]]]

Raises

google.auth.exceptions.MutualTLSChannelError – If any errors happen.

get_organization_settings(request: Optional[Union[google.cloud.securitycenter_v1beta1.types.securitycenter_service.GetOrganizationSettingsRequest, 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_v1beta1.types.organization_settings.OrganizationSettings[source]¶

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_v1beta1

def sample_get_organization_settings():
    # Create a client
    client = securitycenter_v1beta1.SecurityCenterClient()

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

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

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.securitycenter_v1beta1.types.GetOrganizationSettingsRequest, dict]) – The request object. Request message for getting organization settings.
name (str) –
Required. Name of the organization to get organization settings for. Its format is “organizations/[organization_id]/organizationSettings”.

This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

User specified settings that are attached to the Security Command Center organization.

Return type

google.cloud.securitycenter_v1beta1.types.OrganizationSettings

get_source(request: Optional[Union[google.cloud.securitycenter_v1beta1.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_v1beta1.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_v1beta1

def sample_get_source():
    # Create a client
    client = securitycenter_v1beta1.SecurityCenterClient()

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

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

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.securitycenter_v1beta1.types.GetSourceRequest, dict]) – The request object. Request message for getting a source.
name (str) –
Required. Relative resource name of the source. Its format is “organizations/[organization_id]/source/[source_id]”.

This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

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, etc.

Return type

google.cloud.securitycenter_v1beta1.types.Source

group_assets(request: Optional[Union[google.cloud.securitycenter_v1beta1.types.securitycenter_service.GroupAssetsRequest, dict]] = 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_v1beta1.services.security_center.pagers.GroupAssetsPager[source]¶

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_v1beta1

def sample_group_assets():
    # Create a client
    client = securitycenter_v1beta1.SecurityCenterClient()

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

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

    # Handle the response
    for response in page_result:
        print(response)

Parameters

request (Union[google.cloud.securitycenter_v1beta1.types.GroupAssetsRequest, dict]) – The request object. Request message for grouping by assets.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Response message for grouping by assets. Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.securitycenter_v1beta1.services.security_center.pagers.GroupAssetsPager

group_findings(request: Optional[Union[google.cloud.securitycenter_v1beta1.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_v1beta1.services.security_center.pagers.GroupFindingsPager[source]¶

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: /v1beta1/organizations/{organization_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_v1beta1

def sample_group_findings():
    # Create a client
    client = securitycenter_v1beta1.SecurityCenterClient()

    # Initialize request argument(s)
    request = securitycenter_v1beta1.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_v1beta1.types.GroupFindingsRequest, dict]) – The request object. Request message for grouping by findings.
parent (str) –
Required. Name of the source to groupBy. Its format is “organizations/[organization_id]/sources/[source_id]”. To groupBy across all sources provide a source_id of -. For example: organizations/{organization_id}/sources/-

This corresponds to the parent field on the request instance; if request is provided, this should not be set.
group_by (str) –
Required. Expression that defines what assets fields to use for grouping (including state). The string value should follow SQL syntax: comma separated list of fields. For example: “parent,resource_name”.

The following fields are supported:
- resource_name
- category
- state
- parent
This corresponds to the group_by field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Response message for group by findings. Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.securitycenter_v1beta1.services.security_center.pagers.GroupFindingsPager

list_assets(request: Optional[Union[google.cloud.securitycenter_v1beta1.types.securitycenter_service.ListAssetsRequest, dict]] = 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_v1beta1.services.security_center.pagers.ListAssetsPager[source]¶

Lists an organization’s assets.

# 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_v1beta1

def sample_list_assets():
    # Create a client
    client = securitycenter_v1beta1.SecurityCenterClient()

    # Initialize request argument(s)
    request = securitycenter_v1beta1.ListAssetsRequest(
        parent="parent_value",
    )

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

    # Handle the response
    for response in page_result:
        print(response)

Parameters

request (Union[google.cloud.securitycenter_v1beta1.types.ListAssetsRequest, dict]) – The request object. Request message for listing assets.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Response message for listing assets.

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.securitycenter_v1beta1.services.security_center.pagers.ListAssetsPager

list_findings(request: Optional[Union[google.cloud.securitycenter_v1beta1.types.securitycenter_service.ListFindingsRequest, dict]] = 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_v1beta1.services.security_center.pagers.ListFindingsPager[source]¶

Lists an organization or source’s findings.

To list across all sources provide a - as the source id. Example: /v1beta1/organizations/{organization_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_v1beta1

def sample_list_findings():
    # Create a client
    client = securitycenter_v1beta1.SecurityCenterClient()

    # Initialize request argument(s)
    request = securitycenter_v1beta1.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_v1beta1.types.ListFindingsRequest, dict]) – The request object. Request message for listing findings.
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_v1beta1.services.security_center.pagers.ListFindingsPager

list_sources(request: Optional[Union[google.cloud.securitycenter_v1beta1.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_v1beta1.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_v1beta1

def sample_list_sources():
    # Create a client
    client = securitycenter_v1beta1.SecurityCenterClient()

    # Initialize request argument(s)
    request = securitycenter_v1beta1.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_v1beta1.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]”.

This corresponds to the parent field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Response message for listing sources.

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.securitycenter_v1beta1.services.security_center.pagers.ListSourcesPager

static organization_settings_path(organization: str) → str[source]¶: Returns a fully-qualified organization_settings string.

static parse_asset_path(path: str) → Dict[str, str][source]¶: Parses a asset 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_finding_path(path: str) → Dict[str, str][source]¶: Parses a finding path into its component segments.

static parse_organization_settings_path(path: str) → Dict[str, str][source]¶: Parses a organization_settings 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_source_path(path: str) → Dict[str, str][source]¶: Parses a source path into its component segments.

run_asset_discovery(request: Optional[Union[google.cloud.securitycenter_v1beta1.types.securitycenter_service.RunAssetDiscoveryRequest, 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]¶

Runs asset discovery. The discovery is tracked with a long-running operation.

This API can only be called with limited frequency for an organization. If it is called too frequently the caller will receive a TOO_MANY_REQUESTS error.

# 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_v1beta1

def sample_run_asset_discovery():
    # Create a client
    client = securitycenter_v1beta1.SecurityCenterClient()

    # Initialize request argument(s)
    request = securitycenter_v1beta1.RunAssetDiscoveryRequest(
        parent="parent_value",
    )

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

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

    response = operation.result()

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.securitycenter_v1beta1.types.RunAssetDiscoveryRequest, dict]) – The request object. Request message for running asset discovery for an organization.
parent (str) –
Required. Name of the organization to run asset discovery for. Its format is “organizations/[organization_id]”.

This corresponds to the parent field on the request instance; if request is provided, this should not be set.
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.protobuf.empty_pb2.Empty A generic empty message that you can re-use to avoid defining duplicated

empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance:

service Foo {
rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);

}

Return type

google.api_core.operation.Operation

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_v1beta1.types.securitycenter_service.SetFindingStateRequest, dict]] = None, *, name: Optional[str] = None, state: Optional[google.cloud.securitycenter_v1beta1.types.finding.Finding.State] = None, start_time: Optional[google.protobuf.timestamp_pb2.Timestamp] = 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_v1beta1.types.finding.Finding[source]¶

Updates the state of a finding.

# 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_v1beta1

def sample_set_finding_state():
    # Create a client
    client = securitycenter_v1beta1.SecurityCenterClient()

    # Initialize request argument(s)
    request = securitycenter_v1beta1.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_v1beta1.types.SetFindingStateRequest, dict]) – The request object. Request message for updating a finding’s state.
name (str) –
Required. The relative resource name of the finding. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: “organizations/{organization_id}/sources/{source_id}/finding/{finding_id}”.

This corresponds to the name field on the request instance; if request is provided, this should not be set.
state (google.cloud.securitycenter_v1beta1.types.Finding.State) –
Required. The desired State of the finding.

This corresponds to the state field on the request instance; if request is provided, this should not be set.
start_time (google.protobuf.timestamp_pb2.Timestamp) –
Required. The time at which the updated state takes effect.

This corresponds to the start_time field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Security Command Center finding.

A finding is a record of assessment data (security, risk, health or privacy) ingested into Security Command Center for presentation, notification, analysis, policy testing, and enforcement. For example, an XSS vulnerability in an App Engine application is a finding.

Return type

google.cloud.securitycenter_v1beta1.types.Finding

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_v1beta1
from google.iam.v1 import iam_policy_pb2  # type: ignore

def sample_set_iam_policy():
    # Create a client
    client = securitycenter_v1beta1.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 the request instance; if request is provided, this should not be set.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

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

static source_path(organization: str, source: str) → str[source]¶: Returns a fully-qualified source 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_v1beta1
from google.iam.v1 import iam_policy_pb2  # type: ignore

def sample_test_iam_permissions():
    # Create a client
    client = securitycenter_v1beta1.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 the request instance; if request 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 the request instance; if request is provided, this should not be set.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Response message for TestIamPermissions method.

Return type

google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse

property transport: google.cloud.securitycenter_v1beta1.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: str

update_finding(request: Optional[Union[google.cloud.securitycenter_v1beta1.types.securitycenter_service.UpdateFindingRequest, dict]] = None, *, finding: Optional[google.cloud.securitycenter_v1beta1.types.finding.Finding] = 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_v1beta1.types.finding.Finding[source]¶

Creates or updates a finding. 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_v1beta1

def sample_update_finding():
    # Create a client
    client = securitycenter_v1beta1.SecurityCenterClient()

    # Initialize request argument(s)
    request = securitycenter_v1beta1.UpdateFindingRequest(
    )

    # Make the request
    response = client.update_finding(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.securitycenter_v1beta1.types.UpdateFindingRequest, dict]) – The request object. Request message for updating or creating a finding.
finding (google.cloud.securitycenter_v1beta1.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 alphanumeric and less than or equal to 32 characters and greater than 0 characters in length.

This corresponds to the finding field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Security Command Center finding.

A finding is a record of assessment data (security, risk, health or privacy) ingested into Security Command Center for presentation, notification, analysis, policy testing, and enforcement. For example, an XSS vulnerability in an App Engine application is a finding.

Return type

google.cloud.securitycenter_v1beta1.types.Finding

update_organization_settings(request: Optional[Union[google.cloud.securitycenter_v1beta1.types.securitycenter_service.UpdateOrganizationSettingsRequest, dict]] = None, *, organization_settings: Optional[google.cloud.securitycenter_v1beta1.types.organization_settings.OrganizationSettings] = 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_v1beta1.types.organization_settings.OrganizationSettings[source]¶

Updates an organization’s settings.

# 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_v1beta1

def sample_update_organization_settings():
    # Create a client
    client = securitycenter_v1beta1.SecurityCenterClient()

    # Initialize request argument(s)
    request = securitycenter_v1beta1.UpdateOrganizationSettingsRequest(
    )

    # Make the request
    response = client.update_organization_settings(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.securitycenter_v1beta1.types.UpdateOrganizationSettingsRequest, dict]) – The request object. Request message for updating an organization’s settings.
organization_settings (google.cloud.securitycenter_v1beta1.types.OrganizationSettings) –
Required. The organization settings resource to update.

This corresponds to the organization_settings field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

User specified settings that are attached to the Security Command Center organization.

Return type

google.cloud.securitycenter_v1beta1.types.OrganizationSettings

update_security_marks(request: Optional[Union[google.cloud.securitycenter_v1beta1.types.securitycenter_service.UpdateSecurityMarksRequest, dict]] = None, *, security_marks: Optional[google.cloud.securitycenter_v1beta1.types.security_marks.SecurityMarks] = 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_v1beta1.types.security_marks.SecurityMarks[source]¶

Updates security marks.

# 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_v1beta1

def sample_update_security_marks():
    # Create a client
    client = securitycenter_v1beta1.SecurityCenterClient()

    # Initialize request argument(s)
    request = securitycenter_v1beta1.UpdateSecurityMarksRequest(
    )

    # Make the request
    response = client.update_security_marks(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.securitycenter_v1beta1.types.UpdateSecurityMarksRequest, dict]) – The request object. Request message for updating a SecurityMarks resource.
security_marks (google.cloud.securitycenter_v1beta1.types.SecurityMarks) –
Required. The security marks resource to update.

This corresponds to the security_marks field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

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

google.cloud.securitycenter_v1beta1.types.SecurityMarks

update_source(request: Optional[Union[google.cloud.securitycenter_v1beta1.types.securitycenter_service.UpdateSourceRequest, dict]] = None, *, source: Optional[google.cloud.securitycenter_v1beta1.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_v1beta1.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_v1beta1

def sample_update_source():
    # Create a client
    client = securitycenter_v1beta1.SecurityCenterClient()

    # Initialize request argument(s)
    request = securitycenter_v1beta1.UpdateSourceRequest(
    )

    # Make the request
    response = client.update_source(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.securitycenter_v1beta1.types.UpdateSourceRequest, dict]) – The request object. Request message for updating a source.
source (google.cloud.securitycenter_v1beta1.types.Source) –
Required. The source resource to update.

This corresponds to the source field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

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, etc.

Return type

google.cloud.securitycenter_v1beta1.types.Source

class google.cloud.securitycenter_v1beta1.services.security_center.pagers.GroupAssetsAsyncPager(method: Callable[[...], Awaitable[google.cloud.securitycenter_v1beta1.types.securitycenter_service.GroupAssetsResponse]], request: google.cloud.securitycenter_v1beta1.types.securitycenter_service.GroupAssetsRequest, response: google.cloud.securitycenter_v1beta1.types.securitycenter_service.GroupAssetsResponse, *, 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_assets requests.

This class thinly wraps an initial google.cloud.securitycenter_v1beta1.types.GroupAssetsResponse object, and provides an __aiter__ method to iterate through its group_by_results field.

If there are more pages, the __aiter__ method will make additional GroupAssets requests and continue to iterate through the group_by_results field on the corresponding responses.

All the usual google.cloud.securitycenter_v1beta1.types.GroupAssetsResponse 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_v1beta1.types.GroupAssetsRequest) – The initial request object.
response (google.cloud.securitycenter_v1beta1.types.GroupAssetsResponse) – 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_v1beta1.services.security_center.pagers.GroupAssetsPager(method: Callable[[...], google.cloud.securitycenter_v1beta1.types.securitycenter_service.GroupAssetsResponse], request: google.cloud.securitycenter_v1beta1.types.securitycenter_service.GroupAssetsRequest, response: google.cloud.securitycenter_v1beta1.types.securitycenter_service.GroupAssetsResponse, *, 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_assets requests.

This class thinly wraps an initial google.cloud.securitycenter_v1beta1.types.GroupAssetsResponse object, and provides an __iter__ method to iterate through its group_by_results field.

If there are more pages, the __iter__ method will make additional GroupAssets requests and continue to iterate through the group_by_results field on the corresponding responses.

All the usual google.cloud.securitycenter_v1beta1.types.GroupAssetsResponse 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_v1beta1.types.GroupAssetsRequest) – The initial request object.
response (google.cloud.securitycenter_v1beta1.types.GroupAssetsResponse) – 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_v1beta1.services.security_center.pagers.GroupFindingsAsyncPager(method: Callable[[...], Awaitable[google.cloud.securitycenter_v1beta1.types.securitycenter_service.GroupFindingsResponse]], request: google.cloud.securitycenter_v1beta1.types.securitycenter_service.GroupFindingsRequest, response: google.cloud.securitycenter_v1beta1.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_v1beta1.types.GroupFindingsResponse object, and provides an __aiter__ method to iterate through its group_by_results field.

If there are more pages, the __aiter__ method will make additional GroupFindings requests and continue to iterate through the group_by_results field on the corresponding responses.

All the usual google.cloud.securitycenter_v1beta1.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_v1beta1.types.GroupFindingsRequest) – The initial request object.
response (google.cloud.securitycenter_v1beta1.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_v1beta1.services.security_center.pagers.GroupFindingsPager(method: Callable[[...], google.cloud.securitycenter_v1beta1.types.securitycenter_service.GroupFindingsResponse], request: google.cloud.securitycenter_v1beta1.types.securitycenter_service.GroupFindingsRequest, response: google.cloud.securitycenter_v1beta1.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_v1beta1.types.GroupFindingsResponse object, and provides an __iter__ method to iterate through its group_by_results field.

If there are more pages, the __iter__ method will make additional GroupFindings requests and continue to iterate through the group_by_results field on the corresponding responses.

All the usual google.cloud.securitycenter_v1beta1.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_v1beta1.types.GroupFindingsRequest) – The initial request object.
response (google.cloud.securitycenter_v1beta1.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_v1beta1.services.security_center.pagers.ListAssetsAsyncPager(method: Callable[[...], Awaitable[google.cloud.securitycenter_v1beta1.types.securitycenter_service.ListAssetsResponse]], request: google.cloud.securitycenter_v1beta1.types.securitycenter_service.ListAssetsRequest, response: google.cloud.securitycenter_v1beta1.types.securitycenter_service.ListAssetsResponse, *, 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_assets requests.

This class thinly wraps an initial google.cloud.securitycenter_v1beta1.types.ListAssetsResponse object, and provides an __aiter__ method to iterate through its list_assets_results field.

If there are more pages, the __aiter__ method will make additional ListAssets requests and continue to iterate through the list_assets_results field on the corresponding responses.

All the usual google.cloud.securitycenter_v1beta1.types.ListAssetsResponse 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_v1beta1.types.ListAssetsRequest) – The initial request object.
response (google.cloud.securitycenter_v1beta1.types.ListAssetsResponse) – 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_v1beta1.services.security_center.pagers.ListAssetsPager(method: Callable[[...], google.cloud.securitycenter_v1beta1.types.securitycenter_service.ListAssetsResponse], request: google.cloud.securitycenter_v1beta1.types.securitycenter_service.ListAssetsRequest, response: google.cloud.securitycenter_v1beta1.types.securitycenter_service.ListAssetsResponse, *, 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_assets requests.

This class thinly wraps an initial google.cloud.securitycenter_v1beta1.types.ListAssetsResponse object, and provides an __iter__ method to iterate through its list_assets_results field.

If there are more pages, the __iter__ method will make additional ListAssets requests and continue to iterate through the list_assets_results field on the corresponding responses.

All the usual google.cloud.securitycenter_v1beta1.types.ListAssetsResponse 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_v1beta1.types.ListAssetsRequest) – The initial request object.
response (google.cloud.securitycenter_v1beta1.types.ListAssetsResponse) – 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_v1beta1.services.security_center.pagers.ListFindingsAsyncPager(method: Callable[[...], Awaitable[google.cloud.securitycenter_v1beta1.types.securitycenter_service.ListFindingsResponse]], request: google.cloud.securitycenter_v1beta1.types.securitycenter_service.ListFindingsRequest, response: google.cloud.securitycenter_v1beta1.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_v1beta1.types.ListFindingsResponse object, and provides an __aiter__ method to iterate through its findings field.

If there are more pages, the __aiter__ method will make additional ListFindings requests and continue to iterate through the findings field on the corresponding responses.

All the usual google.cloud.securitycenter_v1beta1.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_v1beta1.types.ListFindingsRequest) – The initial request object.
response (google.cloud.securitycenter_v1beta1.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_v1beta1.services.security_center.pagers.ListFindingsPager(method: Callable[[...], google.cloud.securitycenter_v1beta1.types.securitycenter_service.ListFindingsResponse], request: google.cloud.securitycenter_v1beta1.types.securitycenter_service.ListFindingsRequest, response: google.cloud.securitycenter_v1beta1.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_v1beta1.types.ListFindingsResponse object, and provides an __iter__ method to iterate through its findings field.

If there are more pages, the __iter__ method will make additional ListFindings requests and continue to iterate through the findings field on the corresponding responses.

All the usual google.cloud.securitycenter_v1beta1.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_v1beta1.types.ListFindingsRequest) – The initial request object.
response (google.cloud.securitycenter_v1beta1.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_v1beta1.services.security_center.pagers.ListSourcesAsyncPager(method: Callable[[...], Awaitable[google.cloud.securitycenter_v1beta1.types.securitycenter_service.ListSourcesResponse]], request: google.cloud.securitycenter_v1beta1.types.securitycenter_service.ListSourcesRequest, response: google.cloud.securitycenter_v1beta1.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_v1beta1.types.ListSourcesResponse object, and provides an __aiter__ method to iterate through its sources field.

If there are more pages, the __aiter__ method will make additional ListSources requests and continue to iterate through the sources field on the corresponding responses.

All the usual google.cloud.securitycenter_v1beta1.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_v1beta1.types.ListSourcesRequest) – The initial request object.
response (google.cloud.securitycenter_v1beta1.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_v1beta1.services.security_center.pagers.ListSourcesPager(method: Callable[[...], google.cloud.securitycenter_v1beta1.types.securitycenter_service.ListSourcesResponse], request: google.cloud.securitycenter_v1beta1.types.securitycenter_service.ListSourcesRequest, response: google.cloud.securitycenter_v1beta1.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_v1beta1.types.ListSourcesResponse object, and provides an __iter__ method to iterate through its sources field.

If there are more pages, the __iter__ method will make additional ListSources requests and continue to iterate through the sources field on the corresponding responses.

All the usual google.cloud.securitycenter_v1beta1.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_v1beta1.types.ListSourcesRequest) – The initial request object.
response (google.cloud.securitycenter_v1beta1.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.

SecurityCenter¶

google-cloud-securitycenter

Navigation

Related Topics