Class SecurityCenterManagementClient (0.1.17)

Service describing handlers for resources

Return the API endpoint used by the client instance.

Returns the transport used by the client instance.

Return the universe domain used by the client instance.

Instantiates the security center management client.

Releases underlying transport's resources.

Returns a fully-qualified billing_account string.

Returns a fully-qualified folder string.

Returns a fully-qualified location string.

Returns a fully-qualified organization string.

Returns a fully-qualified project string.

Creates a resident Event Threat Detection custom module at the scope of the given organization, folder, or project, and creates inherited custom modules for all descendants of the given parent. These modules are enabled by default.

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

def sample_create_event_threat_detection_custom_module():
    # Create a client
    client = securitycentermanagement_v1.SecurityCenterManagementClient()

    # Initialize request argument(s)
    request = securitycentermanagement_v1.CreateEventThreatDetectionCustomModuleRequest(
        parent="parent_value",
    )

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

    # Handle the response
    print(response)

Creates a resident xref_SecurityHealthAnalyticsCustomModule at the scope of the given organization, folder, or project, and also creates inherited SecurityHealthAnalyticsCustomModule resources for all folders and projects that are descendants of the given parent. These modules are enabled by default.

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

def sample_create_security_health_analytics_custom_module():
    # Create a client
    client = securitycentermanagement_v1.SecurityCenterManagementClient()

    # Initialize request argument(s)
    request = securitycentermanagement_v1.CreateSecurityHealthAnalyticsCustomModuleRequest(
        parent="parent_value",
    )

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

    # Handle the response
    print(response)

Deletes the specified Event Threat Detection custom module and all of its descendants in the resource hierarchy. This method is only supported for resident custom modules.

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

def sample_delete_event_threat_detection_custom_module():
    # Create a client
    client = securitycentermanagement_v1.SecurityCenterManagementClient()

    # Initialize request argument(s)
    request = securitycentermanagement_v1.DeleteEventThreatDetectionCustomModuleRequest(
        name="name_value",
    )

    # Make the request
    client.delete_event_threat_detection_custom_module(request=request)

Deletes the specified xref_SecurityHealthAnalyticsCustomModule and all of its descendants in the resource hierarchy. This method is only supported for resident custom modules.

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

def sample_delete_security_health_analytics_custom_module():
    # Create a client
    client = securitycentermanagement_v1.SecurityCenterManagementClient()

    # Initialize request argument(s)
    request = securitycentermanagement_v1.DeleteSecurityHealthAnalyticsCustomModuleRequest(
        name="name_value",
    )

    # Make the request
    client.delete_security_health_analytics_custom_module(request=request)

Returns a fully-qualified effective_event_threat_detection_custom_module string.

Returns a fully-qualified effective_security_health_analytics_custom_module string.

Returns a fully-qualified event_threat_detection_custom_module string.

Returns a fully-qualified finding string.

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

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

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

Gets the effective Event Threat Detection custom module at the given level.

The difference between an xref_EffectiveEventThreatDetectionCustomModule and an xref_EventThreatDetectionCustomModule is that the fields for an EffectiveEventThreatDetectionCustomModule are computed from ancestors if needed. For example, the enablement state for an EventThreatDetectionCustomModule can be ENABLED, DISABLED, or INHERITED. In contrast, the enablement state for an EffectiveEventThreatDetectionCustomModule is always computed as ENABLED or DISABLED.

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

def sample_get_effective_event_threat_detection_custom_module():
    # Create a client
    client = securitycentermanagement_v1.SecurityCenterManagementClient()

    # Initialize request argument(s)
    request = securitycentermanagement_v1.GetEffectiveEventThreatDetectionCustomModuleRequest(
        name="name_value",
    )

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

    # Handle the response
    print(response)

Gets details of a single xref_EffectiveSecurityHealthAnalyticsCustomModule.

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

