Identity and Access Management (IAM) v3beta API - Class AccessPolicies.AccessPoliciesClient (1.0.0-beta03) 

public class AccessPolicies.AccessPoliciesClient : ClientBase<AccessPolicies.AccessPoliciesClient>

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

Client for AccessPolicies

Inheritance

object > ClientBase > ClientBaseAccessPoliciesAccessPoliciesClient > AccessPolicies.AccessPoliciesClient

Namespace

Google.Cloud.Iam.V3Beta

Assembly

Google.Cloud.Iam.V3Beta.dll

Constructors

AccessPoliciesClient()

protected AccessPoliciesClient()

Protected parameterless constructor to allow creation of test doubles.

AccessPoliciesClient(CallInvoker)

public AccessPoliciesClient(CallInvoker callInvoker)

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

Parameter
Name Description
callInvoker CallInvoker

The callInvoker to use to make remote calls.

AccessPoliciesClient(ChannelBase)

public AccessPoliciesClient(ChannelBase channel)

Creates a new client for AccessPolicies

Parameter
Name Description
channel ChannelBase

The channel to use to make remote calls.

AccessPoliciesClient(ClientBaseConfiguration)

protected AccessPoliciesClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name Description
configuration ClientBaseClientBaseConfiguration

The client configuration.

Methods

CreateAccessPolicy(CreateAccessPolicyRequest, CallOptions)

public virtual Operation CreateAccessPolicy(CreateAccessPolicyRequest request, CallOptions options)

Creates an access policy, and returns a long running operation.

Parameters
Name Description
request CreateAccessPolicyRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
Operation

The response received from the server.

CreateAccessPolicy(CreateAccessPolicyRequest, Metadata, DateTime?, CancellationToken)

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

Creates an access policy, and returns a long running operation.

Parameters
Name Description
request CreateAccessPolicyRequest

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.

