Identity and Access Management (IAM) v3beta API - Class PolicyBindings.PolicyBindingsClient (1.0.0-beta01) 

public class PolicyBindings.PolicyBindingsClient : ClientBase<PolicyBindings.PolicyBindingsClient>

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

Client for PolicyBindings

Inheritance

object > ClientBase > ClientBasePolicyBindingsPolicyBindingsClient > PolicyBindings.PolicyBindingsClient

Namespace

Google.Cloud.Iam.V3Beta

Assembly

Google.Cloud.Iam.V3Beta.dll

Constructors

PolicyBindingsClient()

protected PolicyBindingsClient()

Protected parameterless constructor to allow creation of test doubles.

PolicyBindingsClient(CallInvoker)

public PolicyBindingsClient(CallInvoker callInvoker)

Creates a new client for PolicyBindings that uses a custom CallInvoker.

Parameter
Name Description
callInvoker CallInvoker

The callInvoker to use to make remote calls.

PolicyBindingsClient(ChannelBase)

public PolicyBindingsClient(ChannelBase channel)

Creates a new client for PolicyBindings

Parameter
Name Description
channel ChannelBase

The channel to use to make remote calls.

PolicyBindingsClient(ClientBaseConfiguration)

protected PolicyBindingsClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name Description
configuration ClientBaseClientBaseConfiguration

The client configuration.

Methods

CreateLocationsClient()

public virtual Locations.LocationsClient CreateLocationsClient()

Creates a new instance of Locations.LocationsClient using the same call invoker as this client.

Returns
Type Description
LocationsLocationsClient

A new Locations.LocationsClient for the same target as this client.

CreateOperationsClient()

public virtual Operations.OperationsClient CreateOperationsClient()

Creates a new instance of Operations.OperationsClient using the same call invoker as this client.

Returns
Type Description
OperationsOperationsClient

A new Operations client for the same target as this client.

CreatePolicyBinding(CreatePolicyBindingRequest, CallOptions)

public virtual Operation CreatePolicyBinding(CreatePolicyBindingRequest request, CallOptions options)

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 to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
Operation

The response received from the server.

