Class IAMPolicy.IAMPolicyClient

Client for IAMPolicy

Inheritance

System.Object

ClientBase

ClientBase<IAMPolicy.IAMPolicyClient>

IAMPolicy.IAMPolicyClient

Inherited Members

ClientBase<IAMPolicy.IAMPolicyClient>.WithHost(String)

ClientBase.CallInvoker

System.Object.ToString()

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: Google.Cloud.Iam.V1

Assembly: Google.Cloud.Iam.V1.dll

Syntax

public class IAMPolicyClient : ClientBase<IAMPolicy.IAMPolicyClient>

Constructors

IAMPolicyClient()

Protected parameterless constructor to allow creation of test doubles.

Declaration

protected IAMPolicyClient()

IAMPolicyClient(CallInvoker)

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

Declaration

public IAMPolicyClient(CallInvoker callInvoker)

Parameters

Type	Name	Description
CallInvoker	callInvoker	The callInvoker to use to make remote calls.

IAMPolicyClient(Channel)

Creates a new client for IAMPolicy

Declaration

public IAMPolicyClient(Channel channel)

Parameters

Type	Name	Description
Channel	channel	The channel to use to make remote calls.

IAMPolicyClient(ClientBase.ClientBaseConfiguration)

Protected constructor to allow creation of configured clients.

Declaration

protected IAMPolicyClient(ClientBase.ClientBaseConfiguration configuration)

Parameters

Type	Name	Description
ClientBase.ClientBaseConfiguration	configuration	The client configuration.

Methods

GetIamPolicy(GetIamPolicyRequest, CallOptions)

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

Declaration

public virtual Policy GetIamPolicy(GetIamPolicyRequest request, CallOptions options)

Parameters

Type	Name	Description
GetIamPolicyRequest	request	The request to send to the server.
CallOptions	options	The options for the call.

Returns

Type	Description
Policy	The response received from the server.

GetIamPolicy(GetIamPolicyRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Declaration

public virtual Policy GetIamPolicy(GetIamPolicyRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Parameters

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

Returns

Type	Description
Policy	The response received from the server.

GetIamPolicyAsync(GetIamPolicyRequest, CallOptions)

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

Declaration

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

Parameters

Type	Name	Description
GetIamPolicyRequest	request	The request to send to the server.
CallOptions	options	The options for the call.

Returns

Type	Description
AsyncUnaryCall<Policy>	The call object.

GetIamPolicyAsync(GetIamPolicyRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Declaration

public virtual AsyncUnaryCall<Policy> GetIamPolicyAsync(GetIamPolicyRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Parameters

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

Returns

Type	Description
AsyncUnaryCall<Policy>	The call object.

NewInstance(ClientBase.ClientBaseConfiguration)

Creates a new instance of client from given ClientBaseConfiguration.

Declaration

protected override IAMPolicy.IAMPolicyClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Parameters

Type	Name	Description
ClientBase.ClientBaseConfiguration	configuration

Returns

Type	Description
IAMPolicy.IAMPolicyClient

Overrides

Grpc.Core.ClientBase<Google.Cloud.Iam.V1.IAMPolicy.IAMPolicyClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)

SetIamPolicy(SetIamPolicyRequest, CallOptions)

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

Declaration

public virtual Policy SetIamPolicy(SetIamPolicyRequest request, CallOptions options)

Parameters

Type	Name	Description
SetIamPolicyRequest	request	The request to send to the server.
CallOptions	options	The options for the call.

Returns

Type	Description
Policy	The response received from the server.

SetIamPolicy(SetIamPolicyRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Declaration

public virtual Policy SetIamPolicy(SetIamPolicyRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Parameters

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

Returns

Type	Description
Policy	The response received from the server.

SetIamPolicyAsync(SetIamPolicyRequest, CallOptions)

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

Declaration

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

Parameters

Type	Name	Description
SetIamPolicyRequest	request	The request to send to the server.
CallOptions	options	The options for the call.

Returns

Type	Description
AsyncUnaryCall<Policy>	The call object.

SetIamPolicyAsync(SetIamPolicyRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Declaration

public virtual AsyncUnaryCall<Policy> SetIamPolicyAsync(SetIamPolicyRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Parameters

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

Returns

Type	Description
AsyncUnaryCall<Policy>	The call object.

TestIamPermissions(TestIamPermissionsRequest, CallOptions)

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.

Declaration

public virtual TestIamPermissionsResponse TestIamPermissions(TestIamPermissionsRequest request, CallOptions options)

Parameters

Type	Name	Description
TestIamPermissionsRequest	request	The request to send to the server.
CallOptions	options	The options for the call.

Returns

Type	Description
TestIamPermissionsResponse	The response received from the server.

TestIamPermissions(TestIamPermissionsRequest, Metadata, Nullable<DateTime>, CancellationToken)

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.

Declaration

public virtual TestIamPermissionsResponse TestIamPermissions(TestIamPermissionsRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Parameters

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

Returns

Type	Description
TestIamPermissionsResponse	The response received from the server.

TestIamPermissionsAsync(TestIamPermissionsRequest, CallOptions)

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.

Declaration

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

Parameters

Type	Name	Description
TestIamPermissionsRequest	request	The request to send to the server.
CallOptions	options	The options for the call.

Returns

Type	Description
AsyncUnaryCall<TestIamPermissionsResponse>	The call object.

TestIamPermissionsAsync(TestIamPermissionsRequest, Metadata, Nullable<DateTime>, CancellationToken)

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.

Declaration

public virtual AsyncUnaryCall<TestIamPermissionsResponse> TestIamPermissionsAsync(TestIamPermissionsRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Parameters

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

Returns

Type	Description
AsyncUnaryCall<TestIamPermissionsResponse>	The call object.