Class PolicyBindingsAsyncClient (2.23.0) 

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

An interface for managing Identity and Access Management (IAM) policy bindings.

Properties

api_endpoint

Return the API endpoint used by the client instance.

Returns
Type Description
str The API endpoint used by the client instance.

transport

Returns the transport used by the client instance.

Returns
Type Description
PolicyBindingsTransport The transport used by the client instance.

universe_domain

Return the universe domain used by the client instance.

Returns
Type Description
str The universe domain used by the client instance.

Methods

PolicyBindingsAsyncClient

PolicyBindingsAsyncClient(
    *,
    credentials: typing.Optional[google.auth.credentials.Credentials] = None,
    transport: typing.Optional[
        typing.Union[
            str,
            google.cloud.iam_v3beta.services.policy_bindings.transports.base.PolicyBindingsTransport,
            typing.Callable[
                [...],
                google.cloud.iam_v3beta.services.policy_bindings.transports.base.PolicyBindingsTransport,
            ],
        ]
    ] = "grpc_asyncio",
    client_options: typing.Optional[
        google.api_core.client_options.ClientOptions
    ] = None,
    client_info: google.api_core.gapic_v1.client_info.ClientInfo = google.api_core.gapic_v1.client_info.ClientInfo
)

Instantiates the policy bindings async client.

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

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

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 PolicyBindingsTransport constructor. If set to None, a transport is chosen automatically.
client_options Optional[Union[google.api_core.client_options.ClientOptions, dict]]

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

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

common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

common_location_path

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

Returns a fully-qualified location string.

common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

create_policy_binding