CreatePolicyBinding(CreatePolicyBindingRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation CreatePolicyBinding(CreatePolicyBindingRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline System.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
Operation

The response received from the server.

CreatePolicyBindingAsync(CreatePolicyBindingRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> CreatePolicyBindingAsync(CreatePolicyBindingRequest request, CallOptions options)

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 to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallOperation

The call object.

CreatePolicyBindingAsync(CreatePolicyBindingRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> CreatePolicyBindingAsync(CreatePolicyBindingRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline System.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
AsyncUnaryCallOperation

The call object.

DeletePolicyBinding(DeletePolicyBindingRequest, CallOptions)

public virtual Operation DeletePolicyBinding(DeletePolicyBindingRequest request, CallOptions options)

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 to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
Operation

The response received from the server.

DeletePolicyBinding(DeletePolicyBindingRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation DeletePolicyBinding(DeletePolicyBindingRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline System.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
Operation

The response received from the server.

DeletePolicyBindingAsync(DeletePolicyBindingRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> DeletePolicyBindingAsync(DeletePolicyBindingRequest request, CallOptions options)

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 to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallOperation

The call object.

DeletePolicyBindingAsync(DeletePolicyBindingRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> DeletePolicyBindingAsync(DeletePolicyBindingRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline System.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
AsyncUnaryCallOperation

The call object.

GetPolicyBinding(GetPolicyBindingRequest, CallOptions)

public virtual PolicyBinding GetPolicyBinding(GetPolicyBindingRequest request, CallOptions options)

Gets a policy binding.

Parameters
Name Description
request GetPolicyBindingRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
PolicyBinding

The response received from the server.

GetPolicyBinding(GetPolicyBindingRequest, Metadata, DateTime?, CancellationToken)

public virtual PolicyBinding GetPolicyBinding(GetPolicyBindingRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets a policy binding.

Parameters
Name Description
request GetPolicyBindingRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline System.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
PolicyBinding

The response received from the server.

GetPolicyBindingAsync(GetPolicyBindingRequest, CallOptions)

public virtual AsyncUnaryCall<PolicyBinding> GetPolicyBindingAsync(GetPolicyBindingRequest request, CallOptions options)

Gets a policy binding.

Parameters
Name Description
request GetPolicyBindingRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallPolicyBinding

The call object.

GetPolicyBindingAsync(GetPolicyBindingRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<PolicyBinding> GetPolicyBindingAsync(GetPolicyBindingRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets a policy binding.

Parameters
Name Description
request GetPolicyBindingRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline System.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
AsyncUnaryCallPolicyBinding

The call object.

ListPolicyBindings(ListPolicyBindingsRequest, CallOptions)

public virtual ListPolicyBindingsResponse ListPolicyBindings(ListPolicyBindingsRequest request, CallOptions options)

Lists policy bindings.

Parameters
Name Description
request ListPolicyBindingsRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
ListPolicyBindingsResponse

The response received from the server.

ListPolicyBindings(ListPolicyBindingsRequest, Metadata, DateTime?, CancellationToken)

public virtual ListPolicyBindingsResponse ListPolicyBindings(ListPolicyBindingsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists policy bindings.

Parameters
Name Description
request ListPolicyBindingsRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline System.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
ListPolicyBindingsResponse

The response received from the server.

ListPolicyBindingsAsync(ListPolicyBindingsRequest, CallOptions)

public virtual AsyncUnaryCall<ListPolicyBindingsResponse> ListPolicyBindingsAsync(ListPolicyBindingsRequest request, CallOptions options)

Lists policy bindings.

Parameters
Name Description
request ListPolicyBindingsRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallListPolicyBindingsResponse

The call object.

ListPolicyBindingsAsync(ListPolicyBindingsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListPolicyBindingsResponse> ListPolicyBindingsAsync(ListPolicyBindingsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists policy bindings.

Parameters
Name Description
request ListPolicyBindingsRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline System.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
AsyncUnaryCallListPolicyBindingsResponse

The call object.

NewInstance(ClientBaseConfiguration)

protected override PolicyBindings.PolicyBindingsClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name Description
configuration ClientBaseClientBaseConfiguration
Returns
Type Description
PolicyBindingsPolicyBindingsClient
Overrides
Grpc.Core.ClientBase<Google.Cloud.Iam.V3Beta.PolicyBindings.PolicyBindingsClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)

SearchTargetPolicyBindings(SearchTargetPolicyBindingsRequest, CallOptions)

public virtual SearchTargetPolicyBindingsResponse SearchTargetPolicyBindings(SearchTargetPolicyBindingsRequest request, CallOptions options)

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

Parameters
Name Description
request SearchTargetPolicyBindingsRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
SearchTargetPolicyBindingsResponse

The response received from the server.

SearchTargetPolicyBindings(SearchTargetPolicyBindingsRequest, Metadata, DateTime?, CancellationToken)

public virtual SearchTargetPolicyBindingsResponse SearchTargetPolicyBindings(SearchTargetPolicyBindingsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name Description
request SearchTargetPolicyBindingsRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline System.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
SearchTargetPolicyBindingsResponse

The response received from the server.

SearchTargetPolicyBindingsAsync(SearchTargetPolicyBindingsRequest, CallOptions)

public virtual AsyncUnaryCall<SearchTargetPolicyBindingsResponse> SearchTargetPolicyBindingsAsync(SearchTargetPolicyBindingsRequest request, CallOptions options)

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

Parameters
Name Description
request SearchTargetPolicyBindingsRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallSearchTargetPolicyBindingsResponse

The call object.

SearchTargetPolicyBindingsAsync(SearchTargetPolicyBindingsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<SearchTargetPolicyBindingsResponse> SearchTargetPolicyBindingsAsync(SearchTargetPolicyBindingsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name Description
request SearchTargetPolicyBindingsRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline System.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
AsyncUnaryCallSearchTargetPolicyBindingsResponse

The call object.

UpdatePolicyBinding(UpdatePolicyBindingRequest, CallOptions)

public virtual Operation UpdatePolicyBinding(UpdatePolicyBindingRequest request, CallOptions options)

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 to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
Operation

The response received from the server.

UpdatePolicyBinding(UpdatePolicyBindingRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation UpdatePolicyBinding(UpdatePolicyBindingRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline System.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
Operation

The response received from the server.

UpdatePolicyBindingAsync(UpdatePolicyBindingRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> UpdatePolicyBindingAsync(UpdatePolicyBindingRequest request, CallOptions options)

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 to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallOperation

The call object.

UpdatePolicyBindingAsync(UpdatePolicyBindingRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> UpdatePolicyBindingAsync(UpdatePolicyBindingRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline System.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
AsyncUnaryCallOperation

The call object.