Class OrgPolicyViolationsPreviewServiceAsyncClient (0.1.15) 

OrgPolicyViolationsPreviewServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.policysimulator_v1.services.org_policy_violations_preview_service.transports.base.OrgPolicyViolationsPreviewServiceTransport, typing.Callable[[...], google.cloud.policysimulator_v1.services.org_policy_violations_preview_service.transports.base.OrgPolicyViolationsPreviewServiceTransport]]] = 'grpc_asyncio', client_options: typing.Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

Violations Preview API service for OrgPolicy.

An OrgPolicyViolationsPreview is a preview of the violations that will exist as soon as a proposed OrgPolicy change is submitted. To create an OrgPolicyViolationsPreview, the API user specifies the changes they wish to make and requests the generation of a preview via [GenerateViolationsPreview][]. the OrgPolicy Simulator service then scans the API user's currently existing resources to determine these resources violate the newly set OrgPolicy.

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
OrgPolicyViolationsPreviewServiceTransport 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

OrgPolicyViolationsPreviewServiceAsyncClient

OrgPolicyViolationsPreviewServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.policysimulator_v1.services.org_policy_violations_preview_service.transports.base.OrgPolicyViolationsPreviewServiceTransport, typing.Callable[[...], google.cloud.policysimulator_v1.services.org_policy_violations_preview_service.transports.base.OrgPolicyViolationsPreviewServiceTransport]]] = 'grpc_asyncio', client_options: typing.Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

Instantiates the org policy violations preview service async client.

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

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

The transport to use, or a Callable that constructs and returns a new transport to use. If a Callable is given, it will be called with the same set of initialization arguments as used in the OrgPolicyViolationsPreviewServiceTransport constructor. If set to None, a transport is chosen automatically.
client_options Optional[Union[google.api_core.client_options.ClientOptions, dict]]

Custom options for the client. 1. The api_endpoint property can be used to override the default endpoint provided by the client when transport is not explicitly provided. Only if this property is not set and transport was not explicitly provided, the endpoint is determined by the GOOGLE_API_USE_MTLS_ENDPOINT environment variable, which have one of the following values: "always" (always use the default mTLS endpoint), "never" (always use the default regular endpoint) and "auto" (auto-switch to the default mTLS endpoint if client certificate is present; this is the default value). 2. If the GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "true", then the client_cert_source property can be used to provide a client certificate for mTLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is "false" or not set, no client certificate will be used. 3. The universe_domain property can be used to override the default "googleapis.com" universe. Note that api_endpoint property still takes precedence; and universe_domain is currently not supported for mTLS.
client_info google.api_core.gapic_v1.client_info.ClientInfo

The client info used to send a user-agent string along with API requests. If None, then default info will be used. Generally, you only need to set this if you're developing your own client library.
Exceptions
Type Description
google.auth.exceptions.MutualTlsChannelError If mutual TLS transport creation failed for any reason.

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_org_policy_violations_preview

