Identity and Access Management (IAM) v3beta API - Class PrincipalAccessBoundaryPolicies.PrincipalAccessBoundaryPoliciesClient (1.0.0-beta01)

public class PrincipalAccessBoundaryPolicies.PrincipalAccessBoundaryPoliciesClient : ClientBase<PrincipalAccessBoundaryPolicies.PrincipalAccessBoundaryPoliciesClient>

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

Client for PrincipalAccessBoundaryPolicies

Inheritance

object > ClientBase > ClientBasePrincipalAccessBoundaryPoliciesPrincipalAccessBoundaryPoliciesClient > PrincipalAccessBoundaryPolicies.PrincipalAccessBoundaryPoliciesClient

Namespace

Google.Cloud.Iam.V3Beta

Assembly

Google.Cloud.Iam.V3Beta.dll

Constructors

PrincipalAccessBoundaryPoliciesClient()

protected PrincipalAccessBoundaryPoliciesClient()

Protected parameterless constructor to allow creation of test doubles.

PrincipalAccessBoundaryPoliciesClient(CallInvoker)

public PrincipalAccessBoundaryPoliciesClient(CallInvoker callInvoker)

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

Parameter
Name Description
callInvoker CallInvoker

The callInvoker to use to make remote calls.

PrincipalAccessBoundaryPoliciesClient(ChannelBase)

public PrincipalAccessBoundaryPoliciesClient(ChannelBase channel)

Creates a new client for PrincipalAccessBoundaryPolicies

Parameter
Name Description
channel ChannelBase

The channel to use to make remote calls.

PrincipalAccessBoundaryPoliciesClient(ClientBaseConfiguration)

