Some or all of the information on this page might not apply to Cloud de Confiance by S3NS. See Differences from Google Cloud for more details.

Class IAMPolicy.IAMPolicyClient (2.4.0)

public class IAMPolicyClient : Grpc.Core.ClientBase<IAMPolicy.IAMPolicyClient>

Client for IAMPolicy

Inheritance

Object > IAMPolicy.IAMPolicyClient

Namespace

Google.Cloud.Iam.V1

Assembly

Google.Cloud.Iam.V1.dll

Constructors

IAMPolicyClient()

protected IAMPolicyClient()

Protected parameterless constructor to allow creation of test doubles.

IAMPolicyClient(Channel)

public IAMPolicyClient(Channel channel)

Creates a new client using a channel.

Parameter
Name	Description
`channel`	`Channel` The channel to use to make remote calls.

IAMPolicyClient(ClientBaseConfiguration)

protected IAMPolicyClient(ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name	Description
`configuration`	`ClientBaseConfiguration` The client configuration.

IAMPolicyClient(Grpc.Core.CallInvoker)

public IAMPolicyClient(Grpc.Core.CallInvoker callInvoker)

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

Parameter
Name	Description
`callInvoker`	`Grpc.Core.CallInvoker` The callInvoker to use to make remote calls.

IAMPolicyClient(Grpc.Core.ChannelBase)

public IAMPolicyClient(Grpc.Core.ChannelBase channel)

Creates a new client for IAMPolicy

Parameter
Name	Description
`channel`	`Grpc.Core.ChannelBase` The channel to use to make remote calls.

Methods

GetIamPolicy(GetIamPolicyRequest, Grpc.Core.CallOptions)

public virtual Policy GetIamPolicy(GetIamPolicyRequest request, Grpc.Core.CallOptions options)

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

Parameters
Name	Description
`request`	`GetIamPolicyRequest` The request to send to the server.
`options`	`Grpc.Core.CallOptions` The options for the call.

Returns
Type	Description
`Policy`	The response received from the server.

GetIamPolicy(GetIamPolicyRequest, Grpc.Core.Metadata, Nullable<System.DateTime>, System.Threading.CancellationToken)

public virtual Policy GetIamPolicy(GetIamPolicyRequest request, Grpc.Core.Metadata headers = null, System.DateTime? deadline = null, System.Threading.CancellationToken cancellationToken = null)

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

Parameters
Name	Description
`request`	`GetIamPolicyRequest` The request to send to the server.
`headers`	`Grpc.Core.Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`Nullable<System.DateTime>` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`System.Threading.CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`Policy`	The response received from the server.

GetIamPolicyAsync(GetIamPolicyRequest, Grpc.Core.CallOptions)

public virtual Grpc.Core.AsyncUnaryCall<Policy> GetIamPolicyAsync(GetIamPolicyRequest request, Grpc.Core.CallOptions options)

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

Parameters
Name	Description
`request`	`GetIamPolicyRequest` The request to send to the server.
`options`	`Grpc.Core.CallOptions` The options for the call.

Returns
Type	Description
`Grpc.Core.AsyncUnaryCall<Policy>`	The call object.

GetIamPolicyAsync(GetIamPolicyRequest, Grpc.Core.Metadata, Nullable<System.DateTime>, System.Threading.CancellationToken)

public virtual Grpc.Core.AsyncUnaryCall<Policy> GetIamPolicyAsync(GetIamPolicyRequest request, Grpc.Core.Metadata headers = null, System.DateTime? deadline = null, System.Threading.CancellationToken cancellationToken = null)

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

Parameters
Name	Description
`request`	`GetIamPolicyRequest` The request to send to the server.
`headers`	`Grpc.Core.Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`Nullable<System.DateTime>` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`System.Threading.CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`Grpc.Core.AsyncUnaryCall<Policy>`	The call object.

NewInstance(ClientBaseConfiguration)

protected override IAMPolicy.IAMPolicyClient NewInstance(ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name	Description
`configuration`	`ClientBaseConfiguration`

Returns
Type	Description
`IAMPolicy.IAMPolicyClient`

SetIamPolicy(SetIamPolicyRequest, Grpc.Core.CallOptions)

public virtual Policy SetIamPolicy(SetIamPolicyRequest request, Grpc.Core.CallOptions options)

Sets the access control policy on the specified resource. Replaces any existing policy.

Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

Parameters
Name	Description
`request`	`SetIamPolicyRequest` The request to send to the server.
`options`	`Grpc.Core.CallOptions` The options for the call.

Returns
Type	Description
`Policy`	The response received from the server.

SetIamPolicy(SetIamPolicyRequest, Grpc.Core.Metadata, Nullable<System.DateTime>, System.Threading.CancellationToken)

public virtual Policy SetIamPolicy(SetIamPolicyRequest request, Grpc.Core.Metadata headers = null, System.DateTime? deadline = null, System.Threading.CancellationToken cancellationToken = null)

Sets the access control policy on the specified resource. Replaces any existing policy.

Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

Parameters
Name	Description
`request`	`SetIamPolicyRequest` The request to send to the server.
`headers`	`Grpc.Core.Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`Nullable<System.DateTime>` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`System.Threading.CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`Policy`	The response received from the server.

SetIamPolicyAsync(SetIamPolicyRequest, Grpc.Core.CallOptions)

public virtual Grpc.Core.AsyncUnaryCall<Policy> SetIamPolicyAsync(SetIamPolicyRequest request, Grpc.Core.CallOptions options)

Sets the access control policy on the specified resource. Replaces any existing policy.

Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

Parameters
Name	Description
`request`	`SetIamPolicyRequest` The request to send to the server.
`options`	`Grpc.Core.CallOptions` The options for the call.

Returns
Type	Description
`Grpc.Core.AsyncUnaryCall<Policy>`	The call object.

SetIamPolicyAsync(SetIamPolicyRequest, Grpc.Core.Metadata, Nullable<System.DateTime>, System.Threading.CancellationToken)

public virtual Grpc.Core.AsyncUnaryCall<Policy> SetIamPolicyAsync(SetIamPolicyRequest request, Grpc.Core.Metadata headers = null, System.DateTime? deadline = null, System.Threading.CancellationToken cancellationToken = null)

Sets the access control policy on the specified resource. Replaces any existing policy.

Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

Parameters
Name	Description
`request`	`SetIamPolicyRequest` The request to send to the server.
`headers`	`Grpc.Core.Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`Nullable<System.DateTime>` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`System.Threading.CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`Grpc.Core.AsyncUnaryCall<Policy>`	The call object.

TestIamPermissions(TestIamPermissionsRequest, Grpc.Core.CallOptions)

public virtual TestIamPermissionsResponse TestIamPermissions(TestIamPermissionsRequest request, Grpc.Core.CallOptions options)

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.

Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

Parameters
Name	Description
`request`	`TestIamPermissionsRequest` The request to send to the server.
`options`	`Grpc.Core.CallOptions` The options for the call.

Returns
Type	Description
`TestIamPermissionsResponse`	The response received from the server.

TestIamPermissions(TestIamPermissionsRequest, Grpc.Core.Metadata, Nullable<System.DateTime>, System.Threading.CancellationToken)

public virtual TestIamPermissionsResponse TestIamPermissions(TestIamPermissionsRequest request, Grpc.Core.Metadata headers = null, System.DateTime? deadline = null, System.Threading.CancellationToken cancellationToken = null)

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.

Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

Parameters
Name	Description
`request`	`TestIamPermissionsRequest` The request to send to the server.
`headers`	`Grpc.Core.Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`Nullable<System.DateTime>` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`System.Threading.CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`TestIamPermissionsResponse`	The response received from the server.

TestIamPermissionsAsync(TestIamPermissionsRequest, Grpc.Core.CallOptions)

public virtual Grpc.Core.AsyncUnaryCall<TestIamPermissionsResponse> TestIamPermissionsAsync(TestIamPermissionsRequest request, Grpc.Core.CallOptions options)

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.

Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

Parameters
Name	Description
`request`	`TestIamPermissionsRequest` The request to send to the server.
`options`	`Grpc.Core.CallOptions` The options for the call.

Returns
Type	Description
`Grpc.Core.AsyncUnaryCall<TestIamPermissionsResponse>`	The call object.

TestIamPermissionsAsync(TestIamPermissionsRequest, Grpc.Core.Metadata, Nullable<System.DateTime>, System.Threading.CancellationToken)

public virtual Grpc.Core.AsyncUnaryCall<TestIamPermissionsResponse> TestIamPermissionsAsync(TestIamPermissionsRequest request, Grpc.Core.Metadata headers = null, System.DateTime? deadline = null, System.Threading.CancellationToken cancellationToken = null)

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.

Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

Parameters
Name	Description
`request`	`TestIamPermissionsRequest` The request to send to the server.
`headers`	`Grpc.Core.Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`Nullable<System.DateTime>` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`System.Threading.CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`Grpc.Core.AsyncUnaryCall<TestIamPermissionsResponse>`	The call object.