Package Methods (1.11.1)

Summary of entries of Methods for orgpolicy.

google.cloud.orgpolicy_v2.services.org_policy.OrgPolicyAsyncClient

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 =

Instantiates the org policy async client.

See more: google.cloud.orgpolicy_v2.services.org_policy.OrgPolicyAsyncClient

google.cloud.orgpolicy_v2.services.org_policy.OrgPolicyAsyncClient.common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

See more: google.cloud.orgpolicy_v2.services.org_policy.OrgPolicyAsyncClient.common_billing_account_path

google.cloud.orgpolicy_v2.services.org_policy.OrgPolicyAsyncClient.common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

See more: google.cloud.orgpolicy_v2.services.org_policy.OrgPolicyAsyncClient.common_folder_path

google.cloud.orgpolicy_v2.services.org_policy.OrgPolicyAsyncClient.common_location_path

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

Returns a fully-qualified location string.

See more: google.cloud.orgpolicy_v2.services.org_policy.OrgPolicyAsyncClient.common_location_path

google.cloud.orgpolicy_v2.services.org_policy.OrgPolicyAsyncClient.common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

See more: google.cloud.orgpolicy_v2.services.org_policy.OrgPolicyAsyncClient.common_organization_path

google.cloud.orgpolicy_v2.services.org_policy.OrgPolicyAsyncClient.common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

See more: google.cloud.orgpolicy_v2.services.org_policy.OrgPolicyAsyncClient.common_project_path

google.cloud.orgpolicy_v2.services.org_policy.OrgPolicyAsyncClient.constraint_path

constraint_path(project: str, constraint: str) -> str

Returns a fully-qualified constraint string.

See more: google.cloud.orgpolicy_v2.services.org_policy.OrgPolicyAsyncClient.constraint_path

google.cloud.orgpolicy_v2.services.org_policy.OrgPolicyAsyncClient.create_custom_constraint

create_custom_constraint(
    request: typing.Optional[
        typing.Union[
            google.cloud.orgpolicy_v2.types.orgpolicy.CreateCustomConstraintRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    custom_constraint: typing.Optional[
        google.cloud.orgpolicy_v2.types.constraint.CustomConstraint
    ] = 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, str]] = ()
) -> google.cloud.orgpolicy_v2.types.constraint.CustomConstraint

Creates a custom constraint.

See more: google.cloud.orgpolicy_v2.services.org_policy.OrgPolicyAsyncClient.create_custom_constraint

google.cloud.orgpolicy_v2.services.org_policy.OrgPolicyAsyncClient.create_policy

create_policy(
    request: typing.Optional[
        typing.Union[
            google.cloud.orgpolicy_v2.types.orgpolicy.CreatePolicyRequest, dict
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    policy: typing.Optional[google.cloud.orgpolicy_v2.types.orgpolicy.Policy] = 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, str]] = ()
) -> google.cloud.orgpolicy_v2.types.orgpolicy.Policy

Creates a policy.

See more: google.cloud.orgpolicy_v2.services.org_policy.OrgPolicyAsyncClient.create_policy

google.cloud.orgpolicy_v2.services.org_policy.OrgPolicyAsyncClient.custom_constraint_path

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

Returns a fully-qualified custom_constraint string.

See more: google.cloud.orgpolicy_v2.services.org_policy.OrgPolicyAsyncClient.custom_constraint_path

google.cloud.orgpolicy_v2.services.org_policy.OrgPolicyAsyncClient.delete_custom_constraint

delete_custom_constraint(
    request: typing.Optional[
        typing.Union[
            google.cloud.orgpolicy_v2.types.orgpolicy.DeleteCustomConstraintRequest,
            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, str]] = ()
) -> None

Deletes a custom constraint.

See more: google.cloud.orgpolicy_v2.services.org_policy.OrgPolicyAsyncClient.delete_custom_constraint

google.cloud.orgpolicy_v2.services.org_policy.OrgPolicyAsyncClient.delete_policy

delete_policy(
    request: typing.Optional[
        typing.Union[
            google.cloud.orgpolicy_v2.types.orgpolicy.DeletePolicyRequest, 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, str]] = ()
) -> None

Deletes a policy.

See more: google.cloud.orgpolicy_v2.services.org_policy.OrgPolicyAsyncClient.delete_policy

google.cloud.orgpolicy_v2.services.org_policy.OrgPolicyAsyncClient.from_service_account_file

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

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

See more: google.cloud.orgpolicy_v2.services.org_policy.OrgPolicyAsyncClient.from_service_account_file