create_org_policy_violations_preview(
    request: typing.Optional[
        typing.Union[
            google.cloud.policysimulator_v1.types.orgpolicy.CreateOrgPolicyViolationsPreviewRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    org_policy_violations_preview: typing.Optional[
        google.cloud.policysimulator_v1.types.orgpolicy.OrgPolicyViolationsPreview
    ] = None,
    org_policy_violations_preview_id: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation_async.AsyncOperation

CreateOrgPolicyViolationsPreview creates an xref_OrgPolicyViolationsPreview for the proposed changes in the provided [OrgPolicyViolationsPreview.OrgPolicyOverlay][]. The changes to OrgPolicy are specified by this OrgPolicyOverlay. The resources to scan are inferred from these specified changes.

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

async def sample_create_org_policy_violations_preview():
    # Create a client
    client = policysimulator_v1.OrgPolicyViolationsPreviewServiceAsyncClient()

    # Initialize request argument(s)
    request = policysimulator_v1.CreateOrgPolicyViolationsPreviewRequest(
        parent="parent_value",
    )

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

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

    response = (await operation).result()

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

The request object. CreateOrgPolicyViolationsPreviewRequest is the request message for OrgPolicyViolationsPreviewService.CreateOrgPolicyViolationsPreview.
parent str

Required. The organization under which this OrgPolicyViolationsPreview will be created. Example: organizations/my-example-org/locations/global This corresponds to the parent field on the request instance; if request is provided, this should not be set.
org_policy_violations_preview OrgPolicyViolationsPreview

Required. The OrgPolicyViolationsPreview to generate. This corresponds to the org_policy_violations_preview field on the request instance; if request is provided, this should not be set.
org_policy_violations_preview_id str

Optional. An optional user-specified ID for the OrgPolicyViolationsPreview. If not provided, a random ID will be generated. This corresponds to the org_policy_violations_preview_id field on the request instance; if request is provided, this should not be set.
retry google.api_core.retry_async.AsyncRetry

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

The timeout for this request.
metadata Sequence[Tuple[str, 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.api_core.operation_async.AsyncOperation An object representing a long-running operation. The result type for the operation will be OrgPolicyViolationsPreview OrgPolicyViolationsPreview is a resource providing a preview of the violations that will exist if an OrgPolicy change is made. The list of violations are modeled as child resources and retrieved via a [ListOrgPolicyViolations][] API call. There are potentially more [OrgPolicyViolations][] than could fit in an embedded field. Thus, the use of a child resource instead of a field.

custom_constraint_path

custom_constraint_path(organization: str, custom_constraint: str) -> str

Returns a fully-qualified custom_constraint 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
OrgPolicyViolationsPreviewServiceAsyncClient 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
OrgPolicyViolationsPreviewServiceAsyncClient 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
OrgPolicyViolationsPreviewServiceAsyncClient The constructed client.

get_mtls_endpoint_and_cert_source

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

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

The client cert source is determined in the following order: (1) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is not "true", the client cert source is None. (2) if client_options.client_cert_source is provided, use the provided one; if the default client cert source exists, use the default one; otherwise the client cert source is None.

The API endpoint is determined in the following order: (1) if client_options.api_endpoint if provided, use the provided one. (2) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "always", use the default mTLS endpoint; if the environment variable is "never", use the default API endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise use the default API endpoint.

More details can be found at https://google.aip.dev/auth/4114.

Parameter
Name Description
client_options google.api_core.client_options.ClientOptions

Custom options for the client. Only the 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_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.

Parameters
Name Description
request .operations_pb2.GetOperationRequest

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

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

The timeout for this request.
metadata Sequence[Tuple[str, 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.

get_org_policy_violations_preview

get_org_policy_violations_preview(
    request: typing.Optional[
        typing.Union[
            google.cloud.policysimulator_v1.types.orgpolicy.GetOrgPolicyViolationsPreviewRequest,
            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.policysimulator_v1.types.orgpolicy.OrgPolicyViolationsPreview

GetOrgPolicyViolationsPreview gets the specified xref_OrgPolicyViolationsPreview. Each xref_OrgPolicyViolationsPreview is available for at least 7 days.

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

async def sample_get_org_policy_violations_preview():
    # Create a client
    client = policysimulator_v1.OrgPolicyViolationsPreviewServiceAsyncClient()

    # Initialize request argument(s)
    request = policysimulator_v1.GetOrgPolicyViolationsPreviewRequest(
        name="name_value",
    )

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

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

The request object. GetOrgPolicyViolationsPreviewRequest is the request message for OrgPolicyViolationsPreviewService.GetOrgPolicyViolationsPreview.
name str

Required. The name of the OrgPolicyViolationsPreview to get. This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry google.api_core.retry_async.AsyncRetry

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

The timeout for this request.
metadata Sequence[Tuple[str, 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.policysimulator_v1.types.OrgPolicyViolationsPreview OrgPolicyViolationsPreview is a resource providing a preview of the violations that will exist if an OrgPolicy change is made. The list of violations are modeled as child resources and retrieved via a [ListOrgPolicyViolations][] API call. There are potentially more [OrgPolicyViolations][] than could fit in an embedded field. Thus, the use of a child resource instead of a field.

get_transport_class

get_transport_class(
    label: typing.Optional[str] = None,
) -> typing.Type[
    google.cloud.policysimulator_v1.services.org_policy_violations_preview_service.transports.base.OrgPolicyViolationsPreviewServiceTransport
]

Returns an appropriate transport class.

Parameter
Name Description
label typing.Optional[str]

The name of the desired transport. If none is provided, then the first transport in the registry is used.

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.

Parameters
Name Description
request .operations_pb2.ListOperationsRequest

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

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

The timeout for this request.
metadata Sequence[Tuple[str, 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.

list_org_policy_violations

list_org_policy_violations(
    request: typing.Optional[
        typing.Union[
            google.cloud.policysimulator_v1.types.orgpolicy.ListOrgPolicyViolationsRequest,
            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.policysimulator_v1.services.org_policy_violations_preview_service.pagers.ListOrgPolicyViolationsAsyncPager
)

ListOrgPolicyViolations lists the [OrgPolicyViolations][] that are present in an xref_OrgPolicyViolationsPreview.

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

async def sample_list_org_policy_violations():
    # Create a client
    client = policysimulator_v1.OrgPolicyViolationsPreviewServiceAsyncClient()

    # Initialize request argument(s)
    request = policysimulator_v1.ListOrgPolicyViolationsRequest(
        parent="parent_value",
    )

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

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

The request object. ListOrgPolicyViolationsRequest is the request message for OrgPolicyViolationsPreviewService.ListOrgPolicyViolations.
parent str

Required. The OrgPolicyViolationsPreview to get OrgPolicyViolations from. Format: organizations/{organization}/locations/{location}/orgPolicyViolationsPreviews/{orgPolicyViolationsPreview} This corresponds to the parent field on the request instance; if request is provided, this should not be set.
retry google.api_core.retry_async.AsyncRetry

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

The timeout for this request.
metadata Sequence[Tuple[str, 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.policysimulator_v1.services.org_policy_violations_preview_service.pagers.ListOrgPolicyViolationsAsyncPager ListOrgPolicyViolationsResponse is the response message for OrgPolicyViolationsPreviewService.ListOrgPolicyViolations Iterating over this object will yield results and resolve additional pages automatically.

list_org_policy_violations_previews

list_org_policy_violations_previews(
    request: typing.Optional[
        typing.Union[
            google.cloud.policysimulator_v1.types.orgpolicy.ListOrgPolicyViolationsPreviewsRequest,
            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.policysimulator_v1.services.org_policy_violations_preview_service.pagers.ListOrgPolicyViolationsPreviewsAsyncPager
)

ListOrgPolicyViolationsPreviews lists each xref_OrgPolicyViolationsPreview in an organization. Each xref_OrgPolicyViolationsPreview is available for at least 7 days.

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

async def sample_list_org_policy_violations_previews():
    # Create a client
    client = policysimulator_v1.OrgPolicyViolationsPreviewServiceAsyncClient()

    # Initialize request argument(s)
    request = policysimulator_v1.ListOrgPolicyViolationsPreviewsRequest(
        parent="parent_value",
    )

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

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

The request object. ListOrgPolicyViolationsPreviewsRequest is the request message for OrgPolicyViolationsPreviewService.ListOrgPolicyViolationsPreviews.
parent str

Required. The parent the violations are scoped to. Format: organizations/{organization}/locations/{location} Example: organizations/my-example-org/locations/global This corresponds to the parent field on the request instance; if request is provided, this should not be set.
retry google.api_core.retry_async.AsyncRetry

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

The timeout for this request.
metadata Sequence[Tuple[str, 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.policysimulator_v1.services.org_policy_violations_preview_service.pagers.ListOrgPolicyViolationsPreviewsAsyncPager ListOrgPolicyViolationsPreviewsResponse is the response message for OrgPolicyViolationsPreviewService.ListOrgPolicyViolationsPreviews. Iterating over this object will yield results and resolve additional pages automatically.

org_policy_violation_path

org_policy_violation_path(
    organization: str,
    location: str,
    org_policy_violations_preview: str,
    org_policy_violation: str,
) -> str

Returns a fully-qualified org_policy_violation string.

org_policy_violations_preview_path

org_policy_violations_preview_path(
    organization: str, location: str, org_policy_violations_preview: str
) -> str

Returns a fully-qualified org_policy_violations_preview string.

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_custom_constraint_path

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

Parses a custom_constraint path into its component segments.

parse_org_policy_violation_path

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

Parses a org_policy_violation path into its component segments.

parse_org_policy_violations_preview_path

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

Parses a org_policy_violations_preview path into its component segments.

parse_policy_path

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

Parses a policy path into its component segments.

policy_path

policy_path(project: str, policy: str) -> str

Returns a fully-qualified policy string.