Class IAMPolicyClientImpl (3.0.0)

public sealed class IAMPolicyClientImpl : IAMPolicyClient

IAMPolicy client wrapper implementation, for convenient use.

Inheritance

Object > IAMPolicyClient > IAMPolicyClientImpl

Inherited Members

IAMPolicyClient.DefaultEndpoint

IAMPolicyClient.DefaultScopes

IAMPolicyClient.ServiceMetadata

IAMPolicyClient.CreateAsync(CancellationToken)

IAMPolicyClient.Create()

IAMPolicyClient.ShutdownDefaultChannelsAsync()

IAMPolicyClient.SetIamPolicyAsync(SetIamPolicyRequest, CancellationToken)

IAMPolicyClient.GetIamPolicyAsync(GetIamPolicyRequest, CancellationToken)

IAMPolicyClient.TestIamPermissionsAsync(TestIamPermissionsRequest, CancellationToken)

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ToString()

Namespace

Google.Cloud.Iam.V1

Assembly

Google.Cloud.Iam.V1.dll

Remarks

API Overview

Manages Identity and Access Management (IAM) policies.

Any implementation of an API that offers access control features implements the google.iam.v1.IAMPolicy interface.

Data model

Access control is applied when a principal (user or service account), takes some action on a resource exposed by a service. Resources, identified by URI-like names, are the unit of access control specification. Service implementations can choose the granularity of access control and the supported permissions for their resources. For example one database service may allow access control to be specified only at the Table level, whereas another might allow access control to also be specified at the Column level.

Policy Structure

See google.iam.v1.Policy

This is intentionally not a CRUD style API because access control policies are created and deleted implicitly with the resources to which they are attached.

Constructors

IAMPolicyClientImpl(IAMPolicy.IAMPolicyClient, IAMPolicySettings, ILogger)

public IAMPolicyClientImpl(IAMPolicy.IAMPolicyClient grpcClient, IAMPolicySettings settings, ILogger logger)

Constructs a client wrapper for the IAMPolicy service, with the specified gRPC client and settings.

Parameters
Name	Description
`grpcClient`	`IAMPolicy.IAMPolicyClient` The underlying gRPC client.
`settings`	`IAMPolicySettings` The base IAMPolicySettings used within this client.
`logger`	`ILogger` Optional ILogger to use within this client.

Properties

GrpcClient

public override IAMPolicy.IAMPolicyClient GrpcClient { get; }

The underlying gRPC IAMPolicy client

Property Value
Type	Description
`IAMPolicy.IAMPolicyClient`

Overrides

IAMPolicyClient.GrpcClient

Methods

GetIamPolicy(GetIamPolicyRequest, CallSettings)

public override Policy GetIamPolicy(GetIamPolicyRequest request, CallSettings callSettings = 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 object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Policy`	The RPC response.

Overrides

IAMPolicyClient.GetIamPolicy(GetIamPolicyRequest, CallSettings)

GetIamPolicyAsync(GetIamPolicyRequest, CallSettings)

public override Task<Policy> GetIamPolicyAsync(GetIamPolicyRequest request, CallSettings callSettings = 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 object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Task<Policy>`	A Task containing the RPC response.

Overrides

IAMPolicyClient.GetIamPolicyAsync(GetIamPolicyRequest, CallSettings)

SetIamPolicy(SetIamPolicyRequest, CallSettings)

public override Policy SetIamPolicy(SetIamPolicyRequest request, CallSettings callSettings = 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 object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Policy`	The RPC response.

Overrides

IAMPolicyClient.SetIamPolicy(SetIamPolicyRequest, CallSettings)

SetIamPolicyAsync(SetIamPolicyRequest, CallSettings)

public override Task<Policy> SetIamPolicyAsync(SetIamPolicyRequest request, CallSettings callSettings = 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 object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Task<Policy>`	A Task containing the RPC response.

Overrides

IAMPolicyClient.SetIamPolicyAsync(SetIamPolicyRequest, CallSettings)

TestIamPermissions(TestIamPermissionsRequest, CallSettings)

public override TestIamPermissionsResponse TestIamPermissions(TestIamPermissionsRequest request, CallSettings callSettings = 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 object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`TestIamPermissionsResponse`	The RPC response.

Overrides

IAMPolicyClient.TestIamPermissions(TestIamPermissionsRequest, CallSettings)

TestIamPermissionsAsync(TestIamPermissionsRequest, CallSettings)

public override Task<TestIamPermissionsResponse> TestIamPermissionsAsync(TestIamPermissionsRequest request, CallSettings callSettings = 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 object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Task<TestIamPermissionsResponse>`	A Task containing the RPC response.

Overrides

IAMPolicyClient.TestIamPermissionsAsync(TestIamPermissionsRequest, CallSettings)