def sample_get_effective_security_health_analytics_custom_module():
    # Create a client
    client = securitycentermanagement_v1.SecurityCenterManagementClient()

    # Initialize request argument(s)
    request = securitycentermanagement_v1.GetEffectiveSecurityHealthAnalyticsCustomModuleRequest(
        name="name_value",
    )

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

    # Handle the response
    print(response)

Gets an Event Threat Detection custom module.

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

def sample_get_event_threat_detection_custom_module():
    # Create a client
    client = securitycentermanagement_v1.SecurityCenterManagementClient()

    # Initialize request argument(s)
    request = securitycentermanagement_v1.GetEventThreatDetectionCustomModuleRequest(
        name="name_value",
    )

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

    # Handle the response
    print(response)

Gets information about a location.

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.

Gets service settings for the specified Security Command Center service.

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

def sample_get_security_center_service():
    # Create a client
    client = securitycentermanagement_v1.SecurityCenterManagementClient()

    # Initialize request argument(s)
    request = securitycentermanagement_v1.GetSecurityCenterServiceRequest(
        name="name_value",
    )

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

    # Handle the response
    print(response)

Retrieves a xref_SecurityHealthAnalyticsCustomModule.

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

def sample_get_security_health_analytics_custom_module():
    # Create a client
    client = securitycentermanagement_v1.SecurityCenterManagementClient()

    # Initialize request argument(s)
    request = securitycentermanagement_v1.GetSecurityHealthAnalyticsCustomModuleRequest(
        name="name_value",
    )

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

    # Handle the response
    print(response)

Lists all resident Event Threat Detection custom modules for the given organization, folder, or project and its descendants.

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

def sample_list_descendant_event_threat_detection_custom_modules():
    # Create a client
    client = securitycentermanagement_v1.SecurityCenterManagementClient()

    # Initialize request argument(s)
    request = securitycentermanagement_v1.ListDescendantEventThreatDetectionCustomModulesRequest(
        parent="parent_value",
    )

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

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

Returns a list of all resident xref_SecurityHealthAnalyticsCustomModule resources under the given organization, folder, or project and all of its descendants.

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

def sample_list_descendant_security_health_analytics_custom_modules():
    # Create a client
    client = securitycentermanagement_v1.SecurityCenterManagementClient()

    # Initialize request argument(s)
    request = securitycentermanagement_v1.ListDescendantSecurityHealthAnalyticsCustomModulesRequest(
        parent="parent_value",
    )

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

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

Lists all effective Event Threat Detection custom modules for the given parent. This includes resident modules defined at the scope of the parent along with modules inherited from its ancestors.

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

def sample_list_effective_event_threat_detection_custom_modules():
    # Create a client
    client = securitycentermanagement_v1.SecurityCenterManagementClient()

    # Initialize request argument(s)
    request = securitycentermanagement_v1.ListEffectiveEventThreatDetectionCustomModulesRequest(
        parent="parent_value",
    )

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

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

Returns a list of all xref_EffectiveSecurityHealthAnalyticsCustomModule resources for the given parent. This includes resident modules defined at the scope of the parent, and inherited modules, inherited from ancestor organizations, folders, and projects (no descendants).

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

def sample_list_effective_security_health_analytics_custom_modules():
    # Create a client
    client = securitycentermanagement_v1.SecurityCenterManagementClient()

    # Initialize request argument(s)
    request = securitycentermanagement_v1.ListEffectiveSecurityHealthAnalyticsCustomModulesRequest(
        parent="parent_value",
    )

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

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

Lists all Event Threat Detection custom modules for the given organization, folder, or project. This includes resident modules defined at the scope of the parent along with modules inherited from ancestors.

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

def sample_list_event_threat_detection_custom_modules():
    # Create a client
    client = securitycentermanagement_v1.SecurityCenterManagementClient()

    # Initialize request argument(s)
    request = securitycentermanagement_v1.ListEventThreatDetectionCustomModulesRequest(
        parent="parent_value",
    )

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

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

Lists information about the supported locations for this service.

Returns a list of all Security Command Center services for the given parent.

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

