Class ConfigClient (0.2.0) 

ConfigClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.cloudsecuritycompliance_v1.services.config.transports.base.ConfigTransport, typing.Callable[[...], google.cloud.cloudsecuritycompliance_v1.services.config.transports.base.ConfigTransport]]] = 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>)

Config Service manages compliance frameworks, cloud controls, and their configurations.

Properties

api_endpoint

Return the API endpoint used by the client instance.

Returns
Type Description
str The API endpoint used by the client instance.

transport

Returns the transport used by the client instance.

Returns
Type Description
ConfigTransport The transport used by the client instance.

universe_domain

Return the universe domain used by the client instance.

Returns
Type Description
str The universe domain used by the client instance.

Methods

ConfigClient

ConfigClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.cloudsecuritycompliance_v1.services.config.transports.base.ConfigTransport, typing.Callable[[...], google.cloud.cloudsecuritycompliance_v1.services.config.transports.base.ConfigTransport]]] = 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>)

Instantiates the config client.

Parameters
Name Description
credentials Optional[google.auth.credentials.Credentials]

The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment.
transport Optional[Union[str,ConfigTransport,Callable[..., ConfigTransport]]]

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 ConfigTransport 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.
Exceptions
Type Description
google.auth.exceptions.MutualTLSChannelError If mutual TLS transport creation failed for any reason.

__exit__

__exit__(type, value, traceback)

Releases underlying transport's resources.

cancel_operation

cancel_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.CancelOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> None

Starts asynchronous cancellation on a long-running operation.

The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

Parameters
Name Description
request .operations_pb2.CancelOperationRequest

The request object. Request message for CancelOperation method.
retry google.api_core.retry.Retry

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

The timeout for this request.
metadata Sequence[Tuple[str, Union[str, bytes]]]

Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

cloud_control_path

cloud_control_path(organization: str, location: str, cloud_control: str) -> str

Returns a fully-qualified cloud_control string.

common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

common_location_path

common_location_path(project: str, location: str) -> str

Returns a fully-qualified location string.

common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

create_cloud_control

