Identity and Access Management (IAM) v3beta API - Class PolicyBindingsClientImpl (1.0.0-beta01)

public sealed class PolicyBindingsClientImpl : PolicyBindingsClient

Reference documentation and code samples for the Identity and Access Management (IAM) v3beta API class PolicyBindingsClientImpl.

PolicyBindings client wrapper implementation, for convenient use.

Inheritance

object > PolicyBindingsClient > PolicyBindingsClientImpl

Namespace

Google.Cloud.Iam.V3Beta

Assembly

Google.Cloud.Iam.V3Beta.dll

Remarks

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

Constructors

PolicyBindingsClientImpl(PolicyBindingsClient, PolicyBindingsSettings, ILogger)

public PolicyBindingsClientImpl(PolicyBindings.PolicyBindingsClient grpcClient, PolicyBindingsSettings settings, ILogger logger)

Constructs a client wrapper for the PolicyBindings service, with the specified gRPC client and settings.

Parameters
Name Description
grpcClient PolicyBindingsPolicyBindingsClient

The underlying gRPC client.

settings PolicyBindingsSettings

The base PolicyBindingsSettings used within this client.

logger ILogger

Optional ILogger to use within this client.

Properties

CreatePolicyBindingOperationsClient

public override OperationsClient CreatePolicyBindingOperationsClient { get; }

The long-running operations client for CreatePolicyBinding.

Property Value
Type Description
OperationsClient
Overrides

DeletePolicyBindingOperationsClient

public override OperationsClient DeletePolicyBindingOperationsClient { get; }

The long-running operations client for DeletePolicyBinding.

Property Value
Type Description
OperationsClient
Overrides

GrpcClient

public override PolicyBindings.PolicyBindingsClient GrpcClient { get; }

The underlying gRPC PolicyBindings client

Property Value
Type Description
PolicyBindingsPolicyBindingsClient
Overrides

LocationsClient

public override LocationsClient LocationsClient { get; }

The LocationsClient associated with this client.

Property Value
Type Description
LocationsClient
Overrides

UpdatePolicyBindingOperationsClient

public override OperationsClient UpdatePolicyBindingOperationsClient { get; }

The long-running operations client for UpdatePolicyBinding.

Property Value
Type Description
OperationsClient
Overrides

Methods

CreatePolicyBinding(CreatePolicyBindingRequest, CallSettings)

public override Operation<PolicyBinding, OperationMetadata> CreatePolicyBinding(CreatePolicyBindingRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request CreatePolicyBindingRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationPolicyBindingOperationMetadata

The RPC response.

Overrides

CreatePolicyBindingAsync(CreatePolicyBindingRequest, CallSettings)

public override Task<Operation<PolicyBinding, OperationMetadata>> CreatePolicyBindingAsync(CreatePolicyBindingRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request CreatePolicyBindingRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationPolicyBindingOperationMetadata

A Task containing the RPC response.

Overrides

DeletePolicyBinding(DeletePolicyBindingRequest, CallSettings)

public override Operation<Empty, OperationMetadata> DeletePolicyBinding(DeletePolicyBindingRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request DeletePolicyBindingRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationEmptyOperationMetadata

The RPC response.

Overrides

DeletePolicyBindingAsync(DeletePolicyBindingRequest, CallSettings)

public override Task<Operation<Empty, OperationMetadata>> DeletePolicyBindingAsync(DeletePolicyBindingRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request DeletePolicyBindingRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationEmptyOperationMetadata

A Task containing the RPC response.

Overrides

GetPolicyBinding(GetPolicyBindingRequest, CallSettings)

public override PolicyBinding GetPolicyBinding(GetPolicyBindingRequest request, CallSettings callSettings = null)

Gets a policy binding.

Parameters
Name Description
request GetPolicyBindingRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PolicyBinding

The RPC response.

Overrides

GetPolicyBindingAsync(GetPolicyBindingRequest, CallSettings)

public override Task<PolicyBinding> GetPolicyBindingAsync(GetPolicyBindingRequest request, CallSettings callSettings = null)

Gets a policy binding.

Parameters
Name Description
request GetPolicyBindingRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskPolicyBinding

A Task containing the RPC response.

Overrides

ListPolicyBindings(ListPolicyBindingsRequest, CallSettings)

public override PagedEnumerable<ListPolicyBindingsResponse, PolicyBinding> ListPolicyBindings(ListPolicyBindingsRequest request, CallSettings callSettings = null)

Lists policy bindings.

Parameters
Name Description
request ListPolicyBindingsRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerableListPolicyBindingsResponsePolicyBinding

A pageable sequence of PolicyBinding resources.

Overrides

ListPolicyBindingsAsync(ListPolicyBindingsRequest, CallSettings)

public override PagedAsyncEnumerable<ListPolicyBindingsResponse, PolicyBinding> ListPolicyBindingsAsync(ListPolicyBindingsRequest request, CallSettings callSettings = null)

Lists policy bindings.

Parameters
Name Description
request ListPolicyBindingsRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerableListPolicyBindingsResponsePolicyBinding

A pageable asynchronous sequence of PolicyBinding resources.

Overrides

SearchTargetPolicyBindings(SearchTargetPolicyBindingsRequest, CallSettings)

public override PagedEnumerable<SearchTargetPolicyBindingsResponse, PolicyBinding> SearchTargetPolicyBindings(SearchTargetPolicyBindingsRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request SearchTargetPolicyBindingsRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerableSearchTargetPolicyBindingsResponsePolicyBinding

A pageable sequence of PolicyBinding resources.

Overrides

SearchTargetPolicyBindingsAsync(SearchTargetPolicyBindingsRequest, CallSettings)

public override PagedAsyncEnumerable<SearchTargetPolicyBindingsResponse, PolicyBinding> SearchTargetPolicyBindingsAsync(SearchTargetPolicyBindingsRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request SearchTargetPolicyBindingsRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerableSearchTargetPolicyBindingsResponsePolicyBinding

A pageable asynchronous sequence of PolicyBinding resources.

Overrides

UpdatePolicyBinding(UpdatePolicyBindingRequest, CallSettings)

public override Operation<PolicyBinding, OperationMetadata> UpdatePolicyBinding(UpdatePolicyBindingRequest request, CallSettings callSettings = null)

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, and the IAM permission to remove the existing policy from the binding. Target is immutable and cannot be updated. Once the binding is updated, the new policy is applied to the target.

Parameters
Name Description
request UpdatePolicyBindingRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationPolicyBindingOperationMetadata

The RPC response.

Overrides

UpdatePolicyBindingAsync(UpdatePolicyBindingRequest, CallSettings)

public override Task<Operation<PolicyBinding, OperationMetadata>> UpdatePolicyBindingAsync(UpdatePolicyBindingRequest request, CallSettings callSettings = null)

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, and the IAM permission to remove the existing policy from the binding. Target is immutable and cannot be updated. Once the binding is updated, the new policy is applied to the target.

Parameters
Name Description
request UpdatePolicyBindingRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationPolicyBindingOperationMetadata

A Task containing the RPC response.

Overrides