def sample_list_security_center_services():
    # Create a client
    client = securitycentermanagement_v1.SecurityCenterManagementClient()

    # Initialize request argument(s)
    request = securitycentermanagement_v1.ListSecurityCenterServicesRequest(
        parent="parent_value",
    )

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

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

Returns a list of all xref_SecurityHealthAnalyticsCustomModule resources for the given parent. This includes resident modules defined at the scope of the parent, and inherited modules, inherited from ancestor organizations, folders, and projects (no descendants).

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

def sample_list_security_health_analytics_custom_modules():
    # Create a client
    client = securitycentermanagement_v1.SecurityCenterManagementClient()

    # Initialize request argument(s)
    request = securitycentermanagement_v1.ListSecurityHealthAnalyticsCustomModulesRequest(
        parent="parent_value",
    )

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

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

Parse a billing_account path into its component segments.

Parse a folder path into its component segments.

Parse a location path into its component segments.

Parse a organization path into its component segments.

Parse a project path into its component segments.

Parses a effective_event_threat_detection_custom_module path into its component segments.

Parses a effective_security_health_analytics_custom_module path into its component segments.

Parses a event_threat_detection_custom_module path into its component segments.

Parses a finding path into its component segments.

Parses a security_center_service path into its component segments.

Parses a security_health_analytics_custom_module path into its component segments.

Returns a fully-qualified security_center_service string.

Returns a fully-qualified security_health_analytics_custom_module string.

Simulates the result of using a xref_SecurityHealthAnalyticsCustomModule to check a resource.

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

def sample_simulate_security_health_analytics_custom_module():
    # Create a client
    client = securitycentermanagement_v1.SecurityCenterManagementClient()

    # Initialize request argument(s)
    resource = securitycentermanagement_v1.SimulatedResource()
    resource.resource_type = "resource_type_value"

    request = securitycentermanagement_v1.SimulateSecurityHealthAnalyticsCustomModuleRequest(
        parent="parent_value",
        resource=resource,
    )

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

    # Handle the response
    print(response)

Updates the Event Threat Detection custom module with the given name based on the given update mask. Updating the enablement state is supported for both resident and inherited modules (though resident modules cannot have an enablement state of "inherited"). Updating the display name or configuration of a module is supported for resident modules only. The type of a module cannot be changed.

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

def sample_update_event_threat_detection_custom_module():
    # Create a client
    client = securitycentermanagement_v1.SecurityCenterManagementClient()

    # Initialize request argument(s)
    request = securitycentermanagement_v1.UpdateEventThreatDetectionCustomModuleRequest(
    )

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

    # Handle the response
    print(response)

Updates a Security Command Center service using the given update mask.

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

def sample_update_security_center_service():
    # Create a client
    client = securitycentermanagement_v1.SecurityCenterManagementClient()

    # Initialize request argument(s)
    request = securitycentermanagement_v1.UpdateSecurityCenterServiceRequest(
    )

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

    # Handle the response
    print(response)

Updates the xref_SecurityHealthAnalyticsCustomModule under the given name based on the given update mask. Updating the enablement state is supported on both resident and inherited modules (though resident modules cannot have an enablement state of "inherited"). Updating the display name and custom configuration of a module is supported on resident modules only.

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

def sample_update_security_health_analytics_custom_module():
    # Create a client
    client = securitycentermanagement_v1.SecurityCenterManagementClient()

    # Initialize request argument(s)
    request = securitycentermanagement_v1.UpdateSecurityHealthAnalyticsCustomModuleRequest(
    )

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

    # Handle the response
    print(response)

Validates the given Event Threat Detection custom module.

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

def sample_validate_event_threat_detection_custom_module():
    # Create a client
    client = securitycentermanagement_v1.SecurityCenterManagementClient()

    # Initialize request argument(s)
    request = securitycentermanagement_v1.ValidateEventThreatDetectionCustomModuleRequest(
        parent="parent_value",
        raw_text="raw_text_value",
        type_="type__value",
    )

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

    # Handle the response
    print(response)