create_cloud_control(
    request: typing.Optional[
        typing.Union[
            google.cloud.cloudsecuritycompliance_v1.types.config.CreateCloudControlRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    cloud_control: typing.Optional[
        google.cloud.cloudsecuritycompliance_v1.types.common.CloudControl
    ] = None,
    cloud_control_id: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.cloudsecuritycompliance_v1.types.common.CloudControl

Creates a new CloudControl with type Custom under a given parent resource. Built-in CloudControls are managed by Google and cannot be created through this API.

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

def sample_create_cloud_control():
    # Create a client
    client = cloudsecuritycompliance_v1.ConfigClient()

    # Initialize request argument(s)
    cloud_control = cloudsecuritycompliance_v1.CloudControl()
    cloud_control.name = "name_value"

    request = cloudsecuritycompliance_v1.CreateCloudControlRequest(
        parent="parent_value",
        cloud_control_id="cloud_control_id_value",
        cloud_control=cloud_control,
    )

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

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.cloudsecuritycompliance_v1.types.CreateCloudControlRequest, dict]

The request object. Request message for creating a CloudControl
parent str

Required. The parent resource name, in the format organizations/{organization}/locations/{location}. This corresponds to the parent field on the request instance; if request is provided, this should not be set.
cloud_control google.cloud.cloudsecuritycompliance_v1.types.CloudControl

Required. The resource being created This corresponds to the cloud_control field on the request instance; if request is provided, this should not be set.
cloud_control_id str

Required. ID of the CloudControl. This is the last segment of the CloudControl resource name. Format: ^a-zA-Z][a-zA-Z0-9-]{0,61}[a-zA-Z0-9]$. This corresponds to the cloud_control_id field on the request instance; if request is provided, this should not be set.
retry google.api_core.retry.Retry

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

The timeout for this request.
metadata Sequence[Tuple[str, Union[str, bytes]]]

Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.
Returns
Type Description
google.cloud.cloudsecuritycompliance_v1.types.CloudControl A CloudControl is the fundamental unit encapsulating the rules to meet a specific security or compliance intent. It can contain various rule types (like Organization Policies, CEL expressions, etc.) enabling different enforcement modes (Preventive, Detective, Audit). CloudControls are often parameterized for reusability and can be either BUILT_IN (provided by Google) or CUSTOM (defined by the user).

create_framework

create_framework(
    request: typing.Optional[
        typing.Union[
            google.cloud.cloudsecuritycompliance_v1.types.config.CreateFrameworkRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    framework: typing.Optional[
        google.cloud.cloudsecuritycompliance_v1.types.common.Framework
    ] = None,
    framework_id: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.cloudsecuritycompliance_v1.types.common.Framework

Creates a new Framework with type Custom under a given parent resource. Frameworks with type Built-in are managed by Google and cannot be created through this API.

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

def sample_create_framework():
    # Create a client
    client = cloudsecuritycompliance_v1.ConfigClient()

    # Initialize request argument(s)
    framework = cloudsecuritycompliance_v1.Framework()
    framework.name = "name_value"

    request = cloudsecuritycompliance_v1.CreateFrameworkRequest(
        parent="parent_value",
        framework_id="framework_id_value",
        framework=framework,
    )

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

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.cloudsecuritycompliance_v1.types.CreateFrameworkRequest, dict]

The request object. Request message for creating a Framework
parent str

Required. The parent resource name, in the format organizations/{organization}/locations/{location}. This corresponds to the parent field on the request instance; if request is provided, this should not be set.
framework google.cloud.cloudsecuritycompliance_v1.types.Framework

Required. The resource being created This corresponds to the framework field on the request instance; if request is provided, this should not be set.
framework_id str

Required. ID of the framework. This is not the full name of the framework. This is the last part of the full name of the framework. This corresponds to the framework_id field on the request instance; if request is provided, this should not be set.
retry google.api_core.retry.Retry

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

The timeout for this request.
metadata Sequence[Tuple[str, Union[str, bytes]]]

Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.
Returns
Type Description
google.cloud.cloudsecuritycompliance_v1.types.Framework A Framework is a collection of CloudControls to address security and compliance requirements. Frameworks can be used for prevention, detection, and auditing. They can be either built-in, industry-standard frameworks provided by GCP/AZURE/AWS (e.g., NIST, FedRAMP) or custom frameworks created by users.

delete_cloud_control

delete_cloud_control(
    request: typing.Optional[
        typing.Union[
            google.cloud.cloudsecuritycompliance_v1.types.config.DeleteCloudControlRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> None

Deletes a single Custom CloudControl, including all its major and minor revisions.

  • This operation can only be performed on CloudControls with type CUSTOM. Built-in CloudControls cannot be deleted.
  • The CloudControl cannot be deleted if any of its revisions are currently referenced by any Framework.
  • This action is permanent and cannot be undone.
# 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 cloudsecuritycompliance_v1

def sample_delete_cloud_control():
    # Create a client
    client = cloudsecuritycompliance_v1.ConfigClient()

    # Initialize request argument(s)
    request = cloudsecuritycompliance_v1.DeleteCloudControlRequest(
        name="name_value",
    )

    # Make the request
    client.delete_cloud_control(request=request)
Parameters
Name Description
request Union[google.cloud.cloudsecuritycompliance_v1.types.DeleteCloudControlRequest, dict]

The request object. Request message for deleting a CloudControl.
name str

Required. Name of the resource, in the format organizations/{organization}/locations/{location}/CloudControls/{CloudControl}. 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, Union[str, bytes]]]

Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

delete_framework

delete_framework(
    request: typing.Optional[
        typing.Union[
            google.cloud.cloudsecuritycompliance_v1.types.config.DeleteFrameworkRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> None

Deletes a single Custom Framework, including all its minor and minor revisions.

  • This operation can only be performed on Frameworks with type CUSTOM. Built-in Frameworks cannot be deleted.
  • The Framework cannot be deleted if it is currently deployed on any resource.
  • This action is permanent and cannot be undone.
# 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 cloudsecuritycompliance_v1

def sample_delete_framework():
    # Create a client
    client = cloudsecuritycompliance_v1.ConfigClient()

    # Initialize request argument(s)
    request = cloudsecuritycompliance_v1.DeleteFrameworkRequest(
        name="name_value",
    )

    # Make the request
    client.delete_framework(request=request)
Parameters
Name Description
request Union[google.cloud.cloudsecuritycompliance_v1.types.DeleteFrameworkRequest, dict]

The request object. Request message for deleting a Framework.
name str

Required. Name of the resource, in the format organizations/{organization}/locations/{location}/frameworks/{framework}. 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, Union[str, bytes]]]

Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

delete_operation

delete_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.DeleteOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> None

Deletes a long-running operation.

This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

Parameters
Name Description
request .operations_pb2.DeleteOperationRequest

The request object. Request message for DeleteOperation method.
retry google.api_core.retry.Retry

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

The timeout for this request.
metadata Sequence[Tuple[str, Union[str, bytes]]]

Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

framework_path

framework_path(organization: str, location: str, framework: str) -> str

Returns a fully-qualified framework string.

from_service_account_file

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

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

Parameter
Name Description
filename str

The path to the service account private key json file.
Returns
Type Description
ConfigClient The constructed client.

from_service_account_info

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

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

Parameter
Name Description
info dict

The service account private key info.
Returns
Type Description
ConfigClient The constructed client.

from_service_account_json

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

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

Parameter
Name Description
filename str

The path to the service account private key json file.
Returns
Type Description
ConfigClient The constructed client.

get_cloud_control

get_cloud_control(
    request: typing.Optional[
        typing.Union[
            google.cloud.cloudsecuritycompliance_v1.types.config.GetCloudControlRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.cloudsecuritycompliance_v1.types.common.CloudControl

Gets details of a single CloudControl. This method retrieves a CloudControl resource, which can be either Built-in or Custom, identified by its name.

By default, the latest major version of the CloudControl is returned. A specific major version can be retrieved by specifying the major_revision_id in the request.

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

def sample_get_cloud_control():
    # Create a client
    client = cloudsecuritycompliance_v1.ConfigClient()

    # Initialize request argument(s)
    request = cloudsecuritycompliance_v1.GetCloudControlRequest(
        name="name_value",
    )

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

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.cloudsecuritycompliance_v1.types.GetCloudControlRequest, dict]

The request object. Request message for getting a CloudControl.
name str

Required. The name of the cloudcontrol to retrieve in the format: organizations/{organization}/locations/{location}/cloudControls/{cloud_control} 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, Union[str, bytes]]]

Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.
Returns
Type Description
google.cloud.cloudsecuritycompliance_v1.types.CloudControl A CloudControl is the fundamental unit encapsulating the rules to meet a specific security or compliance intent. It can contain various rule types (like Organization Policies, CEL expressions, etc.) enabling different enforcement modes (Preventive, Detective, Audit). CloudControls are often parameterized for reusability and can be either BUILT_IN (provided by Google) or CUSTOM (defined by the user).

get_framework

get_framework(
    request: typing.Optional[
        typing.Union[
            google.cloud.cloudsecuritycompliance_v1.types.config.GetFrameworkRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.cloudsecuritycompliance_v1.types.common.Framework

Gets details of a single Framework. This method retrieves a Framework resource, which can be either Built-in or Custom, identified by its name.

By default, the latest major version of the Framework is returned. A specific major version can be retrieved by specifying the major_revision_id in the request.

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

def sample_get_framework():
    # Create a client
    client = cloudsecuritycompliance_v1.ConfigClient()

    # Initialize request argument(s)
    request = cloudsecuritycompliance_v1.GetFrameworkRequest(
        name="name_value",
    )

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

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.cloudsecuritycompliance_v1.types.GetFrameworkRequest, dict]

The request object. Request message for getting a Framework.
name str

Required. The name of the framework to retrieve. Format: organizations/{organization}/locations/{location}/frameworks/{framework_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, Union[str, bytes]]]

Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.
Returns
Type Description
google.cloud.cloudsecuritycompliance_v1.types.Framework A Framework is a collection of CloudControls to address security and compliance requirements. Frameworks can be used for prevention, detection, and auditing. They can be either built-in, industry-standard frameworks provided by GCP/AZURE/AWS (e.g., NIST, FedRAMP) or custom frameworks created by users.

get_location

get_location(
    request: typing.Optional[
        google.cloud.location.locations_pb2.GetLocationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.location.locations_pb2.Location

Gets information about a location.

Parameters
Name Description
request .location_pb2.GetLocationRequest

The request object. Request message for GetLocation method.
retry google.api_core.retry.Retry

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

The timeout for this request.
metadata Sequence[Tuple[str, Union[str, bytes]]]

Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.
Returns
Type Description
.location_pb2.Location Location object.

get_mtls_endpoint_and_cert_source

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

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.

Parameter
Name Description
client_options google.api_core.client_options.ClientOptions

Custom options for the client. Only the api_endpoint and client_cert_source properties may be used in this method.
Exceptions
Type Description
google.auth.exceptions.MutualTLSChannelError If any errors happen.
Returns
Type Description
Tuple[str, Callable[[], Tuple[bytes, bytes]]] returns the API endpoint and the client cert source to use.

get_operation

get_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.GetOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.longrunning.operations_pb2.Operation

Gets the latest state of a long-running operation.

Parameters
Name Description
request .operations_pb2.GetOperationRequest

The request object. Request message for GetOperation method.
retry google.api_core.retry.Retry

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

The timeout for this request.
metadata Sequence[Tuple[str, Union[str, bytes]]]

Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.
Returns
Type Description
.operations_pb2.Operation An Operation object.

list_cloud_controls

list_cloud_controls(
    request: typing.Optional[
        typing.Union[
            google.cloud.cloudsecuritycompliance_v1.types.config.ListCloudControlsRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> (
    google.cloud.cloudsecuritycompliance_v1.services.config.pagers.ListCloudControlsPager
)

Lists all CloudControls (both Built-in and Custom) available within a given parent resource. This method supports pagination. The latest major version of each CloudControl is returned.

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

def sample_list_cloud_controls():
    # Create a client
    client = cloudsecuritycompliance_v1.ConfigClient()

    # Initialize request argument(s)
    request = cloudsecuritycompliance_v1.ListCloudControlsRequest(
        parent="parent_value",
    )

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

    # Handle the response
    for response in page_result:
        print(response)
Parameters
Name Description
request Union[google.cloud.cloudsecuritycompliance_v1.types.ListCloudControlsRequest, dict]

The request object. Request message for listing CloudControls.
parent str

Required. The parent resource name, in the format organizations/{organization}/locations/{location}. 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, Union[str, bytes]]]

Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.
Returns
Type Description
google.cloud.cloudsecuritycompliance_v1.services.config.pagers.ListCloudControlsPager Response message for ListCloudControls. Iterating over this object will yield results and resolve additional pages automatically.

list_frameworks

list_frameworks(
    request: typing.Optional[
        typing.Union[
            google.cloud.cloudsecuritycompliance_v1.types.config.ListFrameworksRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.cloudsecuritycompliance_v1.services.config.pagers.ListFrameworksPager

Lists all Frameworks (both Built-in and Custom) available within a given parent resource. This method supports pagination. The latest major version of each Framework is returned.

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

def sample_list_frameworks():
    # Create a client
    client = cloudsecuritycompliance_v1.ConfigClient()

    # Initialize request argument(s)
    request = cloudsecuritycompliance_v1.ListFrameworksRequest(
        parent="parent_value",
    )

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

    # Handle the response
    for response in page_result:
        print(response)
Parameters
Name Description
request Union[google.cloud.cloudsecuritycompliance_v1.types.ListFrameworksRequest, dict]

The request object. Request message for listing Frameworks.
parent str

Required. The parent resource name, in the format organizations/{organization}/locations/{location}. Only global location is supported. 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, Union[str, bytes]]]

Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.
Returns
Type Description
google.cloud.cloudsecuritycompliance_v1.services.config.pagers.ListFrameworksPager Response message for listing Frameworks. Contains a paginated list of Framework resources. Iterating over this object will yield results and resolve additional pages automatically.

list_locations

list_locations(
    request: typing.Optional[
        google.cloud.location.locations_pb2.ListLocationsRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.location.locations_pb2.ListLocationsResponse

Lists information about the supported locations for this service.

Parameters
Name Description
request .location_pb2.ListLocationsRequest

The request object. Request message for ListLocations method.
retry google.api_core.retry.Retry

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

The timeout for this request.
metadata Sequence[Tuple[str, Union[str, bytes]]]

Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.
Returns
Type Description
.location_pb2.ListLocationsResponse Response message for ListLocations method.

list_operations

list_operations(
    request: typing.Optional[
        google.longrunning.operations_pb2.ListOperationsRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse

Lists operations that match the specified filter in the request.

Parameters
Name Description
request .operations_pb2.ListOperationsRequest

The request object. Request message for ListOperations method.
retry google.api_core.retry.Retry

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

The timeout for this request.
metadata Sequence[Tuple[str, Union[str, bytes]]]

Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.
Returns
Type Description
.operations_pb2.ListOperationsResponse Response message for ListOperations method.

parse_cloud_control_path

parse_cloud_control_path(path: str) -> typing.Dict[str, str]

Parses a cloud_control path into its component segments.

parse_common_billing_account_path

parse_common_billing_account_path(path: str) -> typing.Dict[str, str]

Parse a billing_account path into its component segments.

parse_common_folder_path

parse_common_folder_path(path: str) -> typing.Dict[str, str]

Parse a folder path into its component segments.

parse_common_location_path

parse_common_location_path(path: str) -> typing.Dict[str, str]

Parse a location path into its component segments.

parse_common_organization_path

parse_common_organization_path(path: str) -> typing.Dict[str, str]

Parse a organization path into its component segments.

parse_common_project_path

parse_common_project_path(path: str) -> typing.Dict[str, str]

Parse a project path into its component segments.

parse_framework_path

parse_framework_path(path: str) -> typing.Dict[str, str]

Parses a framework path into its component segments.

update_cloud_control

update_cloud_control(
    request: typing.Optional[
        typing.Union[
            google.cloud.cloudsecuritycompliance_v1.types.config.UpdateCloudControlRequest,
            dict,
        ]
    ] = None,
    *,
    cloud_control: typing.Optional[
        google.cloud.cloudsecuritycompliance_v1.types.common.CloudControl
    ] = None,
    update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.cloudsecuritycompliance_v1.types.common.CloudControl

Updates a single CloudControl. This method allows for partial updates of a Custom CloudControl resource. Built-in CloudControls cannot be updated.

  • If an update_mask is provided, only the fields specified in the mask will be updated.
  • If no update_mask is provided, all fields present in the request's cloud_control body will be used to overwrite the existing resource.

A successful update will result in a new version of the CloudControl.

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

def sample_update_cloud_control():
    # Create a client
    client = cloudsecuritycompliance_v1.ConfigClient()

    # Initialize request argument(s)
    cloud_control = cloudsecuritycompliance_v1.CloudControl()
    cloud_control.name = "name_value"

    request = cloudsecuritycompliance_v1.UpdateCloudControlRequest(
        cloud_control=cloud_control,
    )

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

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.cloudsecuritycompliance_v1.types.UpdateCloudControlRequest, dict]

The request object. Request message for UpdateCloudControl.
cloud_control google.cloud.cloudsecuritycompliance_v1.types.CloudControl

Required. The resource being updated This corresponds to the cloud_control field on the request instance; if request is provided, this should not be set.
update_mask google.protobuf.field_mask_pb2.FieldMask

Optional. Field mask is used to specify the fields to be overwritten in the CloudControl resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields present in the request will be overwritten. The fields that can be updated are: 1. Display_name 2. Description 3. Parameters 4. Rules 5. ParameterSpec. This corresponds to the update_mask 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, Union[str, bytes]]]

Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.
Returns
Type Description
google.cloud.cloudsecuritycompliance_v1.types.CloudControl A CloudControl is the fundamental unit encapsulating the rules to meet a specific security or compliance intent. It can contain various rule types (like Organization Policies, CEL expressions, etc.) enabling different enforcement modes (Preventive, Detective, Audit). CloudControls are often parameterized for reusability and can be either BUILT_IN (provided by Google) or CUSTOM (defined by the user).

update_framework

update_framework(
    request: typing.Optional[
        typing.Union[
            google.cloud.cloudsecuritycompliance_v1.types.config.UpdateFrameworkRequest,
            dict,
        ]
    ] = None,
    *,
    framework: typing.Optional[
        google.cloud.cloudsecuritycompliance_v1.types.common.Framework
    ] = None,
    update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.cloudsecuritycompliance_v1.types.common.Framework

Updates a single Framework. This method allows for partial updates of a Framework resource. The fields to be updated are specified using the update_mask.

  • If an update_mask is provided, only the fields specified in the mask will be updated.
  • If no update_mask is provided, all fields present in the request's framework body will be used to overwrite the existing resource.

This operation can only be performed on Frameworks with type CUSTOM. A successful update will result in a new version of the Framework.

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

def sample_update_framework():
    # Create a client
    client = cloudsecuritycompliance_v1.ConfigClient()

    # Initialize request argument(s)
    framework = cloudsecuritycompliance_v1.Framework()
    framework.name = "name_value"

    request = cloudsecuritycompliance_v1.UpdateFrameworkRequest(
        framework=framework,
    )

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

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.cloudsecuritycompliance_v1.types.UpdateFrameworkRequest, dict]

The request object. Request message for updating a Framework.
framework google.cloud.cloudsecuritycompliance_v1.types.Framework

Required. The resource being updated This corresponds to the framework field on the request instance; if request is provided, this should not be set.
update_mask google.protobuf.field_mask_pb2.FieldMask

Optional. Field mask is used to specify the fields to be overwritten in the Framework resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields present in the request will be overwritten. This corresponds to the update_mask 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, Union[str, bytes]]]

Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.
Returns
Type Description
google.cloud.cloudsecuritycompliance_v1.types.Framework A Framework is a collection of CloudControls to address security and compliance requirements. Frameworks can be used for prevention, detection, and auditing. They can be either built-in, industry-standard frameworks provided by GCP/AZURE/AWS (e.g., NIST, FedRAMP) or custom frameworks created by users.