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

OrgPolicy¶

class google.cloud.orgpolicy_v2.services.org_policy.OrgPolicyAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.orgpolicy_v2.services.org_policy.transports.base.OrgPolicyTransport, typing.Callable[[...], google.cloud.orgpolicy_v2.services.org_policy.transports.base.OrgPolicyTransport]]] = 'grpc_asyncio', client_options: typing.Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)[source]¶

An interface for managing organization policies.

The Organization Policy Service provides a simple mechanism for organizations to restrict the allowed configurations across their entire resource hierarchy.

You can use a policy to configure restrictions on resources. For example, you can enforce a policy that restricts which Google Cloud APIs can be activated in a certain part of your resource hierarchy, or prevents serial port access to VM instances in a particular folder.

Policies are inherited down through the resource hierarchy. A policy applied to a parent resource automatically applies to all its child resources unless overridden with a policy lower in the hierarchy.

A constraint defines an aspect of a resource’s configuration that can be controlled by an organization’s policy administrator. Policies are a collection of constraints that defines their allowable configuration on a particular resource and its child resources.

Instantiates the org policy async client.

Parameters

credentials (Optional[google.auth.credentials.Credentials]) – The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment.
transport (Optional[Union[str,OrgPolicyTransport,Callable[..., OrgPolicyTransport]]]) – 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 OrgPolicyTransport constructor. If set to None, a transport is chosen automatically.
client_options (Optional[Union[google.api_core.client_options.ClientOptions, dict]]) –
Custom options for the client.

1. The api_endpoint property can be used to override the default endpoint provided by the client when transport is not explicitly provided. Only if this property is not set and transport was not explicitly provided, the endpoint is determined by the GOOGLE_API_USE_MTLS_ENDPOINT environment variable, which have one of the following values: “always” (always use the default mTLS endpoint), “never” (always use the default regular endpoint) and “auto” (auto-switch to the default mTLS endpoint if client certificate is present; this is the default value).

2. If the GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “true”, then the client_cert_source property can be used to provide a client certificate for mTLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is “false” or not set, no client certificate will be used.

3. The universe_domain property can be used to override the default “googleapis.com” universe. Note that api_endpoint property still takes precedence; and universe_domain is currently not supported for mTLS.
client_info (google.api_core.gapic_v1.client_info.ClientInfo) – The client info used to send a user-agent string along with API requests. If None, then default info will be used. Generally, you only need to set this if you’re developing your own client library.

Raises

google.auth.exceptions.MutualTlsChannelError – If mutual TLS transport creation failed for any reason.

property api_endpoint¶

Return the API endpoint used by the client instance.

Returns: The API endpoint used by the client instance.
Return type: str

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

static common_folder_path(folder: str) → str¶: Returns a fully-qualified folder string.

static common_location_path(project: str, location: str) → str¶: Returns a fully-qualified location string.

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

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

static constraint_path(project: str, constraint: str) → str¶: Returns a fully-qualified constraint string.

async create_custom_constraint(request: Optional[Union[google.cloud.orgpolicy_v2.types.orgpolicy.CreateCustomConstraintRequest, dict]] = None, *, parent: Optional[str] = None, custom_constraint: Optional[google.cloud.orgpolicy_v2.types.constraint.CustomConstraint] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.orgpolicy_v2.types.constraint.CustomConstraint[source]¶

Creates a custom constraint.

Returns a google.rpc.Status with google.rpc.Code.NOT_FOUND if the organization does not exist. Returns a google.rpc.Status with google.rpc.Code.ALREADY_EXISTS if the constraint already exists on the given organization.

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

async def sample_create_custom_constraint():
    # Create a client
    client = orgpolicy_v2.OrgPolicyAsyncClient()

    # Initialize request argument(s)
    request = orgpolicy_v2.CreateCustomConstraintRequest(
        parent="parent_value",
    )

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

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.orgpolicy_v2.types.CreateCustomConstraintRequest, dict]]) – The request object. The request sent to the [CreateCustomConstraintRequest] [google.cloud.orgpolicy.v2.OrgPolicy.CreateCustomConstraint] method.
parent (str) –
Required. Must be in the following form:
- organizations/{organization_id}
This corresponds to the parent field on the request instance; if request is provided, this should not be set.
custom_constraint (google.cloud.orgpolicy_v2.types.CustomConstraint) –
Required. Custom constraint to create.

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

Returns

A custom constraint defined by customers which can only be applied to the

given resource types and organization.

By creating a custom constraint, customers can apply policies of this custom constraint. Creating a custom constraint itself does NOT apply any policy enforcement.

Return type

google.cloud.orgpolicy_v2.types.CustomConstraint

async create_policy(request: Optional[Union[google.cloud.orgpolicy_v2.types.orgpolicy.CreatePolicyRequest, dict]] = None, *, parent: Optional[str] = None, policy: Optional[google.cloud.orgpolicy_v2.types.orgpolicy.Policy] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.orgpolicy_v2.types.orgpolicy.Policy[source]¶

Creates a policy.

Returns a google.rpc.Status with google.rpc.Code.NOT_FOUND if the constraint does not exist. Returns a google.rpc.Status with google.rpc.Code.ALREADY_EXISTS if the policy already exists on the given Google Cloud 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 orgpolicy_v2

async def sample_create_policy():
    # Create a client
    client = orgpolicy_v2.OrgPolicyAsyncClient()

    # Initialize request argument(s)
    request = orgpolicy_v2.CreatePolicyRequest(
        parent="parent_value",
    )

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

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.orgpolicy_v2.types.CreatePolicyRequest, dict]]) – The request object. The request sent to the [CreatePolicyRequest] [google.cloud.orgpolicy.v2.OrgPolicy.CreatePolicy] method.
parent (str) –
Required. The Google Cloud resource that will parent the new policy. Must be in one of the following forms:
- projects/{project_number}
- projects/{project_id}
- folders/{folder_id}
- organizations/{organization_id}
This corresponds to the parent field on the request instance; if request is provided, this should not be set.
policy (google.cloud.orgpolicy_v2.types.Policy) – Required. Policy to create. This corresponds to the policy field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Defines an organization policy which is used to specify constraints for configurations of Google Cloud resources.