create_policy_binding(
    request: typing.Optional[
        typing.Union[
            google.cloud.iam_v3beta.types.policy_bindings_service.CreatePolicyBindingRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    policy_binding: typing.Optional[
        google.cloud.iam_v3beta.types.policy_binding_resources.PolicyBinding
    ] = None,
    policy_binding_id: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation_async.AsyncOperation

Creates a policy binding and returns a long-running operation. Callers will need the IAM permissions on both the policy and target. After the binding is created, the policy is applied to the target.

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

async def sample_create_policy_binding():
    # Create a client
    client = iam_v3beta.PolicyBindingsAsyncClient()

    # Initialize request argument(s)
    policy_binding = iam_v3beta.PolicyBinding()
    policy_binding.target.principal_set = "principal_set_value"
    policy_binding.policy = "policy_value"

    request = iam_v3beta.CreatePolicyBindingRequest(
        parent="parent_value",
        policy_binding_id="policy_binding_id_value",
        policy_binding=policy_binding,
    )

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

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

    response = (await operation).result()

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

The request object. Request message for CreatePolicyBinding method.
parent str

Required. The parent resource where this policy binding will be created. The binding parent is the closest Resource Manager resource (project, folder or organization) to the binding target. Format: - projects/{project_id}/locations/{location} - projects/{project_number}/locations/{location} - folders/{folder_id}/locations/{location} - organizations/{organization_id}/locations/{location} This corresponds to the parent field on the request instance; if request is provided, this should not be set.
policy_binding PolicyBinding

Required. The policy binding to create. This corresponds to the policy_binding field on the request instance; if request is provided, this should not be set.
policy_binding_id str

Required. The ID to use for the policy binding, which will become the final component of the policy binding's resource name. This value must start with a lowercase letter followed by up to 62 lowercase letters, numbers, hyphens, or dots. Pattern, /a-z][a-z0-9-.]{2,62}/. This corresponds to the policy_binding_id field on the request instance; if request is provided, this should not be set.
retry google.api_core.retry_async.AsyncRetry

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

The timeout for this request.
metadata Sequence[Tuple[str, Union[str, bytes]]]

Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.
Returns
Type Description
google.api_core.operation_async.AsyncOperation An object representing a long-running operation. The result type for the operation will be PolicyBinding IAM policy binding resource.

delete_policy_binding

delete_policy_binding(
    request: typing.Optional[
        typing.Union[
            google.cloud.iam_v3beta.types.policy_bindings_service.DeletePolicyBindingRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation_async.AsyncOperation

Deletes a policy binding and returns a long-running operation. Callers will need the IAM permissions on both the policy and target. After the binding is deleted, the policy no longer applies to the target.

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

async def sample_delete_policy_binding():
    # Create a client
    client = iam_v3beta.PolicyBindingsAsyncClient()

    # Initialize request argument(s)
    request = iam_v3beta.DeletePolicyBindingRequest(
        name="name_value",
    )

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

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

    response = (await operation).result()

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

The request object. Request message for DeletePolicyBinding method.
name str

Required. The name of the policy binding to delete. Format: - projects/{project_id}/locations/{location}/policyBindings/{policy_binding_id} - projects/{project_number}/locations/{location}/policyBindings/{policy_binding_id} - folders/{folder_id}/locations/{location}/policyBindings/{policy_binding_id} - organizations/{organization_id}/locations/{location}/policyBindings/{policy_binding_id} This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry google.api_core.retry_async.AsyncRetry

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

The timeout for this request.
metadata Sequence[Tuple[str, Union[str, bytes]]]

Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.
Returns
Type Description
google.api_core.operation_async.AsyncOperation An object representing a long-running operation. The result type for the operation will be google.protobuf.empty_pb2.Empty A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }

from_service_account_file

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

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

Parameter
Name Description
filename str

The path to the service account private key json file.
Returns
Type Description
PolicyBindingsAsyncClient The constructed client.

from_service_account_info

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

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

Parameter
Name Description
info dict

The service account private key info.
Returns
Type Description
PolicyBindingsAsyncClient The constructed client.

from_service_account_json

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

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

Parameter
Name Description
filename str

The path to the service account private key json file.
Returns
Type Description
PolicyBindingsAsyncClient The constructed client.

get_mtls_endpoint_and_cert_source

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

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

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

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

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

Parameter
Name Description
client_options google.api_core.client_options.ClientOptions

Custom options for the client. Only the api_endpoint and client_cert_source properties may be used in this method.
Exceptions
Type Description
google.auth.exceptions.MutualTLSChannelError If any errors happen.
Returns
Type Description
Tuple[str, Callable[[], Tuple[bytes, bytes]]] returns the API endpoint and the client cert source to use.

get_operation

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

Gets the latest state of a long-running operation.

Parameters
Name Description
request .operations_pb2.GetOperationRequest

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

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

The timeout for this request.
metadata Sequence[Tuple[str, Union[str, bytes]]]

Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.
Returns
Type Description
.operations_pb2.Operation An Operation object.

get_policy_binding

get_policy_binding(
    request: typing.Optional[
        typing.Union[
            google.cloud.iam_v3beta.types.policy_bindings_service.GetPolicyBindingRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.iam_v3beta.types.policy_binding_resources.PolicyBinding

Gets a policy binding.

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

async def sample_get_policy_binding():
    # Create a client
    client = iam_v3beta.PolicyBindingsAsyncClient()

    # Initialize request argument(s)
    request = iam_v3beta.GetPolicyBindingRequest(
        name="name_value",
    )

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

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

The request object. Request message for GetPolicyBinding method.
name str

Required. The name of the policy binding to retrieve. Format: - projects/{project_id}/locations/{location}/policyBindings/{policy_binding_id} - projects/{project_number}/locations/{location}/policyBindings/{policy_binding_id} - folders/{folder_id}/locations/{location}/policyBindings/{policy_binding_id} - organizations/{organization_id}/locations/{location}/policyBindings/{policy_binding_id} This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry google.api_core.retry_async.AsyncRetry

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

The timeout for this request.
metadata Sequence[Tuple[str, Union[str, bytes]]]

Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.
Returns
Type Description
google.cloud.iam_v3beta.types.PolicyBinding IAM policy binding resource.

get_transport_class

get_transport_class(
    label: typing.Optional[str] = None,
) -> typing.Type[
    google.cloud.iam_v3beta.services.policy_bindings.transports.base.PolicyBindingsTransport
]

Returns an appropriate transport class.

Parameter
Name Description
label typing.Optional[str]

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

list_policy_bindings

list_policy_bindings(
    request: typing.Optional[
        typing.Union[
            google.cloud.iam_v3beta.types.policy_bindings_service.ListPolicyBindingsRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> (
    google.cloud.iam_v3beta.services.policy_bindings.pagers.ListPolicyBindingsAsyncPager
)

Lists policy bindings.

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

async def sample_list_policy_bindings():
    # Create a client
    client = iam_v3beta.PolicyBindingsAsyncClient()

    # Initialize request argument(s)
    request = iam_v3beta.ListPolicyBindingsRequest(
        parent="parent_value",
    )

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

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

The request object. Request message for ListPolicyBindings method.
parent str

Required. The parent resource, which owns the collection of policy bindings. Format: - projects/{project_id}/locations/{location} - projects/{project_number}/locations/{location} - folders/{folder_id}/locations/{location} - organizations/{organization_id}/locations/{location} This corresponds to the parent field on the request instance; if request is provided, this should not be set.
retry google.api_core.retry_async.AsyncRetry

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

The timeout for this request.
metadata Sequence[Tuple[str, Union[str, bytes]]]

Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.
Returns
Type Description
google.cloud.iam_v3beta.services.policy_bindings.pagers.ListPolicyBindingsAsyncPager Response message for ListPolicyBindings method. Iterating over this object will yield results and resolve additional pages automatically.

parse_common_billing_account_path

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

Parse a billing_account path into its component segments.

parse_common_folder_path

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

Parse a folder path into its component segments.

parse_common_location_path

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

Parse a location path into its component segments.

parse_common_organization_path

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

Parse a organization path into its component segments.

parse_common_project_path

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

Parse a project path into its component segments.

parse_policy_binding_path

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

Parses a policy_binding path into its component segments.

policy_binding_path

policy_binding_path(organization: str, location: str, policy_binding: str) -> str

Returns a fully-qualified policy_binding string.

search_target_policy_bindings

search_target_policy_bindings(
    request: typing.Optional[
        typing.Union[
            google.cloud.iam_v3beta.types.policy_bindings_service.SearchTargetPolicyBindingsRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    target: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> (
    google.cloud.iam_v3beta.services.policy_bindings.pagers.SearchTargetPolicyBindingsAsyncPager
)

Search policy bindings by target. Returns all policy binding objects bound directly to target.

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

async def sample_search_target_policy_bindings():
    # Create a client
    client = iam_v3beta.PolicyBindingsAsyncClient()

    # Initialize request argument(s)
    request = iam_v3beta.SearchTargetPolicyBindingsRequest(
        target="target_value",
        parent="parent_value",
    )

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

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

The request object. Request message for SearchTargetPolicyBindings method.
parent str

Required. The parent resource where this search will be performed. This should be the nearest Resource Manager resource (project, folder, or organization) to the target. Format: - projects/{project_id}/locations/{location} - projects/{project_number}/locations/{location} - folders/{folder_id}/locations/{location} - organizations/{organization_id}/locations/{location} This corresponds to the parent field on the request instance; if request is provided, this should not be set.
target str

Required. The target resource, which is bound to the policy in the binding. Format: - //iam.googleapis.com/locations/global/workforcePools/POOL_ID - //iam.googleapis.com/projects/PROJECT_NUMBER/locations/global/workloadIdentityPools/POOL_ID - //iam.googleapis.com/locations/global/workspace/WORKSPACE_ID - //cloudresourcemanager.googleapis.com/projects/{project_number} - //cloudresourcemanager.googleapis.com/folders/{folder_id} - //cloudresourcemanager.googleapis.com/organizations/{organization_id} This corresponds to the target field on the request instance; if request is provided, this should not be set.
retry google.api_core.retry_async.AsyncRetry

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

The timeout for this request.
metadata Sequence[Tuple[str, Union[str, bytes]]]

Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.
Returns
Type Description
google.cloud.iam_v3beta.services.policy_bindings.pagers.SearchTargetPolicyBindingsAsyncPager Response message for SearchTargetPolicyBindings method. Iterating over this object will yield results and resolve additional pages automatically.

update_policy_binding

update_policy_binding(
    request: typing.Optional[
        typing.Union[
            google.cloud.iam_v3beta.types.policy_bindings_service.UpdatePolicyBindingRequest,
            dict,
        ]
    ] = None,
    *,
    policy_binding: typing.Optional[
        google.cloud.iam_v3beta.types.policy_binding_resources.PolicyBinding
    ] = None,
    update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation_async.AsyncOperation

Updates a policy binding and returns a long-running operation. Callers will need the IAM permissions on the policy and target in the binding to update. Target and policy are immutable and cannot be updated.

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

async def sample_update_policy_binding():
    # Create a client
    client = iam_v3beta.PolicyBindingsAsyncClient()

    # Initialize request argument(s)
    policy_binding = iam_v3beta.PolicyBinding()
    policy_binding.target.principal_set = "principal_set_value"
    policy_binding.policy = "policy_value"

    request = iam_v3beta.UpdatePolicyBindingRequest(
        policy_binding=policy_binding,
    )

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

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

    response = (await operation).result()

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

The request object. Request message for UpdatePolicyBinding method.
policy_binding PolicyBinding

Required. The policy binding to update. The policy binding's name field is used to identify the policy binding to update. This corresponds to the policy_binding field on the request instance; if request is provided, this should not be set.
update_mask google.protobuf.field_mask_pb2.FieldMask

Optional. The list of fields to update This corresponds to the update_mask field on the request instance; if request is provided, this should not be set.
retry google.api_core.retry_async.AsyncRetry

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

The timeout for this request.
metadata Sequence[Tuple[str, Union[str, bytes]]]

Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.
Returns
Type Description
google.api_core.operation_async.AsyncOperation An object representing a long-running operation. The result type for the operation will be PolicyBinding IAM policy binding resource.