Package Methods (0.1.0)

Summary of entries of Methods for google-cloud-auditmanager.

google.cloud.auditmanager_v1.services.audit_manager.AuditManagerAsyncClient

AuditManagerAsyncClient(
    *,
    credentials: typing.Optional[google.auth.credentials.Credentials] = None,
    transport: typing.Optional[
        typing.Union[
            str,
            google.cloud.auditmanager_v1.services.audit_manager.transports.base.AuditManagerTransport,
            typing.Callable[
                [...],
                google.cloud.auditmanager_v1.services.audit_manager.transports.base.AuditManagerTransport,
            ],
        ]
    ] = "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
)

Instantiates the audit manager async client.

See more: google.cloud.auditmanager_v1.services.audit_manager.AuditManagerAsyncClient

google.cloud.auditmanager_v1.services.audit_manager.AuditManagerAsyncClient.audit_report_path

audit_report_path(project: str, location: str, audit_report: str) -> str

google.cloud.auditmanager_v1.services.audit_manager.AuditManagerAsyncClient.audit_scope_report_path

audit_scope_report_path(
    project: str, location: str, audit_scope_report: str
) -> str

google.cloud.auditmanager_v1.services.audit_manager.AuditManagerAsyncClient.cancel_operation

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

Starts asynchronous cancellation on a long-running operation.

See more: google.cloud.auditmanager_v1.services.audit_manager.AuditManagerAsyncClient.cancel_operation

google.cloud.auditmanager_v1.services.audit_manager.AuditManagerAsyncClient.common_billing_account_path

common_billing_account_path(billing_account: str) -> str

google.cloud.auditmanager_v1.services.audit_manager.AuditManagerAsyncClient.common_folder_path

common_folder_path(folder: str) -> str

google.cloud.auditmanager_v1.services.audit_manager.AuditManagerAsyncClient.common_location_path

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

google.cloud.auditmanager_v1.services.audit_manager.AuditManagerAsyncClient.common_organization_path

common_organization_path(organization: str) -> str

google.cloud.auditmanager_v1.services.audit_manager.AuditManagerAsyncClient.common_project_path

common_project_path(project: str) -> str

google.cloud.auditmanager_v1.services.audit_manager.AuditManagerAsyncClient.delete_operation

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

google.cloud.auditmanager_v1.services.audit_manager.AuditManagerAsyncClient.enroll_resource

