Google Cloud Identity and Access Management (IAM) v2 API - Class PoliciesClientImpl (1.1.0)

public sealed class PoliciesClientImpl : PoliciesClient

Reference documentation and code samples for the Google Cloud Identity and Access Management (IAM) v2 API class PoliciesClientImpl.

Policies client wrapper implementation, for convenient use.

Inheritance

object > PoliciesClient > PoliciesClientImpl

Inherited Members

PoliciesClient.DefaultEndpoint

PoliciesClient.DefaultScopes

PoliciesClient.ServiceMetadata

PoliciesClient.CreateAsync(CancellationToken)

PoliciesClient.Create()

PoliciesClient.ShutdownDefaultChannelsAsync()

PoliciesClient.ListPolicies(string, string, int?, CallSettings)

PoliciesClient.ListPoliciesAsync(string, string, int?, CallSettings)

PoliciesClient.GetPolicyAsync(GetPolicyRequest, CancellationToken)

PoliciesClient.GetPolicy(string, CallSettings)

PoliciesClient.GetPolicyAsync(string, CallSettings)

PoliciesClient.GetPolicyAsync(string, CancellationToken)

PoliciesClient.CreatePolicyAsync(CreatePolicyRequest, CancellationToken)

PoliciesClient.PollOnceCreatePolicy(string, CallSettings)

PoliciesClient.PollOnceCreatePolicyAsync(string, CallSettings)

PoliciesClient.CreatePolicy(string, Policy, string, CallSettings)

PoliciesClient.CreatePolicyAsync(string, Policy, string, CallSettings)

PoliciesClient.CreatePolicyAsync(string, Policy, string, CancellationToken)

PoliciesClient.UpdatePolicyAsync(UpdatePolicyRequest, CancellationToken)

PoliciesClient.PollOnceUpdatePolicy(string, CallSettings)

PoliciesClient.PollOnceUpdatePolicyAsync(string, CallSettings)

PoliciesClient.DeletePolicyAsync(DeletePolicyRequest, CancellationToken)

PoliciesClient.PollOnceDeletePolicy(string, CallSettings)

PoliciesClient.PollOnceDeletePolicyAsync(string, CallSettings)

PoliciesClient.DeletePolicy(string, CallSettings)

PoliciesClient.DeletePolicyAsync(string, CallSettings)

PoliciesClient.DeletePolicyAsync(string, CancellationToken)

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.Iam.V2

Assembly

Google.Cloud.Iam.V2.dll

Remarks

An interface for managing Identity and Access Management (IAM) policies.

Constructors

PoliciesClientImpl(PoliciesClient, PoliciesSettings, ILogger)

public PoliciesClientImpl(Policies.PoliciesClient grpcClient, PoliciesSettings settings, ILogger logger)

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

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

Properties

CreatePolicyOperationsClient

public override OperationsClient CreatePolicyOperationsClient { get; }

The long-running operations client for CreatePolicy.

Property Value
Type	Description
`OperationsClient`

Overrides

PoliciesClient.CreatePolicyOperationsClient

DeletePolicyOperationsClient

public override OperationsClient DeletePolicyOperationsClient { get; }

The long-running operations client for DeletePolicy.

Property Value
Type	Description
`OperationsClient`

Overrides

PoliciesClient.DeletePolicyOperationsClient

GrpcClient

public override Policies.PoliciesClient GrpcClient { get; }

The underlying gRPC Policies client

Property Value
Type	Description
`PoliciesPoliciesClient`

Overrides

PoliciesClient.GrpcClient

UpdatePolicyOperationsClient

public override OperationsClient UpdatePolicyOperationsClient { get; }

The long-running operations client for UpdatePolicy.

Property Value
Type	Description
`OperationsClient`

Overrides

PoliciesClient.UpdatePolicyOperationsClient

Methods

CreatePolicy(CreatePolicyRequest, CallSettings)

public override Operation<Policy, PolicyOperationMetadata> CreatePolicy(CreatePolicyRequest request, CallSettings callSettings = null)

Creates a policy.

Parameters
Name	Description
`request`	`CreatePolicyRequest` 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
`OperationPolicyPolicyOperationMetadata`	The RPC response.

Overrides

PoliciesClient.CreatePolicy(CreatePolicyRequest, CallSettings)

CreatePolicyAsync(CreatePolicyRequest, CallSettings)

public override Task<Operation<Policy, PolicyOperationMetadata>> CreatePolicyAsync(CreatePolicyRequest request, CallSettings callSettings = null)

Creates a policy.

Parameters
Name	Description
`request`	`CreatePolicyRequest` 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
`TaskOperationPolicyPolicyOperationMetadata`	A Task containing the RPC response.

Overrides

PoliciesClient.CreatePolicyAsync(CreatePolicyRequest, CallSettings)