protected PrincipalAccessBoundaryPoliciesClient(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.

CreatePrincipalAccessBoundaryPolicy(CreatePrincipalAccessBoundaryPolicyRequest, CallOptions)

public virtual Operation CreatePrincipalAccessBoundaryPolicy(CreatePrincipalAccessBoundaryPolicyRequest request, CallOptions options)

Creates a principal access boundary policy, and returns a long running operation.

Parameters
Name Description
request CreatePrincipalAccessBoundaryPolicyRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Operation

The response received from the server.

CreatePrincipalAccessBoundaryPolicy(CreatePrincipalAccessBoundaryPolicyRequest, Metadata, DateTime?, CancellationToken)

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

Creates a principal access boundary policy, and returns a long running operation.

Parameters
Name Description
request CreatePrincipalAccessBoundaryPolicyRequest

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.

CreatePrincipalAccessBoundaryPolicyAsync(CreatePrincipalAccessBoundaryPolicyRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> CreatePrincipalAccessBoundaryPolicyAsync(CreatePrincipalAccessBoundaryPolicyRequest request, CallOptions options)

Creates a principal access boundary policy, and returns a long running operation.

Parameters
Name Description
request CreatePrincipalAccessBoundaryPolicyRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

CreatePrincipalAccessBoundaryPolicyAsync(CreatePrincipalAccessBoundaryPolicyRequest, Metadata, DateTime?, CancellationToken)

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

Creates a principal access boundary policy, and returns a long running operation.

Parameters
Name Description
request CreatePrincipalAccessBoundaryPolicyRequest

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.

DeletePrincipalAccessBoundaryPolicy(DeletePrincipalAccessBoundaryPolicyRequest, CallOptions)

public virtual Operation DeletePrincipalAccessBoundaryPolicy(DeletePrincipalAccessBoundaryPolicyRequest request, CallOptions options)

Deletes a principal access boundary policy.

Parameters
Name Description
request DeletePrincipalAccessBoundaryPolicyRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Operation

The response received from the server.

DeletePrincipalAccessBoundaryPolicy(DeletePrincipalAccessBoundaryPolicyRequest, Metadata, DateTime?, CancellationToken)

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

Deletes a principal access boundary policy.

Parameters
Name Description
request DeletePrincipalAccessBoundaryPolicyRequest

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.

DeletePrincipalAccessBoundaryPolicyAsync(DeletePrincipalAccessBoundaryPolicyRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> DeletePrincipalAccessBoundaryPolicyAsync(DeletePrincipalAccessBoundaryPolicyRequest request, CallOptions options)

Deletes a principal access boundary policy.

Parameters
Name Description
request DeletePrincipalAccessBoundaryPolicyRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

DeletePrincipalAccessBoundaryPolicyAsync(DeletePrincipalAccessBoundaryPolicyRequest, Metadata, DateTime?, CancellationToken)

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

Deletes a principal access boundary policy.

Parameters
Name Description
request DeletePrincipalAccessBoundaryPolicyRequest

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.

GetPrincipalAccessBoundaryPolicy(GetPrincipalAccessBoundaryPolicyRequest, CallOptions)

public virtual PrincipalAccessBoundaryPolicy GetPrincipalAccessBoundaryPolicy(GetPrincipalAccessBoundaryPolicyRequest request, CallOptions options)

Gets a principal access boundary policy.

Parameters
Name Description
request GetPrincipalAccessBoundaryPolicyRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
PrincipalAccessBoundaryPolicy

The response received from the server.

GetPrincipalAccessBoundaryPolicy(GetPrincipalAccessBoundaryPolicyRequest, Metadata, DateTime?, CancellationToken)

public virtual PrincipalAccessBoundaryPolicy GetPrincipalAccessBoundaryPolicy(GetPrincipalAccessBoundaryPolicyRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets a principal access boundary policy.

Parameters
Name Description
request GetPrincipalAccessBoundaryPolicyRequest

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
PrincipalAccessBoundaryPolicy

The response received from the server.

GetPrincipalAccessBoundaryPolicyAsync(GetPrincipalAccessBoundaryPolicyRequest, CallOptions)

public virtual AsyncUnaryCall<PrincipalAccessBoundaryPolicy> GetPrincipalAccessBoundaryPolicyAsync(GetPrincipalAccessBoundaryPolicyRequest request, CallOptions options)

Gets a principal access boundary policy.

Parameters
Name Description
request GetPrincipalAccessBoundaryPolicyRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallPrincipalAccessBoundaryPolicy

The call object.

GetPrincipalAccessBoundaryPolicyAsync(GetPrincipalAccessBoundaryPolicyRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<PrincipalAccessBoundaryPolicy> GetPrincipalAccessBoundaryPolicyAsync(GetPrincipalAccessBoundaryPolicyRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets a principal access boundary policy.

Parameters
Name Description
request GetPrincipalAccessBoundaryPolicyRequest

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
AsyncUnaryCallPrincipalAccessBoundaryPolicy

The call object.

ListPrincipalAccessBoundaryPolicies(ListPrincipalAccessBoundaryPoliciesRequest, CallOptions)

public virtual ListPrincipalAccessBoundaryPoliciesResponse ListPrincipalAccessBoundaryPolicies(ListPrincipalAccessBoundaryPoliciesRequest request, CallOptions options)

Lists principal access boundary policies.

Parameters
Name Description
request ListPrincipalAccessBoundaryPoliciesRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
ListPrincipalAccessBoundaryPoliciesResponse

The response received from the server.

ListPrincipalAccessBoundaryPolicies(ListPrincipalAccessBoundaryPoliciesRequest, Metadata, DateTime?, CancellationToken)

public virtual ListPrincipalAccessBoundaryPoliciesResponse ListPrincipalAccessBoundaryPolicies(ListPrincipalAccessBoundaryPoliciesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists principal access boundary policies.

Parameters
Name Description
request ListPrincipalAccessBoundaryPoliciesRequest

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
ListPrincipalAccessBoundaryPoliciesResponse

The response received from the server.

ListPrincipalAccessBoundaryPoliciesAsync(ListPrincipalAccessBoundaryPoliciesRequest, CallOptions)

public virtual AsyncUnaryCall<ListPrincipalAccessBoundaryPoliciesResponse> ListPrincipalAccessBoundaryPoliciesAsync(ListPrincipalAccessBoundaryPoliciesRequest request, CallOptions options)

Lists principal access boundary policies.

Parameters
Name Description
request ListPrincipalAccessBoundaryPoliciesRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallListPrincipalAccessBoundaryPoliciesResponse

The call object.

ListPrincipalAccessBoundaryPoliciesAsync(ListPrincipalAccessBoundaryPoliciesRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListPrincipalAccessBoundaryPoliciesResponse> ListPrincipalAccessBoundaryPoliciesAsync(ListPrincipalAccessBoundaryPoliciesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists principal access boundary policies.

Parameters
Name Description
request ListPrincipalAccessBoundaryPoliciesRequest

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
AsyncUnaryCallListPrincipalAccessBoundaryPoliciesResponse

The call object.

NewInstance(ClientBaseConfiguration)

protected override PrincipalAccessBoundaryPolicies.PrincipalAccessBoundaryPoliciesClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name Description
configuration ClientBaseClientBaseConfiguration
Returns
Type Description
PrincipalAccessBoundaryPoliciesPrincipalAccessBoundaryPoliciesClient
Overrides
Grpc.Core.ClientBase<Google.Cloud.Iam.V3Beta.PrincipalAccessBoundaryPolicies.PrincipalAccessBoundaryPoliciesClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)

SearchPrincipalAccessBoundaryPolicyBindings(SearchPrincipalAccessBoundaryPolicyBindingsRequest, CallOptions)

public virtual SearchPrincipalAccessBoundaryPolicyBindingsResponse SearchPrincipalAccessBoundaryPolicyBindings(SearchPrincipalAccessBoundaryPolicyBindingsRequest 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 SearchPrincipalAccessBoundaryPolicyBindingsRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
SearchPrincipalAccessBoundaryPolicyBindingsResponse

The response received from the server.

SearchPrincipalAccessBoundaryPolicyBindings(SearchPrincipalAccessBoundaryPolicyBindingsRequest, Metadata, DateTime?, CancellationToken)

public virtual SearchPrincipalAccessBoundaryPolicyBindingsResponse SearchPrincipalAccessBoundaryPolicyBindings(SearchPrincipalAccessBoundaryPolicyBindingsRequest 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 SearchPrincipalAccessBoundaryPolicyBindingsRequest

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
SearchPrincipalAccessBoundaryPolicyBindingsResponse

The response received from the server.

SearchPrincipalAccessBoundaryPolicyBindingsAsync(SearchPrincipalAccessBoundaryPolicyBindingsRequest, CallOptions)

public virtual AsyncUnaryCall<SearchPrincipalAccessBoundaryPolicyBindingsResponse> SearchPrincipalAccessBoundaryPolicyBindingsAsync(SearchPrincipalAccessBoundaryPolicyBindingsRequest 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 SearchPrincipalAccessBoundaryPolicyBindingsRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallSearchPrincipalAccessBoundaryPolicyBindingsResponse

The call object.

SearchPrincipalAccessBoundaryPolicyBindingsAsync(SearchPrincipalAccessBoundaryPolicyBindingsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<SearchPrincipalAccessBoundaryPolicyBindingsResponse> SearchPrincipalAccessBoundaryPolicyBindingsAsync(SearchPrincipalAccessBoundaryPolicyBindingsRequest 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 SearchPrincipalAccessBoundaryPolicyBindingsRequest

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
AsyncUnaryCallSearchPrincipalAccessBoundaryPolicyBindingsResponse

The call object.

UpdatePrincipalAccessBoundaryPolicy(UpdatePrincipalAccessBoundaryPolicyRequest, CallOptions)

public virtual Operation UpdatePrincipalAccessBoundaryPolicy(UpdatePrincipalAccessBoundaryPolicyRequest request, CallOptions options)

Updates a principal access boundary policy.

Parameters
Name Description
request UpdatePrincipalAccessBoundaryPolicyRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Operation

The response received from the server.

UpdatePrincipalAccessBoundaryPolicy(UpdatePrincipalAccessBoundaryPolicyRequest, Metadata, DateTime?, CancellationToken)

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

Updates a principal access boundary policy.

Parameters
Name Description
request UpdatePrincipalAccessBoundaryPolicyRequest

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.

UpdatePrincipalAccessBoundaryPolicyAsync(UpdatePrincipalAccessBoundaryPolicyRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> UpdatePrincipalAccessBoundaryPolicyAsync(UpdatePrincipalAccessBoundaryPolicyRequest request, CallOptions options)

Updates a principal access boundary policy.

Parameters
Name Description
request UpdatePrincipalAccessBoundaryPolicyRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

UpdatePrincipalAccessBoundaryPolicyAsync(UpdatePrincipalAccessBoundaryPolicyRequest, Metadata, DateTime?, CancellationToken)

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

Updates a principal access boundary policy.

Parameters
Name Description
request UpdatePrincipalAccessBoundaryPolicyRequest

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.