enroll_resource(
    request: typing.Optional[
        typing.Union[
            google.cloud.auditmanager_v1.types.auditmanager.EnrollResourceRequest, dict
        ]
    ] = None,
    *,
    scope: typing.Optional[str] = None,
    destinations: typing.Optional[
        typing.MutableSequence[
            google.cloud.auditmanager_v1.types.auditmanager.EnrollResourceRequest.EligibleDestination
        ]
    ] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.auditmanager_v1.types.auditmanager.Enrollment

Enrolls the customer resource(folder/project/organization) to the audit manager service by creating the audit managers Service Agent in customers workload and granting required permissions to the Service Agent.

See more: google.cloud.auditmanager_v1.services.audit_manager.AuditManagerAsyncClient.enroll_resource

google.cloud.auditmanager_v1.services.audit_manager.AuditManagerAsyncClient.enrollment_path

enrollment_path(project: str, location: str, enrollment: str) -> str

google.cloud.auditmanager_v1.services.audit_manager.AuditManagerAsyncClient.enrollment_status_scope_path

enrollment_status_scope_path(folder: str, location: str) -> str

google.cloud.auditmanager_v1.services.audit_manager.AuditManagerAsyncClient.from_service_account_file

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

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

See more: google.cloud.auditmanager_v1.services.audit_manager.AuditManagerAsyncClient.from_service_account_file

google.cloud.auditmanager_v1.services.audit_manager.AuditManagerAsyncClient.from_service_account_info

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

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

See more: google.cloud.auditmanager_v1.services.audit_manager.AuditManagerAsyncClient.from_service_account_info

google.cloud.auditmanager_v1.services.audit_manager.AuditManagerAsyncClient.from_service_account_json

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

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

See more: google.cloud.auditmanager_v1.services.audit_manager.AuditManagerAsyncClient.from_service_account_json

google.cloud.auditmanager_v1.services.audit_manager.AuditManagerAsyncClient.generate_audit_report

generate_audit_report(
    request: typing.Optional[
        typing.Union[
            google.cloud.auditmanager_v1.types.auditmanager.GenerateAuditReportRequest,
            dict,
        ]
    ] = None,
    *,
    scope: typing.Optional[str] = None,
    gcs_uri: typing.Optional[str] = None,
    compliance_standard: typing.Optional[str] = None,
    report_format: typing.Optional[
        google.cloud.auditmanager_v1.types.auditmanager.GenerateAuditReportRequest.AuditReportFormat
    ] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation_async.AsyncOperation

Register the Audit Report generation requests and returns the OperationId using which the customer can track the report generation progress.

See more: google.cloud.auditmanager_v1.services.audit_manager.AuditManagerAsyncClient.generate_audit_report

google.cloud.auditmanager_v1.services.audit_manager.AuditManagerAsyncClient.generate_audit_scope_report

generate_audit_scope_report(
    request: typing.Optional[
        typing.Union[
            google.cloud.auditmanager_v1.types.auditmanager.GenerateAuditScopeReportRequest,
            dict,
        ]
    ] = None,
    *,
    scope: typing.Optional[str] = None,
    compliance_standard: typing.Optional[str] = None,
    report_format: typing.Optional[
        google.cloud.auditmanager_v1.types.auditmanager.GenerateAuditScopeReportRequest.AuditScopeReportFormat
    ] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.auditmanager_v1.types.auditmanager.AuditScopeReport

Generates a demo report highlighting different responsibilities (Google/Customer/ shared) required to be fulfilled for the customer's workload to be compliant with the given standard.

See more: google.cloud.auditmanager_v1.services.audit_manager.AuditManagerAsyncClient.generate_audit_scope_report

google.cloud.auditmanager_v1.services.audit_manager.AuditManagerAsyncClient.get_audit_report

get_audit_report(
    request: typing.Optional[
        typing.Union[
            google.cloud.auditmanager_v1.types.auditmanager.GetAuditReportRequest, dict
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.auditmanager_v1.types.auditmanager.AuditReport

google.cloud.auditmanager_v1.services.audit_manager.AuditManagerAsyncClient.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_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.location.locations_pb2.Location

google.cloud.auditmanager_v1.services.audit_manager.AuditManagerAsyncClient.get_mtls_endpoint_and_cert_source

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

Return the API endpoint and client cert source for mutual TLS.

See more: google.cloud.auditmanager_v1.services.audit_manager.AuditManagerAsyncClient.get_mtls_endpoint_and_cert_source

google.cloud.auditmanager_v1.services.audit_manager.AuditManagerAsyncClient.get_operation

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

Gets the latest state of a long-running operation.

See more: google.cloud.auditmanager_v1.services.audit_manager.AuditManagerAsyncClient.get_operation

google.cloud.auditmanager_v1.services.audit_manager.AuditManagerAsyncClient.get_resource_enrollment_status

get_resource_enrollment_status(
    request: typing.Optional[
        typing.Union[
            google.cloud.auditmanager_v1.types.auditmanager.GetResourceEnrollmentStatusRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.auditmanager_v1.types.auditmanager.ResourceEnrollmentStatus

google.cloud.auditmanager_v1.services.audit_manager.AuditManagerAsyncClient.get_transport_class

get_transport_class(
    label: typing.Optional[str] = None,
) -> typing.Type[
    google.cloud.auditmanager_v1.services.audit_manager.transports.base.AuditManagerTransport
]

google.cloud.auditmanager_v1.services.audit_manager.AuditManagerAsyncClient.list_audit_reports

list_audit_reports(
    request: typing.Optional[
        typing.Union[
            google.cloud.auditmanager_v1.types.auditmanager.ListAuditReportsRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> (
    google.cloud.auditmanager_v1.services.audit_manager.pagers.ListAuditReportsAsyncPager
)

google.cloud.auditmanager_v1.services.audit_manager.AuditManagerAsyncClient.list_controls

list_controls(
    request: typing.Optional[
        typing.Union[
            google.cloud.auditmanager_v1.types.auditmanager.ListControlsRequest, dict
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.auditmanager_v1.services.audit_manager.pagers.ListControlsAsyncPager

Gets controls needed to be implemented to be compliant to a standard.

See more: google.cloud.auditmanager_v1.services.audit_manager.AuditManagerAsyncClient.list_controls

google.cloud.auditmanager_v1.services.audit_manager.AuditManagerAsyncClient.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_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.location.locations_pb2.ListLocationsResponse

Lists information about the supported locations for this service.

See more: google.cloud.auditmanager_v1.services.audit_manager.AuditManagerAsyncClient.list_locations

google.cloud.auditmanager_v1.services.audit_manager.AuditManagerAsyncClient.list_operations

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

Lists operations that match the specified filter in the request.

See more: google.cloud.auditmanager_v1.services.audit_manager.AuditManagerAsyncClient.list_operations

google.cloud.auditmanager_v1.services.audit_manager.AuditManagerAsyncClient.list_resource_enrollment_statuses

list_resource_enrollment_statuses(
    request: typing.Optional[
        typing.Union[
            google.cloud.auditmanager_v1.types.auditmanager.ListResourceEnrollmentStatusesRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> (
    google.cloud.auditmanager_v1.services.audit_manager.pagers.ListResourceEnrollmentStatusesAsyncPager
)

Fetches all resources under the parent along with their enrollment.

See more: google.cloud.auditmanager_v1.services.audit_manager.AuditManagerAsyncClient.list_resource_enrollment_statuses

google.cloud.auditmanager_v1.services.audit_manager.AuditManagerAsyncClient.parse_audit_report_path

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

Parses a audit_report path into its component segments.

See more: google.cloud.auditmanager_v1.services.audit_manager.AuditManagerAsyncClient.parse_audit_report_path

google.cloud.auditmanager_v1.services.audit_manager.AuditManagerAsyncClient.parse_audit_scope_report_path

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

Parses a audit_scope_report path into its component segments.

See more: google.cloud.auditmanager_v1.services.audit_manager.AuditManagerAsyncClient.parse_audit_scope_report_path

google.cloud.auditmanager_v1.services.audit_manager.AuditManagerAsyncClient.parse_common_billing_account_path

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

google.cloud.auditmanager_v1.services.audit_manager.AuditManagerAsyncClient.parse_common_folder_path

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

google.cloud.auditmanager_v1.services.audit_manager.AuditManagerAsyncClient.parse_common_location_path

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

google.cloud.auditmanager_v1.services.audit_manager.AuditManagerAsyncClient.parse_common_organization_path

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

google.cloud.auditmanager_v1.services.audit_manager.AuditManagerAsyncClient.parse_common_project_path

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

google.cloud.auditmanager_v1.services.audit_manager.AuditManagerAsyncClient.parse_enrollment_path

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

Parses a enrollment path into its component segments.

See more: google.cloud.auditmanager_v1.services.audit_manager.AuditManagerAsyncClient.parse_enrollment_path

google.cloud.auditmanager_v1.services.audit_manager.AuditManagerAsyncClient.parse_enrollment_status_scope_path

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

Parses a enrollment_status_scope path into its component segments.

See more: google.cloud.auditmanager_v1.services.audit_manager.AuditManagerAsyncClient.parse_enrollment_status_scope_path

google.cloud.auditmanager_v1.services.audit_manager.AuditManagerAsyncClient.parse_resource_enrollment_status_path

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

Parses a resource_enrollment_status path into its component segments.

See more: google.cloud.auditmanager_v1.services.audit_manager.AuditManagerAsyncClient.parse_resource_enrollment_status_path

google.cloud.auditmanager_v1.services.audit_manager.AuditManagerAsyncClient.parse_standard_path

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

google.cloud.auditmanager_v1.services.audit_manager.AuditManagerAsyncClient.resource_enrollment_status_path

resource_enrollment_status_path(
    folder: str, location: str, resource_enrollment_status: str
) -> str

Returns a fully-qualified resource_enrollment_status string.

See more: google.cloud.auditmanager_v1.services.audit_manager.AuditManagerAsyncClient.resource_enrollment_status_path

google.cloud.auditmanager_v1.services.audit_manager.AuditManagerAsyncClient.standard_path

standard_path(project: str, location: str, standard: str) -> str

google.cloud.auditmanager_v1.services.audit_manager.AuditManagerClient

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

Instantiates the audit manager client.

See more: google.cloud.auditmanager_v1.services.audit_manager.AuditManagerClient

google.cloud.auditmanager_v1.services.audit_manager.AuditManagerClient.__exit__

__exit__(type, value, traceback)

Releases underlying transport's resources.

See more: google.cloud.auditmanager_v1.services.audit_manager.AuditManagerClient.exit

google.cloud.auditmanager_v1.services.audit_manager.AuditManagerClient.audit_report_path

audit_report_path(project: str, location: str, audit_report: str) -> str

google.cloud.auditmanager_v1.services.audit_manager.AuditManagerClient.audit_scope_report_path

audit_scope_report_path(
    project: str, location: str, audit_scope_report: str
) -> str

Returns a fully-qualified audit_scope_report string.

See more: google.cloud.auditmanager_v1.services.audit_manager.AuditManagerClient.audit_scope_report_path

google.cloud.auditmanager_v1.services.audit_manager.AuditManagerClient.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.

See more: google.cloud.auditmanager_v1.services.audit_manager.AuditManagerClient.cancel_operation

google.cloud.auditmanager_v1.services.audit_manager.AuditManagerClient.common_billing_account_path

common_billing_account_path(billing_account: str) -> str

google.cloud.auditmanager_v1.services.audit_manager.AuditManagerClient.common_folder_path

common_folder_path(folder: str) -> str

google.cloud.auditmanager_v1.services.audit_manager.AuditManagerClient.common_location_path

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

google.cloud.auditmanager_v1.services.audit_manager.AuditManagerClient.common_organization_path

common_organization_path(organization: str) -> str

google.cloud.auditmanager_v1.services.audit_manager.AuditManagerClient.common_project_path

common_project_path(project: str) -> str

google.cloud.auditmanager_v1.services.audit_manager.AuditManagerClient.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

google.cloud.auditmanager_v1.services.audit_manager.AuditManagerClient.enroll_resource

enroll_resource(
    request: typing.Optional[
        typing.Union[
            google.cloud.auditmanager_v1.types.auditmanager.EnrollResourceRequest, dict
        ]
    ] = None,
    *,
    scope: typing.Optional[str] = None,
    destinations: typing.Optional[
        typing.MutableSequence[
            google.cloud.auditmanager_v1.types.auditmanager.EnrollResourceRequest.EligibleDestination
        ]
    ] = 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.auditmanager_v1.types.auditmanager.Enrollment

Enrolls the customer resource(folder/project/organization) to the audit manager service by creating the audit managers Service Agent in customers workload and granting required permissions to the Service Agent.

See more: google.cloud.auditmanager_v1.services.audit_manager.AuditManagerClient.enroll_resource

google.cloud.auditmanager_v1.services.audit_manager.AuditManagerClient.enrollment_path

enrollment_path(project: str, location: str, enrollment: str) -> str

google.cloud.auditmanager_v1.services.audit_manager.AuditManagerClient.enrollment_status_scope_path

enrollment_status_scope_path(folder: str, location: str) -> str

Returns a fully-qualified enrollment_status_scope string.

See more: google.cloud.auditmanager_v1.services.audit_manager.AuditManagerClient.enrollment_status_scope_path

google.cloud.auditmanager_v1.services.audit_manager.AuditManagerClient.from_service_account_file

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

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

See more: google.cloud.auditmanager_v1.services.audit_manager.AuditManagerClient.from_service_account_file

google.cloud.auditmanager_v1.services.audit_manager.AuditManagerClient.from_service_account_info

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

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

See more: google.cloud.auditmanager_v1.services.audit_manager.AuditManagerClient.from_service_account_info

google.cloud.auditmanager_v1.services.audit_manager.AuditManagerClient.from_service_account_json

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

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

See more: google.cloud.auditmanager_v1.services.audit_manager.AuditManagerClient.from_service_account_json

google.cloud.auditmanager_v1.services.audit_manager.AuditManagerClient.generate_audit_report

generate_audit_report(
    request: typing.Optional[
        typing.Union[
            google.cloud.auditmanager_v1.types.auditmanager.GenerateAuditReportRequest,
            dict,
        ]
    ] = None,
    *,
    scope: typing.Optional[str] = None,
    gcs_uri: typing.Optional[str] = None,
    compliance_standard: typing.Optional[str] = None,
    report_format: typing.Optional[
        google.cloud.auditmanager_v1.types.auditmanager.GenerateAuditReportRequest.AuditReportFormat
    ] = 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.api_core.operation.Operation

Register the Audit Report generation requests and returns the OperationId using which the customer can track the report generation progress.

See more: google.cloud.auditmanager_v1.services.audit_manager.AuditManagerClient.generate_audit_report

google.cloud.auditmanager_v1.services.audit_manager.AuditManagerClient.generate_audit_scope_report

generate_audit_scope_report(
    request: typing.Optional[
        typing.Union[
            google.cloud.auditmanager_v1.types.auditmanager.GenerateAuditScopeReportRequest,
            dict,
        ]
    ] = None,
    *,
    scope: typing.Optional[str] = None,
    compliance_standard: typing.Optional[str] = None,
    report_format: typing.Optional[
        google.cloud.auditmanager_v1.types.auditmanager.GenerateAuditScopeReportRequest.AuditScopeReportFormat
    ] = 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.auditmanager_v1.types.auditmanager.AuditScopeReport

Generates a demo report highlighting different responsibilities (Google/Customer/ shared) required to be fulfilled for the customer's workload to be compliant with the given standard.

See more: google.cloud.auditmanager_v1.services.audit_manager.AuditManagerClient.generate_audit_scope_report

google.cloud.auditmanager_v1.services.audit_manager.AuditManagerClient.get_audit_report

get_audit_report(
    request: typing.Optional[
        typing.Union[
            google.cloud.auditmanager_v1.types.auditmanager.GetAuditReportRequest, 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.auditmanager_v1.types.auditmanager.AuditReport

google.cloud.auditmanager_v1.services.audit_manager.AuditManagerClient.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

google.cloud.auditmanager_v1.services.audit_manager.AuditManagerClient.get_mtls_endpoint_and_cert_source

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

google.cloud.auditmanager_v1.services.audit_manager.AuditManagerClient.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.

See more: google.cloud.auditmanager_v1.services.audit_manager.AuditManagerClient.get_operation

google.cloud.auditmanager_v1.services.audit_manager.AuditManagerClient.get_resource_enrollment_status

get_resource_enrollment_status(
    request: typing.Optional[
        typing.Union[
            google.cloud.auditmanager_v1.types.auditmanager.GetResourceEnrollmentStatusRequest,
            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.auditmanager_v1.types.auditmanager.ResourceEnrollmentStatus

google.cloud.auditmanager_v1.services.audit_manager.AuditManagerClient.list_audit_reports

list_audit_reports(
    request: typing.Optional[
        typing.Union[
            google.cloud.auditmanager_v1.types.auditmanager.ListAuditReportsRequest,
            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.auditmanager_v1.services.audit_manager.pagers.ListAuditReportsPager

Lists audit reports in the selected parent scope.

See more: google.cloud.auditmanager_v1.services.audit_manager.AuditManagerClient.list_audit_reports

google.cloud.auditmanager_v1.services.audit_manager.AuditManagerClient.list_controls

list_controls(
    request: typing.Optional[
        typing.Union[
            google.cloud.auditmanager_v1.types.auditmanager.ListControlsRequest, 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.auditmanager_v1.services.audit_manager.pagers.ListControlsPager

Gets controls needed to be implemented to be compliant to a standard.

See more: google.cloud.auditmanager_v1.services.audit_manager.AuditManagerClient.list_controls

google.cloud.auditmanager_v1.services.audit_manager.AuditManagerClient.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.

See more: google.cloud.auditmanager_v1.services.audit_manager.AuditManagerClient.list_locations

google.cloud.auditmanager_v1.services.audit_manager.AuditManagerClient.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.

See more: google.cloud.auditmanager_v1.services.audit_manager.AuditManagerClient.list_operations

google.cloud.auditmanager_v1.services.audit_manager.AuditManagerClient.list_resource_enrollment_statuses

list_resource_enrollment_statuses(
    request: typing.Optional[
        typing.Union[
            google.cloud.auditmanager_v1.types.auditmanager.ListResourceEnrollmentStatusesRequest,
            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.auditmanager_v1.services.audit_manager.pagers.ListResourceEnrollmentStatusesPager
)

Fetches all resources under the parent along with their enrollment.

See more: google.cloud.auditmanager_v1.services.audit_manager.AuditManagerClient.list_resource_enrollment_statuses

google.cloud.auditmanager_v1.services.audit_manager.AuditManagerClient.parse_audit_report_path

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

Parses a audit_report path into its component segments.

See more: google.cloud.auditmanager_v1.services.audit_manager.AuditManagerClient.parse_audit_report_path

google.cloud.auditmanager_v1.services.audit_manager.AuditManagerClient.parse_audit_scope_report_path

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

Parses a audit_scope_report path into its component segments.

See more: google.cloud.auditmanager_v1.services.audit_manager.AuditManagerClient.parse_audit_scope_report_path

google.cloud.auditmanager_v1.services.audit_manager.AuditManagerClient.parse_common_billing_account_path

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

google.cloud.auditmanager_v1.services.audit_manager.AuditManagerClient.parse_common_folder_path

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

google.cloud.auditmanager_v1.services.audit_manager.AuditManagerClient.parse_common_location_path

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

google.cloud.auditmanager_v1.services.audit_manager.AuditManagerClient.parse_common_organization_path

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

google.cloud.auditmanager_v1.services.audit_manager.AuditManagerClient.parse_common_project_path

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

google.cloud.auditmanager_v1.services.audit_manager.AuditManagerClient.parse_enrollment_path

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

Parses a enrollment path into its component segments.

See more: google.cloud.auditmanager_v1.services.audit_manager.AuditManagerClient.parse_enrollment_path

google.cloud.auditmanager_v1.services.audit_manager.AuditManagerClient.parse_enrollment_status_scope_path

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

Parses a enrollment_status_scope path into its component segments.

See more: google.cloud.auditmanager_v1.services.audit_manager.AuditManagerClient.parse_enrollment_status_scope_path

google.cloud.auditmanager_v1.services.audit_manager.AuditManagerClient.parse_resource_enrollment_status_path

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

Parses a resource_enrollment_status path into its component segments.

See more: google.cloud.auditmanager_v1.services.audit_manager.AuditManagerClient.parse_resource_enrollment_status_path

google.cloud.auditmanager_v1.services.audit_manager.AuditManagerClient.parse_standard_path

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

Parses a standard path into its component segments.

See more: google.cloud.auditmanager_v1.services.audit_manager.AuditManagerClient.parse_standard_path

google.cloud.auditmanager_v1.services.audit_manager.AuditManagerClient.resource_enrollment_status_path

resource_enrollment_status_path(
    folder: str, location: str, resource_enrollment_status: str
) -> str

Returns a fully-qualified resource_enrollment_status string.

See more: google.cloud.auditmanager_v1.services.audit_manager.AuditManagerClient.resource_enrollment_status_path

google.cloud.auditmanager_v1.services.audit_manager.AuditManagerClient.standard_path

standard_path(project: str, location: str, standard: str) -> str

google.cloud.auditmanager_v1.services.audit_manager.pagers.ListAuditReportsAsyncPager

ListAuditReportsAsyncPager(
    method: typing.Callable[
        [...],
        typing.Awaitable[
            google.cloud.auditmanager_v1.types.auditmanager.ListAuditReportsResponse
        ],
    ],
    request: google.cloud.auditmanager_v1.types.auditmanager.ListAuditReportsRequest,
    response: google.cloud.auditmanager_v1.types.auditmanager.ListAuditReportsResponse,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
)

google.cloud.auditmanager_v1.services.audit_manager.pagers.ListAuditReportsPager

ListAuditReportsPager(
    method: typing.Callable[
        [...], google.cloud.auditmanager_v1.types.auditmanager.ListAuditReportsResponse
    ],
    request: google.cloud.auditmanager_v1.types.auditmanager.ListAuditReportsRequest,
    response: google.cloud.auditmanager_v1.types.auditmanager.ListAuditReportsResponse,
    *,
    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.auditmanager_v1.services.audit_manager.pagers.ListControlsAsyncPager

ListControlsAsyncPager(
    method: typing.Callable[
        [...],
        typing.Awaitable[
            google.cloud.auditmanager_v1.types.auditmanager.ListControlsResponse
        ],
    ],
    request: google.cloud.auditmanager_v1.types.auditmanager.ListControlsRequest,
    response: google.cloud.auditmanager_v1.types.auditmanager.ListControlsResponse,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
)

google.cloud.auditmanager_v1.services.audit_manager.pagers.ListControlsPager

ListControlsPager(
    method: typing.Callable[
        [...], google.cloud.auditmanager_v1.types.auditmanager.ListControlsResponse
    ],
    request: google.cloud.auditmanager_v1.types.auditmanager.ListControlsRequest,
    response: google.cloud.auditmanager_v1.types.auditmanager.ListControlsResponse,
    *,
    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.auditmanager_v1.services.audit_manager.pagers.ListResourceEnrollmentStatusesAsyncPager

ListResourceEnrollmentStatusesAsyncPager(
    method: typing.Callable[
        [...],
        typing.Awaitable[
            google.cloud.auditmanager_v1.types.auditmanager.ListResourceEnrollmentStatusesResponse
        ],
    ],
    request: google.cloud.auditmanager_v1.types.auditmanager.ListResourceEnrollmentStatusesRequest,
    response: google.cloud.auditmanager_v1.types.auditmanager.ListResourceEnrollmentStatusesResponse,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
)

google.cloud.auditmanager_v1.services.audit_manager.pagers.ListResourceEnrollmentStatusesPager

ListResourceEnrollmentStatusesPager(
    method: typing.Callable[
        [...],
        google.cloud.auditmanager_v1.types.auditmanager.ListResourceEnrollmentStatusesResponse,
    ],
    request: google.cloud.auditmanager_v1.types.auditmanager.ListResourceEnrollmentStatusesRequest,
    response: google.cloud.auditmanager_v1.types.auditmanager.ListResourceEnrollmentStatusesResponse,
    *,
    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]]] = ()
)