CreateAccessPolicyAsync(CreateAccessPolicyRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> CreateAccessPolicyAsync(CreateAccessPolicyRequest request, CallOptions options)

Creates an access policy, and returns a long running operation.

Parameters
Name Description
request CreateAccessPolicyRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallOperation

The call object.

CreateAccessPolicyAsync(CreateAccessPolicyRequest, Metadata, DateTime?, CancellationToken)

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

Creates an access policy, and returns a long running operation.

Parameters
Name Description
request CreateAccessPolicyRequest

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.

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.

DeleteAccessPolicy(DeleteAccessPolicyRequest, CallOptions)

public virtual Operation DeleteAccessPolicy(DeleteAccessPolicyRequest request, CallOptions options)

Deletes an access policy.

Parameters
Name Description
request DeleteAccessPolicyRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
Operation

The response received from the server.

DeleteAccessPolicy(DeleteAccessPolicyRequest, Metadata, DateTime?, CancellationToken)

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

Deletes an access policy.

Parameters
Name Description
request DeleteAccessPolicyRequest

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.

DeleteAccessPolicyAsync(DeleteAccessPolicyRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> DeleteAccessPolicyAsync(DeleteAccessPolicyRequest request, CallOptions options)

Deletes an access policy.

Parameters
Name Description
request DeleteAccessPolicyRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallOperation

The call object.

DeleteAccessPolicyAsync(DeleteAccessPolicyRequest, Metadata, DateTime?, CancellationToken)

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

Deletes an access policy.

Parameters
Name Description
request DeleteAccessPolicyRequest

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.

GetAccessPolicy(GetAccessPolicyRequest, CallOptions)

public virtual AccessPolicy GetAccessPolicy(GetAccessPolicyRequest request, CallOptions options)

Gets an access policy.

Parameters
Name Description
request GetAccessPolicyRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AccessPolicy

The response received from the server.

GetAccessPolicy(GetAccessPolicyRequest, Metadata, DateTime?, CancellationToken)

public virtual AccessPolicy GetAccessPolicy(GetAccessPolicyRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets an access policy.

Parameters
Name Description
request GetAccessPolicyRequest

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
AccessPolicy

The response received from the server.

GetAccessPolicyAsync(GetAccessPolicyRequest, CallOptions)

public virtual AsyncUnaryCall<AccessPolicy> GetAccessPolicyAsync(GetAccessPolicyRequest request, CallOptions options)

Gets an access policy.

Parameters
Name Description
request GetAccessPolicyRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallAccessPolicy

The call object.

GetAccessPolicyAsync(GetAccessPolicyRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<AccessPolicy> GetAccessPolicyAsync(GetAccessPolicyRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets an access policy.

Parameters
Name Description
request GetAccessPolicyRequest

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
AsyncUnaryCallAccessPolicy

The call object.

ListAccessPolicies(ListAccessPoliciesRequest, CallOptions)

public virtual ListAccessPoliciesResponse ListAccessPolicies(ListAccessPoliciesRequest request, CallOptions options)

Lists access policies.

Parameters
Name Description
request ListAccessPoliciesRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
ListAccessPoliciesResponse

The response received from the server.

ListAccessPolicies(ListAccessPoliciesRequest, Metadata, DateTime?, CancellationToken)

public virtual ListAccessPoliciesResponse ListAccessPolicies(ListAccessPoliciesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists access policies.

Parameters
Name Description
request ListAccessPoliciesRequest

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
ListAccessPoliciesResponse

The response received from the server.

ListAccessPoliciesAsync(ListAccessPoliciesRequest, CallOptions)

public virtual AsyncUnaryCall<ListAccessPoliciesResponse> ListAccessPoliciesAsync(ListAccessPoliciesRequest request, CallOptions options)

Lists access policies.

Parameters
Name Description
request ListAccessPoliciesRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallListAccessPoliciesResponse

The call object.

ListAccessPoliciesAsync(ListAccessPoliciesRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListAccessPoliciesResponse> ListAccessPoliciesAsync(ListAccessPoliciesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists access policies.

Parameters
Name Description
request ListAccessPoliciesRequest

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
AsyncUnaryCallListAccessPoliciesResponse

The call object.

NewInstance(ClientBaseConfiguration)

protected override AccessPolicies.AccessPoliciesClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name Description
configuration ClientBaseClientBaseConfiguration
Returns
Type Description
AccessPoliciesAccessPoliciesClient
Overrides
Grpc.Core.ClientBase<Google.Cloud.Iam.V3Beta.AccessPolicies.AccessPoliciesClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)

SearchAccessPolicyBindings(SearchAccessPolicyBindingsRequest, CallOptions)

public virtual SearchAccessPolicyBindingsResponse SearchAccessPolicyBindings(SearchAccessPolicyBindingsRequest request, CallOptions options)

Returns all policy bindings that bind a specific policy if a user has searchPolicyBindings permission on that policy.

Parameters
Name Description
request SearchAccessPolicyBindingsRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
SearchAccessPolicyBindingsResponse

The response received from the server.

SearchAccessPolicyBindings(SearchAccessPolicyBindingsRequest, Metadata, DateTime?, CancellationToken)

public virtual SearchAccessPolicyBindingsResponse SearchAccessPolicyBindings(SearchAccessPolicyBindingsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Returns all policy bindings that bind a specific policy if a user has searchPolicyBindings permission on that policy.

Parameters
Name Description
request SearchAccessPolicyBindingsRequest

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
SearchAccessPolicyBindingsResponse

The response received from the server.

SearchAccessPolicyBindingsAsync(SearchAccessPolicyBindingsRequest, CallOptions)

public virtual AsyncUnaryCall<SearchAccessPolicyBindingsResponse> SearchAccessPolicyBindingsAsync(SearchAccessPolicyBindingsRequest request, CallOptions options)

Returns all policy bindings that bind a specific policy if a user has searchPolicyBindings permission on that policy.

Parameters
Name Description
request SearchAccessPolicyBindingsRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallSearchAccessPolicyBindingsResponse

The call object.

SearchAccessPolicyBindingsAsync(SearchAccessPolicyBindingsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<SearchAccessPolicyBindingsResponse> SearchAccessPolicyBindingsAsync(SearchAccessPolicyBindingsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Returns all policy bindings that bind a specific policy if a user has searchPolicyBindings permission on that policy.

Parameters
Name Description
request SearchAccessPolicyBindingsRequest

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
AsyncUnaryCallSearchAccessPolicyBindingsResponse

The call object.

UpdateAccessPolicy(UpdateAccessPolicyRequest, CallOptions)

public virtual Operation UpdateAccessPolicy(UpdateAccessPolicyRequest request, CallOptions options)

Updates an access policy.

Parameters
Name Description
request UpdateAccessPolicyRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
Operation

The response received from the server.

UpdateAccessPolicy(UpdateAccessPolicyRequest, Metadata, DateTime?, CancellationToken)

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

Updates an access policy.

Parameters
Name Description
request UpdateAccessPolicyRequest

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.

UpdateAccessPolicyAsync(UpdateAccessPolicyRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> UpdateAccessPolicyAsync(UpdateAccessPolicyRequest request, CallOptions options)

Updates an access policy.

Parameters
Name Description
request UpdateAccessPolicyRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallOperation

The call object.

UpdateAccessPolicyAsync(UpdateAccessPolicyRequest, Metadata, DateTime?, CancellationToken)

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

Updates an access policy.

Parameters
Name Description
request UpdateAccessPolicyRequest

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.