google.cloud.orgpolicy_v2.services.org_policy.OrgPolicyAsyncClient.from_service_account_info

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

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

See more: google.cloud.orgpolicy_v2.services.org_policy.OrgPolicyAsyncClient.from_service_account_info

google.cloud.orgpolicy_v2.services.org_policy.OrgPolicyAsyncClient.from_service_account_json

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

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

See more: google.cloud.orgpolicy_v2.services.org_policy.OrgPolicyAsyncClient.from_service_account_json

google.cloud.orgpolicy_v2.services.org_policy.OrgPolicyAsyncClient.get_custom_constraint

get_custom_constraint(
    request: typing.Optional[
        typing.Union[
            google.cloud.orgpolicy_v2.types.orgpolicy.GetCustomConstraintRequest, 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, str]] = ()
) -> google.cloud.orgpolicy_v2.types.constraint.CustomConstraint

Gets a custom constraint.

See more: google.cloud.orgpolicy_v2.services.org_policy.OrgPolicyAsyncClient.get_custom_constraint

google.cloud.orgpolicy_v2.services.org_policy.OrgPolicyAsyncClient.get_effective_policy

get_effective_policy(
    request: typing.Optional[
        typing.Union[
            google.cloud.orgpolicy_v2.types.orgpolicy.GetEffectivePolicyRequest, 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, str]] = ()
) -> google.cloud.orgpolicy_v2.types.orgpolicy.Policy

Gets the effective policy on a resource.

See more: google.cloud.orgpolicy_v2.services.org_policy.OrgPolicyAsyncClient.get_effective_policy

google.cloud.orgpolicy_v2.services.org_policy.OrgPolicyAsyncClient.get_mtls_endpoint_and_cert_source

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

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

See more: google.cloud.orgpolicy_v2.services.org_policy.OrgPolicyAsyncClient.get_mtls_endpoint_and_cert_source

google.cloud.orgpolicy_v2.services.org_policy.OrgPolicyAsyncClient.get_policy

get_policy(
    request: typing.Optional[
        typing.Union[google.cloud.orgpolicy_v2.types.orgpolicy.GetPolicyRequest, 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, str]] = ()
) -> google.cloud.orgpolicy_v2.types.orgpolicy.Policy

Gets a policy on a resource.

See more: google.cloud.orgpolicy_v2.services.org_policy.OrgPolicyAsyncClient.get_policy

google.cloud.orgpolicy_v2.services.org_policy.OrgPolicyAsyncClient.get_transport_class

get_transport_class(
    label: typing.Optional[str] = None,
) -> typing.Type[
    google.cloud.orgpolicy_v2.services.org_policy.transports.base.OrgPolicyTransport
]

Returns an appropriate transport class.

See more: google.cloud.orgpolicy_v2.services.org_policy.OrgPolicyAsyncClient.get_transport_class

google.cloud.orgpolicy_v2.services.org_policy.OrgPolicyAsyncClient.list_constraints

list_constraints(
    request: typing.Optional[
        typing.Union[
            google.cloud.orgpolicy_v2.types.orgpolicy.ListConstraintsRequest, 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, str]] = ()
) -> google.cloud.orgpolicy_v2.services.org_policy.pagers.ListConstraintsAsyncPager

Lists constraints that could be applied on the specified resource.

See more: google.cloud.orgpolicy_v2.services.org_policy.OrgPolicyAsyncClient.list_constraints

google.cloud.orgpolicy_v2.services.org_policy.OrgPolicyAsyncClient.list_custom_constraints

list_custom_constraints(
    request: typing.Optional[
        typing.Union[
            google.cloud.orgpolicy_v2.types.orgpolicy.ListCustomConstraintsRequest, 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, str]] = ()
) -> (
    google.cloud.orgpolicy_v2.services.org_policy.pagers.ListCustomConstraintsAsyncPager
)

Retrieves all of the custom constraints that exist on a particular organization resource.

See more: google.cloud.orgpolicy_v2.services.org_policy.OrgPolicyAsyncClient.list_custom_constraints

google.cloud.orgpolicy_v2.services.org_policy.OrgPolicyAsyncClient.list_policies

list_policies(
    request: typing.Optional[
        typing.Union[
            google.cloud.orgpolicy_v2.types.orgpolicy.ListPoliciesRequest, 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, str]] = ()
) -> google.cloud.orgpolicy_v2.services.org_policy.pagers.ListPoliciesAsyncPager

Retrieves all of the policies that exist on a particular resource.

See more: google.cloud.orgpolicy_v2.services.org_policy.OrgPolicyAsyncClient.list_policies