Return type

google.cloud.orgpolicy_v2.types.Policy

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

async delete_custom_constraint(request: Optional[Union[google.cloud.orgpolicy_v2.types.orgpolicy.DeleteCustomConstraintRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → None[source]¶

Deletes a custom constraint.

Returns a google.rpc.Status with google.rpc.Code.NOT_FOUND if the constraint does not exist.

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

async def sample_delete_custom_constraint():
    # Create a client
    client = orgpolicy_v2.OrgPolicyAsyncClient()

    # Initialize request argument(s)
    request = orgpolicy_v2.DeleteCustomConstraintRequest(
        name="name_value",
    )

    # Make the request
    await client.delete_custom_constraint(request=request)

Parameters

request (Optional[Union[google.cloud.orgpolicy_v2.types.DeleteCustomConstraintRequest, dict]]) – The request object. The request sent to the [DeleteCustomConstraint] [google.cloud.orgpolicy.v2.OrgPolicy.DeleteCustomConstraint] method.
name (str) –
Required. Name of the custom constraint to delete. See the custom constraint entry for naming rules.

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

async delete_policy(request: Optional[Union[google.cloud.orgpolicy_v2.types.orgpolicy.DeletePolicyRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → None[source]¶

Deletes a policy.

Returns a google.rpc.Status with google.rpc.Code.NOT_FOUND if the constraint or organization policy does not exist.

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

async def sample_delete_policy():
    # Create a client
    client = orgpolicy_v2.OrgPolicyAsyncClient()

    # Initialize request argument(s)
    request = orgpolicy_v2.DeletePolicyRequest(
        name="name_value",
    )

    # Make the request
    await client.delete_policy(request=request)

Parameters

request (Optional[Union[google.cloud.orgpolicy_v2.types.DeletePolicyRequest, dict]]) – The request object. The request sent to the [DeletePolicy] [google.cloud.orgpolicy.v2.OrgPolicy.DeletePolicy] method.
name (str) –
Required. Name of the policy to delete. See the policy entry for naming rules.

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

classmethod from_service_account_file(filename: str, *args, **kwargs)[source]¶

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

Parameters

filename (str) – The path to the service account private key json file.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

OrgPolicyAsyncClient

classmethod from_service_account_info(info: dict, *args, **kwargs)[source]¶

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

Parameters

info (dict) – The service account private key info.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

OrgPolicyAsyncClient

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

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

Parameters

filename (str) – The path to the service account private key json file.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

OrgPolicyAsyncClient

async get_custom_constraint(request: Optional[Union[google.cloud.orgpolicy_v2.types.orgpolicy.GetCustomConstraintRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.orgpolicy_v2.types.constraint.CustomConstraint[source]¶

Gets a custom constraint.

Returns a google.rpc.Status with google.rpc.Code.NOT_FOUND if the custom constraint does not exist.

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

async def sample_get_custom_constraint():
    # Create a client
    client = orgpolicy_v2.OrgPolicyAsyncClient()

    # Initialize request argument(s)
    request = orgpolicy_v2.GetCustomConstraintRequest(
        name="name_value",
    )

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

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.orgpolicy_v2.types.GetCustomConstraintRequest, dict]]) – The request object. The request sent to the [GetCustomConstraint] [google.cloud.orgpolicy.v2.OrgPolicy.GetCustomConstraint] method.
name (str) –
Required. Resource name of the custom constraint. See the custom constraint entry for naming requirements.

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

Returns

A custom constraint defined by customers which can only be applied to the

given resource types and organization.

By creating a custom constraint, customers can apply policies of this custom constraint. Creating a custom constraint itself does NOT apply any policy enforcement.

Return type

google.cloud.orgpolicy_v2.types.CustomConstraint

async get_effective_policy(request: Optional[Union[google.cloud.orgpolicy_v2.types.orgpolicy.GetEffectivePolicyRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.orgpolicy_v2.types.orgpolicy.Policy[source]¶

Gets the effective policy on a resource. This is the result of merging policies in the resource hierarchy and evaluating conditions. The returned policy will not have an etag or condition set because it is an evaluated policy across multiple resources. Subtrees of Resource Manager resource hierarchy with ‘under:’ prefix will not be expanded.

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

async def sample_get_effective_policy():
    # Create a client
    client = orgpolicy_v2.OrgPolicyAsyncClient()

    # Initialize request argument(s)
    request = orgpolicy_v2.GetEffectivePolicyRequest(
        name="name_value",
    )

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

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.orgpolicy_v2.types.GetEffectivePolicyRequest, dict]]) – The request object. The request sent to the [GetEffectivePolicy] [google.cloud.orgpolicy.v2.OrgPolicy.GetEffectivePolicy] method.
name (str) –
Required. The effective policy to compute. See [Policy][google.cloud.orgpolicy.v2.Policy] for naming requirements.

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

Returns

Defines an organization policy which is used to specify constraints for configurations of Google Cloud resources.

Return type

google.cloud.orgpolicy_v2.types.Policy

classmethod get_mtls_endpoint_and_cert_source(client_options: Optional[google.api_core.client_options.ClientOptions] = None)[source]¶

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

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

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

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

Parameters

client_options (google.api_core.client_options.ClientOptions) – Custom options for the client. Only the api_endpoint and client_cert_source properties may be used in this method.

Returns

returns the API endpoint and the: client cert source to use.

Return type

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

Raises

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

async get_policy(request: Optional[Union[google.cloud.orgpolicy_v2.types.orgpolicy.GetPolicyRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.orgpolicy_v2.types.orgpolicy.Policy[source]¶

Gets a policy on a resource.

If no policy is set on the resource, NOT_FOUND is returned. The etag value can be used with UpdatePolicy() to update a policy during read-modify-write.

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

async def sample_get_policy():
    # Create a client
    client = orgpolicy_v2.OrgPolicyAsyncClient()

    # Initialize request argument(s)
    request = orgpolicy_v2.GetPolicyRequest(
        name="name_value",
    )

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

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.orgpolicy_v2.types.GetPolicyRequest, dict]]) – The request object. The request sent to the [GetPolicy] [google.cloud.orgpolicy.v2.OrgPolicy.GetPolicy] method.
name (str) –
Required. Resource name of the policy. See [Policy][google.cloud.orgpolicy.v2.Policy] for naming requirements.

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

Returns

Defines an organization policy which is used to specify constraints for configurations of Google Cloud resources.

Return type

google.cloud.orgpolicy_v2.types.Policy

classmethod get_transport_class(label: Optional[str] = None) → Type[google.cloud.orgpolicy_v2.services.org_policy.transports.base.OrgPolicyTransport]¶

Returns an appropriate transport class.

Parameters: label – The name of the desired transport. If none is provided, then the first transport in the registry is used.
Returns: The transport class to use.

async list_constraints(request: Optional[Union[google.cloud.orgpolicy_v2.types.orgpolicy.ListConstraintsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.orgpolicy_v2.services.org_policy.pagers.ListConstraintsAsyncPager[source]¶

Lists constraints that could be applied on the specified 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 orgpolicy_v2

async def sample_list_constraints():
    # Create a client
    client = orgpolicy_v2.OrgPolicyAsyncClient()

    # Initialize request argument(s)
    request = orgpolicy_v2.ListConstraintsRequest(
        parent="parent_value",
    )

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

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

Parameters

request (Optional[Union[google.cloud.orgpolicy_v2.types.ListConstraintsRequest, dict]]) – The request object. The request sent to the [ListConstraints] [google.cloud.orgpolicy.v2.OrgPolicy.ListConstraints] method.
parent (str) –
Required. The Google Cloud resource that parents the constraint. Must be in one of the following forms:
- projects/{project_number}
- projects/{project_id}
- folders/{folder_id}
- organizations/{organization_id}
This corresponds to the parent field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

The response returned from the [ListConstraints]: [google.cloud.orgpolicy.v2.OrgPolicy.ListConstraints] method.

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

Return type

google.cloud.orgpolicy_v2.services.org_policy.pagers.ListConstraintsAsyncPager

async list_custom_constraints(request: Optional[Union[google.cloud.orgpolicy_v2.types.orgpolicy.ListCustomConstraintsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.orgpolicy_v2.services.org_policy.pagers.ListCustomConstraintsAsyncPager[source]¶

Retrieves all of the custom constraints that exist on a particular organization 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 orgpolicy_v2

async def sample_list_custom_constraints():
    # Create a client
    client = orgpolicy_v2.OrgPolicyAsyncClient()

    # Initialize request argument(s)
    request = orgpolicy_v2.ListCustomConstraintsRequest(
        parent="parent_value",
    )

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

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

Parameters

request (Optional[Union[google.cloud.orgpolicy_v2.types.ListCustomConstraintsRequest, dict]]) – The request object. The request sent to the [ListCustomConstraints] [google.cloud.orgpolicy.v2.OrgPolicy.ListCustomConstraints] method.
parent (str) –
Required. The target Google Cloud resource that parents the set of custom constraints that will be returned from this call. Must be in one of the following forms:
- organizations/{organization_id}
This corresponds to the parent field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

The response returned from the [ListCustomConstraints]: [google.cloud.orgpolicy.v2.OrgPolicy.ListCustomConstraints] method. It will be empty if no custom constraints are set on the organization resource.

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

Return type

google.cloud.orgpolicy_v2.services.org_policy.pagers.ListCustomConstraintsAsyncPager

async list_policies(request: Optional[Union[google.cloud.orgpolicy_v2.types.orgpolicy.ListPoliciesRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.orgpolicy_v2.services.org_policy.pagers.ListPoliciesAsyncPager[source]¶

Retrieves all of the policies that exist on a particular 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 orgpolicy_v2

async def sample_list_policies():
    # Create a client
    client = orgpolicy_v2.OrgPolicyAsyncClient()

    # Initialize request argument(s)
    request = orgpolicy_v2.ListPoliciesRequest(
        parent="parent_value",
    )

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

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

Parameters

request (Optional[Union[google.cloud.orgpolicy_v2.types.ListPoliciesRequest, dict]]) – The request object. The request sent to the [ListPolicies] [google.cloud.orgpolicy.v2.OrgPolicy.ListPolicies] method.
parent (str) –
Required. The target Google Cloud resource that parents the set of constraints and policies that will be returned from this call. Must be in one of the following forms:
- projects/{project_number}
- projects/{project_id}
- folders/{folder_id}
- organizations/{organization_id}
This corresponds to the parent field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

The response returned from the [ListPolicies]: [google.cloud.orgpolicy.v2.OrgPolicy.ListPolicies] method. It will be empty if no policies are set on the resource.

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

Return type

google.cloud.orgpolicy_v2.services.org_policy.pagers.ListPoliciesAsyncPager

static parse_common_billing_account_path(path: str) → Dict[str, str]¶: Parse a billing_account path into its component segments.

static parse_common_folder_path(path: str) → Dict[str, str]¶: Parse a folder path into its component segments.

static parse_common_location_path(path: str) → Dict[str, str]¶: Parse a location path into its component segments.

static parse_common_organization_path(path: str) → Dict[str, str]¶: Parse a organization path into its component segments.

static parse_common_project_path(path: str) → Dict[str, str]¶: Parse a project path into its component segments.

static parse_constraint_path(path: str) → Dict[str, str]¶: Parses a constraint path into its component segments.

static parse_custom_constraint_path(path: str) → Dict[str, str]¶: Parses a custom_constraint path into its component segments.

static parse_policy_path(path: str) → Dict[str, str]¶: Parses a policy path into its component segments.

static policy_path(project: str, policy: str) → str¶: Returns a fully-qualified policy string.

property transport: google.cloud.orgpolicy_v2.services.org_policy.transports.base.OrgPolicyTransport¶

Returns the transport used by the client instance.

Returns: The transport used by the client instance.
Return type: OrgPolicyTransport

property universe_domain: str¶

Return the universe domain used by the client instance.

Returns

The universe domain used: by the client instance.

Return type

str

async update_custom_constraint(request: Optional[Union[google.cloud.orgpolicy_v2.types.orgpolicy.UpdateCustomConstraintRequest, dict]] = None, *, custom_constraint: Optional[google.cloud.orgpolicy_v2.types.constraint.CustomConstraint] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.orgpolicy_v2.types.constraint.CustomConstraint[source]¶

Updates a custom constraint.

Returns a google.rpc.Status with google.rpc.Code.NOT_FOUND if the constraint does not exist.

Note: the supplied policy will perform a full overwrite of all fields.

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

async def sample_update_custom_constraint():
    # Create a client
    client = orgpolicy_v2.OrgPolicyAsyncClient()

    # Initialize request argument(s)
    request = orgpolicy_v2.UpdateCustomConstraintRequest(
    )

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

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.orgpolicy_v2.types.UpdateCustomConstraintRequest, dict]]) – The request object. The request sent to the [UpdateCustomConstraintRequest] [google.cloud.orgpolicy.v2.OrgPolicy.UpdateCustomConstraint] method.
custom_constraint (google.cloud.orgpolicy_v2.types.CustomConstraint) – Required. CustomConstraint to update. This corresponds to the custom_constraint field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

A custom constraint defined by customers which can only be applied to the

given resource types and organization.

By creating a custom constraint, customers can apply policies of this custom constraint. Creating a custom constraint itself does NOT apply any policy enforcement.

Return type

google.cloud.orgpolicy_v2.types.CustomConstraint

async update_policy(request: Optional[Union[google.cloud.orgpolicy_v2.types.orgpolicy.UpdatePolicyRequest, dict]] = None, *, policy: Optional[google.cloud.orgpolicy_v2.types.orgpolicy.Policy] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.orgpolicy_v2.types.orgpolicy.Policy[source]¶

Updates a policy.

Returns a google.rpc.Status with google.rpc.Code.NOT_FOUND if the constraint or the policy do not exist. Returns a google.rpc.Status with google.rpc.Code.ABORTED if the etag supplied in the request does not match the persisted etag of the policy

Note: the supplied policy will perform a full overwrite of all fields.

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

async def sample_update_policy():
    # Create a client
    client = orgpolicy_v2.OrgPolicyAsyncClient()

    # Initialize request argument(s)
    request = orgpolicy_v2.UpdatePolicyRequest(
    )

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

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.orgpolicy_v2.types.UpdatePolicyRequest, dict]]) – The request object. The request sent to the [UpdatePolicyRequest] [google.cloud.orgpolicy.v2.OrgPolicy.UpdatePolicy] method.
policy (google.cloud.orgpolicy_v2.types.Policy) – Required. Policy to update. This corresponds to the policy field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Defines an organization policy which is used to specify constraints for configurations of Google Cloud resources.

Return type

google.cloud.orgpolicy_v2.types.Policy

class google.cloud.orgpolicy_v2.services.org_policy.OrgPolicyClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.orgpolicy_v2.services.org_policy.transports.base.OrgPolicyTransport, typing.Callable[[...], google.cloud.orgpolicy_v2.services.org_policy.transports.base.OrgPolicyTransport]]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)[source]¶

An interface for managing organization policies.

The Organization Policy Service provides a simple mechanism for organizations to restrict the allowed configurations across their entire resource hierarchy.

You can use a policy to configure restrictions on resources. For example, you can enforce a policy that restricts which Google Cloud APIs can be activated in a certain part of your resource hierarchy, or prevents serial port access to VM instances in a particular folder.

Policies are inherited down through the resource hierarchy. A policy applied to a parent resource automatically applies to all its child resources unless overridden with a policy lower in the hierarchy.

A constraint defines an aspect of a resource’s configuration that can be controlled by an organization’s policy administrator. Policies are a collection of constraints that defines their allowable configuration on a particular resource and its child resources.

Instantiates the org policy client.

Parameters

credentials (Optional[google.auth.credentials.Credentials]) – The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment.
transport (Optional[Union[str,OrgPolicyTransport,Callable[..., OrgPolicyTransport]]]) – The transport to use, or a Callable that constructs and returns a new transport. If a Callable is given, it will be called with the same set of initialization arguments as used in the OrgPolicyTransport constructor. If set to None, a transport is chosen automatically.
client_options (Optional[Union[google.api_core.client_options.ClientOptions, dict]]) –
Custom options for the client.

1. The api_endpoint property can be used to override the default endpoint provided by the client when transport is not explicitly provided. Only if this property is not set and transport was not explicitly provided, the endpoint is determined by the GOOGLE_API_USE_MTLS_ENDPOINT environment variable, which have one of the following values: “always” (always use the default mTLS endpoint), “never” (always use the default regular endpoint) and “auto” (auto-switch to the default mTLS endpoint if client certificate is present; this is the default value).

2. If the GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “true”, then the client_cert_source property can be used to provide a client certificate for mTLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is “false” or not set, no client certificate will be used.

3. The universe_domain property can be used to override the default “googleapis.com” universe. Note that the api_endpoint property still takes precedence; and universe_domain is currently not supported for mTLS.
client_info (google.api_core.gapic_v1.client_info.ClientInfo) – The client info used to send a user-agent string along with API requests. If None, then default info will be used. Generally, you only need to set this if you’re developing your own client library.

Raises

google.auth.exceptions.MutualTLSChannelError – If mutual TLS transport creation failed for any reason.

__exit__(type, value, traceback)[source]¶: Releases underlying transport’s resources.

Warning

ONLY use as a context manager if the transport is NOT shared with other clients! Exiting the with block will CLOSE the transport and may cause errors in other clients!

property api_endpoint¶

Return the API endpoint used by the client instance.

Returns: The API endpoint used by the client instance.
Return type: str

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

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

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

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

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

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

create_custom_constraint(request: Optional[Union[google.cloud.orgpolicy_v2.types.orgpolicy.CreateCustomConstraintRequest, dict]] = None, *, parent: Optional[str] = None, custom_constraint: Optional[google.cloud.orgpolicy_v2.types.constraint.CustomConstraint] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.orgpolicy_v2.types.constraint.CustomConstraint[source]¶

Creates a custom constraint.

Returns a google.rpc.Status with google.rpc.Code.NOT_FOUND if the organization does not exist. Returns a google.rpc.Status with google.rpc.Code.ALREADY_EXISTS if the constraint already exists on the given organization.

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

def sample_create_custom_constraint():
    # Create a client
    client = orgpolicy_v2.OrgPolicyClient()

    # Initialize request argument(s)
    request = orgpolicy_v2.CreateCustomConstraintRequest(
        parent="parent_value",
    )

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

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.orgpolicy_v2.types.CreateCustomConstraintRequest, dict]) – The request object. The request sent to the [CreateCustomConstraintRequest] [google.cloud.orgpolicy.v2.OrgPolicy.CreateCustomConstraint] method.
parent (str) –
Required. Must be in the following form:
- organizations/{organization_id}
This corresponds to the parent field on the request instance; if request is provided, this should not be set.
custom_constraint (google.cloud.orgpolicy_v2.types.CustomConstraint) –
Required. Custom constraint to create.

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

Returns

A custom constraint defined by customers which can only be applied to the

given resource types and organization.

By creating a custom constraint, customers can apply policies of this custom constraint. Creating a custom constraint itself does NOT apply any policy enforcement.

Return type

google.cloud.orgpolicy_v2.types.CustomConstraint

create_policy(request: Optional[Union[google.cloud.orgpolicy_v2.types.orgpolicy.CreatePolicyRequest, dict]] = None, *, parent: Optional[str] = None, policy: Optional[google.cloud.orgpolicy_v2.types.orgpolicy.Policy] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.orgpolicy_v2.types.orgpolicy.Policy[source]¶

Creates a policy.

Returns a google.rpc.Status with google.rpc.Code.NOT_FOUND if the constraint does not exist. Returns a google.rpc.Status with google.rpc.Code.ALREADY_EXISTS if the policy already exists on the given Google Cloud 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 orgpolicy_v2

def sample_create_policy():
    # Create a client
    client = orgpolicy_v2.OrgPolicyClient()

    # Initialize request argument(s)
    request = orgpolicy_v2.CreatePolicyRequest(
        parent="parent_value",
    )

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

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.orgpolicy_v2.types.CreatePolicyRequest, dict]) – The request object. The request sent to the [CreatePolicyRequest] [google.cloud.orgpolicy.v2.OrgPolicy.CreatePolicy] method.
parent (str) –
Required. The Google Cloud resource that will parent the new policy. Must be in one of the following forms:
- projects/{project_number}
- projects/{project_id}
- folders/{folder_id}
- organizations/{organization_id}
This corresponds to the parent field on the request instance; if request is provided, this should not be set.
policy (google.cloud.orgpolicy_v2.types.Policy) – Required. Policy to create. This corresponds to the policy field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Defines an organization policy which is used to specify constraints for configurations of Google Cloud resources.

Return type

google.cloud.orgpolicy_v2.types.Policy

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

delete_custom_constraint(request: Optional[Union[google.cloud.orgpolicy_v2.types.orgpolicy.DeleteCustomConstraintRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → None[source]¶

Deletes a custom constraint.

Returns a google.rpc.Status with google.rpc.Code.NOT_FOUND if the constraint does not exist.

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

def sample_delete_custom_constraint():
    # Create a client
    client = orgpolicy_v2.OrgPolicyClient()

    # Initialize request argument(s)
    request = orgpolicy_v2.DeleteCustomConstraintRequest(
        name="name_value",
    )

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

Parameters

request (Union[google.cloud.orgpolicy_v2.types.DeleteCustomConstraintRequest, dict]) – The request object. The request sent to the [DeleteCustomConstraint] [google.cloud.orgpolicy.v2.OrgPolicy.DeleteCustomConstraint] method.
name (str) –
Required. Name of the custom constraint to delete. See the custom constraint entry for naming rules.

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

delete_policy(request: Optional[Union[google.cloud.orgpolicy_v2.types.orgpolicy.DeletePolicyRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → None[source]¶

Deletes a policy.

Returns a google.rpc.Status with google.rpc.Code.NOT_FOUND if the constraint or organization policy does not exist.

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

def sample_delete_policy():
    # Create a client
    client = orgpolicy_v2.OrgPolicyClient()

    # Initialize request argument(s)
    request = orgpolicy_v2.DeletePolicyRequest(
        name="name_value",
    )

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

Parameters

request (Union[google.cloud.orgpolicy_v2.types.DeletePolicyRequest, dict]) – The request object. The request sent to the [DeletePolicy] [google.cloud.orgpolicy.v2.OrgPolicy.DeletePolicy] method.
name (str) –
Required. Name of the policy to delete. See the policy entry for naming rules.

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

classmethod from_service_account_file(filename: str, *args, **kwargs)[source]¶

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

Parameters

filename (str) – The path to the service account private key json file.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

OrgPolicyClient

classmethod from_service_account_info(info: dict, *args, **kwargs)[source]¶

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

Parameters

info (dict) – The service account private key info.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

OrgPolicyClient

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

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

Parameters

filename (str) – The path to the service account private key json file.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

OrgPolicyClient

get_custom_constraint(request: Optional[Union[google.cloud.orgpolicy_v2.types.orgpolicy.GetCustomConstraintRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.orgpolicy_v2.types.constraint.CustomConstraint[source]¶

Gets a custom constraint.

Returns a google.rpc.Status with google.rpc.Code.NOT_FOUND if the custom constraint does not exist.

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

def sample_get_custom_constraint():
    # Create a client
    client = orgpolicy_v2.OrgPolicyClient()

    # Initialize request argument(s)
    request = orgpolicy_v2.GetCustomConstraintRequest(
        name="name_value",
    )

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

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.orgpolicy_v2.types.GetCustomConstraintRequest, dict]) – The request object. The request sent to the [GetCustomConstraint] [google.cloud.orgpolicy.v2.OrgPolicy.GetCustomConstraint] method.
name (str) –
Required. Resource name of the custom constraint. See the custom constraint entry for naming requirements.

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

Returns

A custom constraint defined by customers which can only be applied to the

given resource types and organization.

By creating a custom constraint, customers can apply policies of this custom constraint. Creating a custom constraint itself does NOT apply any policy enforcement.

Return type

google.cloud.orgpolicy_v2.types.CustomConstraint

get_effective_policy(request: Optional[Union[google.cloud.orgpolicy_v2.types.orgpolicy.GetEffectivePolicyRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.orgpolicy_v2.types.orgpolicy.Policy[source]¶

Gets the effective policy on a resource. This is the result of merging policies in the resource hierarchy and evaluating conditions. The returned policy will not have an etag or condition set because it is an evaluated policy across multiple resources. Subtrees of Resource Manager resource hierarchy with ‘under:’ prefix will not be expanded.

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

def sample_get_effective_policy():
    # Create a client
    client = orgpolicy_v2.OrgPolicyClient()

    # Initialize request argument(s)
    request = orgpolicy_v2.GetEffectivePolicyRequest(
        name="name_value",
    )

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

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.orgpolicy_v2.types.GetEffectivePolicyRequest, dict]) – The request object. The request sent to the [GetEffectivePolicy] [google.cloud.orgpolicy.v2.OrgPolicy.GetEffectivePolicy] method.
name (str) –
Required. The effective policy to compute. See [Policy][google.cloud.orgpolicy.v2.Policy] for naming requirements.

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

Returns

Defines an organization policy which is used to specify constraints for configurations of Google Cloud resources.

Return type

google.cloud.orgpolicy_v2.types.Policy

classmethod get_mtls_endpoint_and_cert_source(client_options: Optional[google.api_core.client_options.ClientOptions] = None)[source]¶

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

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

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

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

Parameters

client_options (google.api_core.client_options.ClientOptions) – Custom options for the client. Only the api_endpoint and client_cert_source properties may be used in this method.

Returns

returns the API endpoint and the: client cert source to use.

Return type

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

Raises

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

get_policy(request: Optional[Union[google.cloud.orgpolicy_v2.types.orgpolicy.GetPolicyRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.orgpolicy_v2.types.orgpolicy.Policy[source]¶

Gets a policy on a resource.

If no policy is set on the resource, NOT_FOUND is returned. The etag value can be used with UpdatePolicy() to update a policy during read-modify-write.

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

def sample_get_policy():
    # Create a client
    client = orgpolicy_v2.OrgPolicyClient()

    # Initialize request argument(s)
    request = orgpolicy_v2.GetPolicyRequest(
        name="name_value",
    )

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

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.orgpolicy_v2.types.GetPolicyRequest, dict]) – The request object. The request sent to the [GetPolicy] [google.cloud.orgpolicy.v2.OrgPolicy.GetPolicy] method.
name (str) –
Required. Resource name of the policy. See [Policy][google.cloud.orgpolicy.v2.Policy] for naming requirements.

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

Returns

Defines an organization policy which is used to specify constraints for configurations of Google Cloud resources.

Return type

google.cloud.orgpolicy_v2.types.Policy

list_constraints(request: Optional[Union[google.cloud.orgpolicy_v2.types.orgpolicy.ListConstraintsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.orgpolicy_v2.services.org_policy.pagers.ListConstraintsPager[source]¶

Lists constraints that could be applied on the specified 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 orgpolicy_v2

def sample_list_constraints():
    # Create a client
    client = orgpolicy_v2.OrgPolicyClient()

    # Initialize request argument(s)
    request = orgpolicy_v2.ListConstraintsRequest(
        parent="parent_value",
    )

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

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

Parameters

request (Union[google.cloud.orgpolicy_v2.types.ListConstraintsRequest, dict]) – The request object. The request sent to the [ListConstraints] [google.cloud.orgpolicy.v2.OrgPolicy.ListConstraints] method.
parent (str) –
Required. The Google Cloud resource that parents the constraint. Must be in one of the following forms:
- projects/{project_number}
- projects/{project_id}
- folders/{folder_id}
- organizations/{organization_id}
This corresponds to the parent field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

The response returned from the [ListConstraints]: [google.cloud.orgpolicy.v2.OrgPolicy.ListConstraints] method.

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

Return type

google.cloud.orgpolicy_v2.services.org_policy.pagers.ListConstraintsPager

list_custom_constraints(request: Optional[Union[google.cloud.orgpolicy_v2.types.orgpolicy.ListCustomConstraintsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.orgpolicy_v2.services.org_policy.pagers.ListCustomConstraintsPager[source]¶

Retrieves all of the custom constraints that exist on a particular organization 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 orgpolicy_v2

def sample_list_custom_constraints():
    # Create a client
    client = orgpolicy_v2.OrgPolicyClient()

    # Initialize request argument(s)
    request = orgpolicy_v2.ListCustomConstraintsRequest(
        parent="parent_value",
    )

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

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

Parameters

request (Union[google.cloud.orgpolicy_v2.types.ListCustomConstraintsRequest, dict]) – The request object. The request sent to the [ListCustomConstraints] [google.cloud.orgpolicy.v2.OrgPolicy.ListCustomConstraints] method.
parent (str) –
Required. The target Google Cloud resource that parents the set of custom constraints that will be returned from this call. Must be in one of the following forms:
- organizations/{organization_id}
This corresponds to the parent field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

The response returned from the [ListCustomConstraints]: [google.cloud.orgpolicy.v2.OrgPolicy.ListCustomConstraints] method. It will be empty if no custom constraints are set on the organization resource.

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

Return type

google.cloud.orgpolicy_v2.services.org_policy.pagers.ListCustomConstraintsPager

list_policies(request: Optional[Union[google.cloud.orgpolicy_v2.types.orgpolicy.ListPoliciesRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.orgpolicy_v2.services.org_policy.pagers.ListPoliciesPager[source]¶

Retrieves all of the policies that exist on a particular 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 orgpolicy_v2

def sample_list_policies():
    # Create a client
    client = orgpolicy_v2.OrgPolicyClient()

    # Initialize request argument(s)
    request = orgpolicy_v2.ListPoliciesRequest(
        parent="parent_value",
    )

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

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

Parameters

request (Union[google.cloud.orgpolicy_v2.types.ListPoliciesRequest, dict]) – The request object. The request sent to the [ListPolicies] [google.cloud.orgpolicy.v2.OrgPolicy.ListPolicies] method.
parent (str) –
Required. The target Google Cloud resource that parents the set of constraints and policies that will be returned from this call. Must be in one of the following forms:
- projects/{project_number}
- projects/{project_id}
- folders/{folder_id}
- organizations/{organization_id}
This corresponds to the parent field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

The response returned from the [ListPolicies]: [google.cloud.orgpolicy.v2.OrgPolicy.ListPolicies] method. It will be empty if no policies are set on the resource.

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

Return type

google.cloud.orgpolicy_v2.services.org_policy.pagers.ListPoliciesPager

static parse_common_billing_account_path(path: str) → Dict[str, str][source]¶: Parse a billing_account path into its component segments.

static parse_common_folder_path(path: str) → Dict[str, str][source]¶: Parse a folder path into its component segments.

static parse_common_location_path(path: str) → Dict[str, str][source]¶: Parse a location path into its component segments.

static parse_common_organization_path(path: str) → Dict[str, str][source]¶: Parse a organization path into its component segments.

static parse_common_project_path(path: str) → Dict[str, str][source]¶: Parse a project path into its component segments.

static parse_constraint_path(path: str) → Dict[str, str][source]¶: Parses a constraint path into its component segments.

static parse_custom_constraint_path(path: str) → Dict[str, str][source]¶: Parses a custom_constraint path into its component segments.

static parse_policy_path(path: str) → Dict[str, str][source]¶: Parses a policy path into its component segments.

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

property transport: google.cloud.orgpolicy_v2.services.org_policy.transports.base.OrgPolicyTransport¶

Returns the transport used by the client instance.

Returns

The transport used by the client: instance.

Return type

OrgPolicyTransport

property universe_domain: str¶

Return the universe domain used by the client instance.

Returns: The universe domain used by the client instance.
Return type: str

update_custom_constraint(request: Optional[Union[google.cloud.orgpolicy_v2.types.orgpolicy.UpdateCustomConstraintRequest, dict]] = None, *, custom_constraint: Optional[google.cloud.orgpolicy_v2.types.constraint.CustomConstraint] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.orgpolicy_v2.types.constraint.CustomConstraint[source]¶

Updates a custom constraint.

Returns a google.rpc.Status with google.rpc.Code.NOT_FOUND if the constraint does not exist.

Note: the supplied policy will perform a full overwrite of all fields.

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

def sample_update_custom_constraint():
    # Create a client
    client = orgpolicy_v2.OrgPolicyClient()

    # Initialize request argument(s)
    request = orgpolicy_v2.UpdateCustomConstraintRequest(
    )

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

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.orgpolicy_v2.types.UpdateCustomConstraintRequest, dict]) – The request object. The request sent to the [UpdateCustomConstraintRequest] [google.cloud.orgpolicy.v2.OrgPolicy.UpdateCustomConstraint] method.
custom_constraint (google.cloud.orgpolicy_v2.types.CustomConstraint) – Required. CustomConstraint to update. This corresponds to the custom_constraint field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

A custom constraint defined by customers which can only be applied to the

given resource types and organization.

By creating a custom constraint, customers can apply policies of this custom constraint. Creating a custom constraint itself does NOT apply any policy enforcement.

Return type

google.cloud.orgpolicy_v2.types.CustomConstraint

update_policy(request: Optional[Union[google.cloud.orgpolicy_v2.types.orgpolicy.UpdatePolicyRequest, dict]] = None, *, policy: Optional[google.cloud.orgpolicy_v2.types.orgpolicy.Policy] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.orgpolicy_v2.types.orgpolicy.Policy[source]¶

Updates a policy.

Returns a google.rpc.Status with google.rpc.Code.NOT_FOUND if the constraint or the policy do not exist. Returns a google.rpc.Status with google.rpc.Code.ABORTED if the etag supplied in the request does not match the persisted etag of the policy

Note: the supplied policy will perform a full overwrite of all fields.

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

def sample_update_policy():
    # Create a client
    client = orgpolicy_v2.OrgPolicyClient()

    # Initialize request argument(s)
    request = orgpolicy_v2.UpdatePolicyRequest(
    )

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

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.orgpolicy_v2.types.UpdatePolicyRequest, dict]) – The request object. The request sent to the [UpdatePolicyRequest] [google.cloud.orgpolicy.v2.OrgPolicy.UpdatePolicy] method.
policy (google.cloud.orgpolicy_v2.types.Policy) – Required. Policy to update. This corresponds to the policy field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Defines an organization policy which is used to specify constraints for configurations of Google Cloud resources.

Return type

google.cloud.orgpolicy_v2.types.Policy

class google.cloud.orgpolicy_v2.services.org_policy.pagers.ListConstraintsAsyncPager(method: Callable[[...], Awaitable[google.cloud.orgpolicy_v2.types.orgpolicy.ListConstraintsResponse]], request: google.cloud.orgpolicy_v2.types.orgpolicy.ListConstraintsRequest, response: google.cloud.orgpolicy_v2.types.orgpolicy.ListConstraintsResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]¶

A pager for iterating through list_constraints requests.

This class thinly wraps an initial google.cloud.orgpolicy_v2.types.ListConstraintsResponse object, and provides an __aiter__ method to iterate through its constraints field.

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

All the usual google.cloud.orgpolicy_v2.types.ListConstraintsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiates the pager.

Parameters

method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.cloud.orgpolicy_v2.types.ListConstraintsRequest) – The initial request object.
response (google.cloud.orgpolicy_v2.types.ListConstraintsResponse) – The initial response object.
retry (google.api_core.retry.AsyncRetry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

class google.cloud.orgpolicy_v2.services.org_policy.pagers.ListConstraintsPager(method: Callable[[...], google.cloud.orgpolicy_v2.types.orgpolicy.ListConstraintsResponse], request: google.cloud.orgpolicy_v2.types.orgpolicy.ListConstraintsRequest, response: google.cloud.orgpolicy_v2.types.orgpolicy.ListConstraintsResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]¶

A pager for iterating through list_constraints requests.

This class thinly wraps an initial google.cloud.orgpolicy_v2.types.ListConstraintsResponse object, and provides an __iter__ method to iterate through its constraints field.

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

All the usual google.cloud.orgpolicy_v2.types.ListConstraintsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiate the pager.

Parameters

method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.cloud.orgpolicy_v2.types.ListConstraintsRequest) – The initial request object.
response (google.cloud.orgpolicy_v2.types.ListConstraintsResponse) – The initial response object.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

class google.cloud.orgpolicy_v2.services.org_policy.pagers.ListCustomConstraintsAsyncPager(method: Callable[[...], Awaitable[google.cloud.orgpolicy_v2.types.orgpolicy.ListCustomConstraintsResponse]], request: google.cloud.orgpolicy_v2.types.orgpolicy.ListCustomConstraintsRequest, response: google.cloud.orgpolicy_v2.types.orgpolicy.ListCustomConstraintsResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]¶

A pager for iterating through list_custom_constraints requests.

This class thinly wraps an initial google.cloud.orgpolicy_v2.types.ListCustomConstraintsResponse object, and provides an __aiter__ method to iterate through its custom_constraints field.

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

All the usual google.cloud.orgpolicy_v2.types.ListCustomConstraintsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiates the pager.

Parameters

method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.cloud.orgpolicy_v2.types.ListCustomConstraintsRequest) – The initial request object.
response (google.cloud.orgpolicy_v2.types.ListCustomConstraintsResponse) – The initial response object.
retry (google.api_core.retry.AsyncRetry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

class google.cloud.orgpolicy_v2.services.org_policy.pagers.ListCustomConstraintsPager(method: Callable[[...], google.cloud.orgpolicy_v2.types.orgpolicy.ListCustomConstraintsResponse], request: google.cloud.orgpolicy_v2.types.orgpolicy.ListCustomConstraintsRequest, response: google.cloud.orgpolicy_v2.types.orgpolicy.ListCustomConstraintsResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]¶

A pager for iterating through list_custom_constraints requests.

This class thinly wraps an initial google.cloud.orgpolicy_v2.types.ListCustomConstraintsResponse object, and provides an __iter__ method to iterate through its custom_constraints field.

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

All the usual google.cloud.orgpolicy_v2.types.ListCustomConstraintsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiate the pager.

Parameters

method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.cloud.orgpolicy_v2.types.ListCustomConstraintsRequest) – The initial request object.
response (google.cloud.orgpolicy_v2.types.ListCustomConstraintsResponse) – The initial response object.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

class google.cloud.orgpolicy_v2.services.org_policy.pagers.ListPoliciesAsyncPager(method: Callable[[...], Awaitable[google.cloud.orgpolicy_v2.types.orgpolicy.ListPoliciesResponse]], request: google.cloud.orgpolicy_v2.types.orgpolicy.ListPoliciesRequest, response: google.cloud.orgpolicy_v2.types.orgpolicy.ListPoliciesResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]¶

A pager for iterating through list_policies requests.

This class thinly wraps an initial google.cloud.orgpolicy_v2.types.ListPoliciesResponse object, and provides an __aiter__ method to iterate through its policies field.

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

All the usual google.cloud.orgpolicy_v2.types.ListPoliciesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiates the pager.

Parameters

method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.cloud.orgpolicy_v2.types.ListPoliciesRequest) – The initial request object.
response (google.cloud.orgpolicy_v2.types.ListPoliciesResponse) – The initial response object.
retry (google.api_core.retry.AsyncRetry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

class google.cloud.orgpolicy_v2.services.org_policy.pagers.ListPoliciesPager(method: Callable[[...], google.cloud.orgpolicy_v2.types.orgpolicy.ListPoliciesResponse], request: google.cloud.orgpolicy_v2.types.orgpolicy.ListPoliciesRequest, response: google.cloud.orgpolicy_v2.types.orgpolicy.ListPoliciesResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]¶

A pager for iterating through list_policies requests.

This class thinly wraps an initial google.cloud.orgpolicy_v2.types.ListPoliciesResponse object, and provides an __iter__ method to iterate through its policies field.

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

All the usual google.cloud.orgpolicy_v2.types.ListPoliciesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiate the pager.

Parameters

method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.cloud.orgpolicy_v2.types.ListPoliciesRequest) – The initial request object.
response (google.cloud.orgpolicy_v2.types.ListPoliciesResponse) – The initial response object.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

OrgPolicy¶

google-cloud-org-policy

Navigation

Related Topics