DeletePolicy(DeletePolicyRequest, CallSettings)

public override Operation<Policy, PolicyOperationMetadata> DeletePolicy(DeletePolicyRequest request, CallSettings callSettings = null)

Deletes a policy. This action is permanent.

Parameters
Name	Description
`request`	`DeletePolicyRequest` 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
`OperationPolicyPolicyOperationMetadata`	The RPC response.

Overrides

PoliciesClient.DeletePolicy(DeletePolicyRequest, CallSettings)

DeletePolicyAsync(DeletePolicyRequest, CallSettings)

public override Task<Operation<Policy, PolicyOperationMetadata>> DeletePolicyAsync(DeletePolicyRequest request, CallSettings callSettings = null)

Deletes a policy. This action is permanent.

Parameters
Name	Description
`request`	`DeletePolicyRequest` 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
`TaskOperationPolicyPolicyOperationMetadata`	A Task containing the RPC response.

Overrides

PoliciesClient.DeletePolicyAsync(DeletePolicyRequest, CallSettings)

GetPolicy(GetPolicyRequest, CallSettings)

public override Policy GetPolicy(GetPolicyRequest request, CallSettings callSettings = null)

Gets a policy.

Parameters
Name	Description
`request`	`GetPolicyRequest` 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

PoliciesClient.GetPolicy(GetPolicyRequest, CallSettings)

GetPolicyAsync(GetPolicyRequest, CallSettings)

public override Task<Policy> GetPolicyAsync(GetPolicyRequest request, CallSettings callSettings = null)

Gets a policy.

Parameters
Name	Description
`request`	`GetPolicyRequest` 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
`TaskPolicy`	A Task containing the RPC response.

Overrides

PoliciesClient.GetPolicyAsync(GetPolicyRequest, CallSettings)

ListPolicies(ListPoliciesRequest, CallSettings)

public override PagedEnumerable<ListPoliciesResponse, Policy> ListPolicies(ListPoliciesRequest request, CallSettings callSettings = null)

Retrieves the policies of the specified kind that are attached to a resource.

The response lists only policy metadata. In particular, policy rules are omitted.

Parameters
Name	Description
`request`	`ListPoliciesRequest` 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
`PagedEnumerableListPoliciesResponsePolicy`	A pageable sequence of Policy resources.

Overrides

PoliciesClient.ListPolicies(ListPoliciesRequest, CallSettings)

ListPoliciesAsync(ListPoliciesRequest, CallSettings)

public override PagedAsyncEnumerable<ListPoliciesResponse, Policy> ListPoliciesAsync(ListPoliciesRequest request, CallSettings callSettings = null)

Retrieves the policies of the specified kind that are attached to a resource.

The response lists only policy metadata. In particular, policy rules are omitted.

Parameters
Name	Description
`request`	`ListPoliciesRequest` 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
`PagedAsyncEnumerableListPoliciesResponsePolicy`	A pageable asynchronous sequence of Policy resources.

Overrides

PoliciesClient.ListPoliciesAsync(ListPoliciesRequest, CallSettings)

UpdatePolicy(UpdatePolicyRequest, CallSettings)

public override Operation<Policy, PolicyOperationMetadata> UpdatePolicy(UpdatePolicyRequest request, CallSettings callSettings = null)

Updates the specified policy.

You can update only the rules and the display name for the policy.

To update a policy, you should use a read-modify-write loop:

Use [GetPolicy][google.iam.v2.Policies.GetPolicy] to read the current version of the policy.
Modify the policy as needed.
Use UpdatePolicy to write the updated policy.

This pattern helps prevent conflicts between concurrent updates.

Parameters
Name	Description
`request`	`UpdatePolicyRequest` 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
`OperationPolicyPolicyOperationMetadata`	The RPC response.

Overrides

PoliciesClient.UpdatePolicy(UpdatePolicyRequest, CallSettings)

UpdatePolicyAsync(UpdatePolicyRequest, CallSettings)

public override Task<Operation<Policy, PolicyOperationMetadata>> UpdatePolicyAsync(UpdatePolicyRequest request, CallSettings callSettings = null)

Updates the specified policy.

You can update only the rules and the display name for the policy.

To update a policy, you should use a read-modify-write loop:

Use [GetPolicy][google.iam.v2.Policies.GetPolicy] to read the current version of the policy.
Modify the policy as needed.
Use UpdatePolicy to write the updated policy.

This pattern helps prevent conflicts between concurrent updates.

Parameters
Name	Description
`request`	`UpdatePolicyRequest` 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
`TaskOperationPolicyPolicyOperationMetadata`	A Task containing the RPC response.

Overrides

PoliciesClient.UpdatePolicyAsync(UpdatePolicyRequest, CallSettings)