google.cloud.orgpolicy_v2.services.org_policy.OrgPolicyAsyncClient.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.

See more: google.cloud.orgpolicy_v2.services.org_policy.OrgPolicyAsyncClient.parse_common_billing_account_path

google.cloud.orgpolicy_v2.services.org_policy.OrgPolicyAsyncClient.parse_common_folder_path

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

Parse a folder path into its component segments.

See more: google.cloud.orgpolicy_v2.services.org_policy.OrgPolicyAsyncClient.parse_common_folder_path

google.cloud.orgpolicy_v2.services.org_policy.OrgPolicyAsyncClient.parse_common_location_path

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

Parse a location path into its component segments.

See more: google.cloud.orgpolicy_v2.services.org_policy.OrgPolicyAsyncClient.parse_common_location_path

google.cloud.orgpolicy_v2.services.org_policy.OrgPolicyAsyncClient.parse_common_organization_path

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

Parse a organization path into its component segments.

See more: google.cloud.orgpolicy_v2.services.org_policy.OrgPolicyAsyncClient.parse_common_organization_path

google.cloud.orgpolicy_v2.services.org_policy.OrgPolicyAsyncClient.parse_common_project_path

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

Parse a project path into its component segments.

See more: google.cloud.orgpolicy_v2.services.org_policy.OrgPolicyAsyncClient.parse_common_project_path

google.cloud.orgpolicy_v2.services.org_policy.OrgPolicyAsyncClient.parse_constraint_path

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

Parses a constraint path into its component segments.

See more: google.cloud.orgpolicy_v2.services.org_policy.OrgPolicyAsyncClient.parse_constraint_path

google.cloud.orgpolicy_v2.services.org_policy.OrgPolicyAsyncClient.parse_custom_constraint_path

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

Parses a custom_constraint path into its component segments.

See more: google.cloud.orgpolicy_v2.services.org_policy.OrgPolicyAsyncClient.parse_custom_constraint_path

google.cloud.orgpolicy_v2.services.org_policy.OrgPolicyAsyncClient.parse_policy_path

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

Parses a policy path into its component segments.

See more: google.cloud.orgpolicy_v2.services.org_policy.OrgPolicyAsyncClient.parse_policy_path

google.cloud.orgpolicy_v2.services.org_policy.OrgPolicyAsyncClient.policy_path

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

Returns a fully-qualified policy string.

See more: google.cloud.orgpolicy_v2.services.org_policy.OrgPolicyAsyncClient.policy_path

google.cloud.orgpolicy_v2.services.org_policy.OrgPolicyAsyncClient.update_custom_constraint

update_custom_constraint(
    request: typing.Optional[
        typing.Union[
            google.cloud.orgpolicy_v2.types.orgpolicy.UpdateCustomConstraintRequest,
            dict,
        ]
    ] = None,
    *,
    custom_constraint: typing.Optional[
        google.cloud.orgpolicy_v2.types.constraint.CustomConstraint
    ] = 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, str]] = ()
) -> google.cloud.orgpolicy_v2.types.constraint.CustomConstraint

Updates a custom constraint.

See more: google.cloud.orgpolicy_v2.services.org_policy.OrgPolicyAsyncClient.update_custom_constraint

google.cloud.orgpolicy_v2.services.org_policy.OrgPolicyAsyncClient.update_policy

update_policy(
    request: typing.Optional[
        typing.Union[
            google.cloud.orgpolicy_v2.types.orgpolicy.UpdatePolicyRequest, dict
        ]
    ] = None,
    *,
    policy: typing.Optional[google.cloud.orgpolicy_v2.types.orgpolicy.Policy] = 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, str]] = ()
) -> google.cloud.orgpolicy_v2.types.orgpolicy.Policy

Updates a policy.

See more: google.cloud.orgpolicy_v2.services.org_policy.OrgPolicyAsyncClient.update_policy

google.cloud.orgpolicy_v2.services.org_policy.OrgPolicyClient

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 =

Instantiates the org policy client.

See more: google.cloud.orgpolicy_v2.services.org_policy.OrgPolicyClient

google.cloud.orgpolicy_v2.services.org_policy.OrgPolicyClient.__exit__

__exit__(type, value, traceback)

Releases underlying transport's resources.

See more: google.cloud.orgpolicy_v2.services.org_policy.OrgPolicyClient.exit

google.cloud.orgpolicy_v2.services.org_policy.OrgPolicyClient.common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

See more: google.cloud.orgpolicy_v2.services.org_policy.OrgPolicyClient.common_billing_account_path

google.cloud.orgpolicy_v2.services.org_policy.OrgPolicyClient.common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

See more: google.cloud.orgpolicy_v2.services.org_policy.OrgPolicyClient.common_folder_path

google.cloud.orgpolicy_v2.services.org_policy.OrgPolicyClient.common_location_path

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

Returns a fully-qualified location string.

See more: google.cloud.orgpolicy_v2.services.org_policy.OrgPolicyClient.common_location_path

google.cloud.orgpolicy_v2.services.org_policy.OrgPolicyClient.common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

See more: google.cloud.orgpolicy_v2.services.org_policy.OrgPolicyClient.common_organization_path

google.cloud.orgpolicy_v2.services.org_policy.OrgPolicyClient.common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

See more: google.cloud.orgpolicy_v2.services.org_policy.OrgPolicyClient.common_project_path

google.cloud.orgpolicy_v2.services.org_policy.OrgPolicyClient.constraint_path

constraint_path(project: str, constraint: str) -> str

Returns a fully-qualified constraint string.

See more: google.cloud.orgpolicy_v2.services.org_policy.OrgPolicyClient.constraint_path

google.cloud.orgpolicy_v2.services.org_policy.OrgPolicyClient.create_custom_constraint

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

Creates a custom constraint.

See more: google.cloud.orgpolicy_v2.services.org_policy.OrgPolicyClient.create_custom_constraint

google.cloud.orgpolicy_v2.services.org_policy.OrgPolicyClient.create_policy

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

Creates a policy.

See more: google.cloud.orgpolicy_v2.services.org_policy.OrgPolicyClient.create_policy

google.cloud.orgpolicy_v2.services.org_policy.OrgPolicyClient.custom_constraint_path

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

Returns a fully-qualified custom_constraint string.

See more: google.cloud.orgpolicy_v2.services.org_policy.OrgPolicyClient.custom_constraint_path

google.cloud.orgpolicy_v2.services.org_policy.OrgPolicyClient.delete_custom_constraint

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

Deletes a custom constraint.

See more: google.cloud.orgpolicy_v2.services.org_policy.OrgPolicyClient.delete_custom_constraint

google.cloud.orgpolicy_v2.services.org_policy.OrgPolicyClient.delete_policy

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

Deletes a policy.

See more: google.cloud.orgpolicy_v2.services.org_policy.OrgPolicyClient.delete_policy

google.cloud.orgpolicy_v2.services.org_policy.OrgPolicyClient.from_service_account_file

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

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

See more: google.cloud.orgpolicy_v2.services.org_policy.OrgPolicyClient.from_service_account_file

google.cloud.orgpolicy_v2.services.org_policy.OrgPolicyClient.from_service_account_info

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

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

See more: google.cloud.orgpolicy_v2.services.org_policy.OrgPolicyClient.from_service_account_info

google.cloud.orgpolicy_v2.services.org_policy.OrgPolicyClient.from_service_account_json

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

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

See more: google.cloud.orgpolicy_v2.services.org_policy.OrgPolicyClient.from_service_account_json

google.cloud.orgpolicy_v2.services.org_policy.OrgPolicyClient.get_custom_constraint

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

Gets a custom constraint.

See more: google.cloud.orgpolicy_v2.services.org_policy.OrgPolicyClient.get_custom_constraint

google.cloud.orgpolicy_v2.services.org_policy.OrgPolicyClient.get_effective_policy

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

Gets the effective policy on a resource.

See more: google.cloud.orgpolicy_v2.services.org_policy.OrgPolicyClient.get_effective_policy

google.cloud.orgpolicy_v2.services.org_policy.OrgPolicyClient.get_mtls_endpoint_and_cert_source

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

Deprecated.

See more: google.cloud.orgpolicy_v2.services.org_policy.OrgPolicyClient.get_mtls_endpoint_and_cert_source

google.cloud.orgpolicy_v2.services.org_policy.OrgPolicyClient.get_policy

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

Gets a policy on a resource.

See more: google.cloud.orgpolicy_v2.services.org_policy.OrgPolicyClient.get_policy

google.cloud.orgpolicy_v2.services.org_policy.OrgPolicyClient.list_constraints

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

Lists constraints that could be applied on the specified resource.

See more: google.cloud.orgpolicy_v2.services.org_policy.OrgPolicyClient.list_constraints

google.cloud.orgpolicy_v2.services.org_policy.OrgPolicyClient.list_custom_constraints

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

Retrieves all of the custom constraints that exist on a particular organization resource.

See more: google.cloud.orgpolicy_v2.services.org_policy.OrgPolicyClient.list_custom_constraints

google.cloud.orgpolicy_v2.services.org_policy.OrgPolicyClient.list_policies

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

Retrieves all of the policies that exist on a particular resource.

See more: google.cloud.orgpolicy_v2.services.org_policy.OrgPolicyClient.list_policies

google.cloud.orgpolicy_v2.services.org_policy.OrgPolicyClient.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.

See more: google.cloud.orgpolicy_v2.services.org_policy.OrgPolicyClient.parse_common_billing_account_path

google.cloud.orgpolicy_v2.services.org_policy.OrgPolicyClient.parse_common_folder_path

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

Parse a folder path into its component segments.

See more: google.cloud.orgpolicy_v2.services.org_policy.OrgPolicyClient.parse_common_folder_path

google.cloud.orgpolicy_v2.services.org_policy.OrgPolicyClient.parse_common_location_path

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

Parse a location path into its component segments.

See more: google.cloud.orgpolicy_v2.services.org_policy.OrgPolicyClient.parse_common_location_path

google.cloud.orgpolicy_v2.services.org_policy.OrgPolicyClient.parse_common_organization_path

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

Parse a organization path into its component segments.

See more: google.cloud.orgpolicy_v2.services.org_policy.OrgPolicyClient.parse_common_organization_path

google.cloud.orgpolicy_v2.services.org_policy.OrgPolicyClient.parse_common_project_path

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

Parse a project path into its component segments.

See more: google.cloud.orgpolicy_v2.services.org_policy.OrgPolicyClient.parse_common_project_path

google.cloud.orgpolicy_v2.services.org_policy.OrgPolicyClient.parse_constraint_path

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

Parses a constraint path into its component segments.

See more: google.cloud.orgpolicy_v2.services.org_policy.OrgPolicyClient.parse_constraint_path

google.cloud.orgpolicy_v2.services.org_policy.OrgPolicyClient.parse_custom_constraint_path

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

Parses a custom_constraint path into its component segments.

See more: google.cloud.orgpolicy_v2.services.org_policy.OrgPolicyClient.parse_custom_constraint_path

google.cloud.orgpolicy_v2.services.org_policy.OrgPolicyClient.parse_policy_path

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

Parses a policy path into its component segments.

See more: google.cloud.orgpolicy_v2.services.org_policy.OrgPolicyClient.parse_policy_path

google.cloud.orgpolicy_v2.services.org_policy.OrgPolicyClient.policy_path

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

Returns a fully-qualified policy string.

See more: google.cloud.orgpolicy_v2.services.org_policy.OrgPolicyClient.policy_path

google.cloud.orgpolicy_v2.services.org_policy.OrgPolicyClient.update_custom_constraint

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

Updates a custom constraint.

See more: google.cloud.orgpolicy_v2.services.org_policy.OrgPolicyClient.update_custom_constraint

google.cloud.orgpolicy_v2.services.org_policy.OrgPolicyClient.update_policy

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

Updates a policy.

See more: google.cloud.orgpolicy_v2.services.org_policy.OrgPolicyClient.update_policy

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

ListConstraintsAsyncPager(
    method: typing.Callable[
        [...],
        typing.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: 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, str]] = ()
)

Instantiates the pager.

See more: google.cloud.orgpolicy_v2.services.org_policy.pagers.ListConstraintsAsyncPager

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

ListConstraintsPager(
    method: typing.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: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)

Instantiate the pager.

See more: google.cloud.orgpolicy_v2.services.org_policy.pagers.ListConstraintsPager

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

ListCustomConstraintsAsyncPager(
    method: typing.Callable[
        [...],
        typing.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: 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, str]] = ()
)

Instantiates the pager.

See more: google.cloud.orgpolicy_v2.services.org_policy.pagers.ListCustomConstraintsAsyncPager

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

ListCustomConstraintsPager(
    method: typing.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: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)

Instantiate the pager.

See more: google.cloud.orgpolicy_v2.services.org_policy.pagers.ListCustomConstraintsPager

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

ListPoliciesAsyncPager(
    method: typing.Callable[
        [...],
        typing.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: 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, str]] = ()
)

Instantiates the pager.

See more: google.cloud.orgpolicy_v2.services.org_policy.pagers.ListPoliciesAsyncPager

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

ListPoliciesPager(
    method: typing.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: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)

Instantiate the pager.

See more: google.cloud.orgpolicy_v2.services.org_policy.pagers.ListPoliciesPager