Compute Engine v1 API - Class ResourcePoliciesClientImpl (2.15.0)

Version latest

• 2.15.0 (latest)
• 2.14.0
• 2.13.0
• 2.12.0
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.0
• 2.2.0
• 2.1.0
• 2.0.0
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.0

public sealed class ResourcePoliciesClientImpl : ResourcePoliciesClient

Reference documentation and code samples for the Compute Engine v1 API class ResourcePoliciesClientImpl.

ResourcePolicies client wrapper implementation, for convenient use.

Inheritance

object > ResourcePoliciesClient > ResourcePoliciesClientImpl

Inherited Members

ResourcePoliciesClient.DefaultEndpoint

ResourcePoliciesClient.DefaultScopes

ResourcePoliciesClient.ServiceMetadata

ResourcePoliciesClient.CreateAsync(CancellationToken)

ResourcePoliciesClient.Create()

ResourcePoliciesClient.ShutdownDefaultChannelsAsync()

ResourcePoliciesClient.AggregatedList(string, string, int?, CallSettings)

ResourcePoliciesClient.AggregatedListAsync(string, string, int?, CallSettings)

ResourcePoliciesClient.DeleteAsync(DeleteResourcePolicyRequest, CancellationToken)

ResourcePoliciesClient.PollOnceDelete(string, CallSettings)

ResourcePoliciesClient.PollOnceDeleteAsync(string, CallSettings)

ResourcePoliciesClient.Delete(string, string, string, CallSettings)

ResourcePoliciesClient.DeleteAsync(string, string, string, CallSettings)

ResourcePoliciesClient.DeleteAsync(string, string, string, CancellationToken)

ResourcePoliciesClient.GetAsync(GetResourcePolicyRequest, CancellationToken)

ResourcePoliciesClient.Get(string, string, string, CallSettings)

ResourcePoliciesClient.GetAsync(string, string, string, CallSettings)

ResourcePoliciesClient.GetAsync(string, string, string, CancellationToken)

ResourcePoliciesClient.GetIamPolicyAsync(GetIamPolicyResourcePolicyRequest, CancellationToken)

ResourcePoliciesClient.GetIamPolicy(string, string, string, CallSettings)

ResourcePoliciesClient.GetIamPolicyAsync(string, string, string, CallSettings)

ResourcePoliciesClient.GetIamPolicyAsync(string, string, string, CancellationToken)

ResourcePoliciesClient.InsertAsync(InsertResourcePolicyRequest, CancellationToken)

ResourcePoliciesClient.PollOnceInsert(string, CallSettings)

ResourcePoliciesClient.PollOnceInsertAsync(string, CallSettings)

ResourcePoliciesClient.Insert(string, string, ResourcePolicy, CallSettings)

ResourcePoliciesClient.InsertAsync(string, string, ResourcePolicy, CallSettings)

ResourcePoliciesClient.InsertAsync(string, string, ResourcePolicy, CancellationToken)

ResourcePoliciesClient.List(string, string, string, int?, CallSettings)

ResourcePoliciesClient.ListAsync(string, string, string, int?, CallSettings)

ResourcePoliciesClient.PatchAsync(PatchResourcePolicyRequest, CancellationToken)

ResourcePoliciesClient.PollOncePatch(string, CallSettings)

ResourcePoliciesClient.PollOncePatchAsync(string, CallSettings)

ResourcePoliciesClient.Patch(string, string, string, ResourcePolicy, CallSettings)

ResourcePoliciesClient.PatchAsync(string, string, string, ResourcePolicy, CallSettings)

ResourcePoliciesClient.PatchAsync(string, string, string, ResourcePolicy, CancellationToken)

ResourcePoliciesClient.SetIamPolicyAsync(SetIamPolicyResourcePolicyRequest, CancellationToken)

ResourcePoliciesClient.SetIamPolicy(string, string, string, RegionSetPolicyRequest, CallSettings)

ResourcePoliciesClient.SetIamPolicyAsync(string, string, string, RegionSetPolicyRequest, CallSettings)

ResourcePoliciesClient.SetIamPolicyAsync(string, string, string, RegionSetPolicyRequest, CancellationToken)

ResourcePoliciesClient.TestIamPermissionsAsync(TestIamPermissionsResourcePolicyRequest, CancellationToken)

ResourcePoliciesClient.TestIamPermissions(string, string, string, TestPermissionsRequest, CallSettings)

ResourcePoliciesClient.TestIamPermissionsAsync(string, string, string, TestPermissionsRequest, CallSettings)

ResourcePoliciesClient.TestIamPermissionsAsync(string, string, string, TestPermissionsRequest, CancellationToken)

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.Compute.V1

Assembly

Google.Cloud.Compute.V1.dll

Remarks

The ResourcePolicies API.

Constructors

ResourcePoliciesClientImpl(ResourcePoliciesClient, ResourcePoliciesSettings, ILogger)

public ResourcePoliciesClientImpl(ResourcePolicies.ResourcePoliciesClient grpcClient, ResourcePoliciesSettings settings, ILogger logger)

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

Parameters
Name	Description
grpcClient	ResourcePoliciesResourcePoliciesClient The underlying gRPC client.
settings	ResourcePoliciesSettings The base ResourcePoliciesSettings used within this client.
logger	ILogger Optional ILogger to use within this client.

Properties

DeleteOperationsClient

public override OperationsClient DeleteOperationsClient { get; }

The long-running operations client for Delete.

Property Value
Type	Description
OperationsClient

Overrides

ResourcePoliciesClient.DeleteOperationsClient

GrpcClient

public override ResourcePolicies.ResourcePoliciesClient GrpcClient { get; }

The underlying gRPC ResourcePolicies client

Property Value
Type	Description
ResourcePoliciesResourcePoliciesClient

Overrides

ResourcePoliciesClient.GrpcClient

InsertOperationsClient

public override OperationsClient InsertOperationsClient { get; }

The long-running operations client for Insert.

Property Value
Type	Description
OperationsClient

Overrides

ResourcePoliciesClient.InsertOperationsClient

PatchOperationsClient

public override OperationsClient PatchOperationsClient { get; }

The long-running operations client for Patch.

Property Value
Type	Description
OperationsClient

Overrides

ResourcePoliciesClient.PatchOperationsClient

Methods

AggregatedList(AggregatedListResourcePoliciesRequest, CallSettings)

public override PagedEnumerable<ResourcePolicyAggregatedList, KeyValuePair<string, ResourcePoliciesScopedList>> AggregatedList(AggregatedListResourcePoliciesRequest request, CallSettings callSettings = null)

Retrieves an aggregated list of resource policies. To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.

Parameters
Name	Description
request	AggregatedListResourcePoliciesRequest 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
PagedEnumerableResourcePolicyAggregatedListKeyValuePairstringResourcePoliciesScopedList	A pageable sequence of KeyValuePair<TKey, TValue> resources.

Overrides

ResourcePoliciesClient.AggregatedList(AggregatedListResourcePoliciesRequest, CallSettings)

AggregatedListAsync(AggregatedListResourcePoliciesRequest, CallSettings)

public override PagedAsyncEnumerable<ResourcePolicyAggregatedList, KeyValuePair<string, ResourcePoliciesScopedList>> AggregatedListAsync(AggregatedListResourcePoliciesRequest request, CallSettings callSettings = null)

Retrieves an aggregated list of resource policies. To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.

Parameters
Name	Description
request	AggregatedListResourcePoliciesRequest 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
PagedAsyncEnumerableResourcePolicyAggregatedListKeyValuePairstringResourcePoliciesScopedList	A pageable asynchronous sequence of KeyValuePair<TKey, TValue> resources.

Overrides

ResourcePoliciesClient.AggregatedListAsync(AggregatedListResourcePoliciesRequest, CallSettings)

Delete(DeleteResourcePolicyRequest, CallSettings)

public override Operation<Operation, Operation> Delete(DeleteResourcePolicyRequest request, CallSettings callSettings = null)

Deletes the specified resource policy.

Parameters
Name	Description
request	DeleteResourcePolicyRequest 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
OperationOperationOperation	The RPC response.

Overrides

ResourcePoliciesClient.Delete(DeleteResourcePolicyRequest, CallSettings)

DeleteAsync(DeleteResourcePolicyRequest, CallSettings)

public override Task<Operation<Operation, Operation>> DeleteAsync(DeleteResourcePolicyRequest request, CallSettings callSettings = null)

Deletes the specified resource policy.

Parameters
Name	Description
request	DeleteResourcePolicyRequest 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
TaskOperationOperationOperation	A Task containing the RPC response.

Overrides

ResourcePoliciesClient.DeleteAsync(DeleteResourcePolicyRequest, CallSettings)

Get(GetResourcePolicyRequest, CallSettings)

public override ResourcePolicy Get(GetResourcePolicyRequest request, CallSettings callSettings = null)

Retrieves all information of the specified resource policy.

Parameters
Name	Description
request	GetResourcePolicyRequest 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
ResourcePolicy	The RPC response.

Overrides

ResourcePoliciesClient.Get(GetResourcePolicyRequest, CallSettings)

GetAsync(GetResourcePolicyRequest, CallSettings)

public override Task<ResourcePolicy> GetAsync(GetResourcePolicyRequest request, CallSettings callSettings = null)

Retrieves all information of the specified resource policy.

Parameters
Name	Description
request	GetResourcePolicyRequest 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
TaskResourcePolicy	A Task containing the RPC response.

Overrides

ResourcePoliciesClient.GetAsync(GetResourcePolicyRequest, CallSettings)

GetIamPolicy(GetIamPolicyResourcePolicyRequest, CallSettings)

public override Policy GetIamPolicy(GetIamPolicyResourcePolicyRequest request, CallSettings callSettings = null)

Gets the access control policy for a resource. May be empty if no such policy or resource exists.

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

ResourcePoliciesClient.GetIamPolicy(GetIamPolicyResourcePolicyRequest, CallSettings)

GetIamPolicyAsync(GetIamPolicyResourcePolicyRequest, CallSettings)

public override Task<Policy> GetIamPolicyAsync(GetIamPolicyResourcePolicyRequest request, CallSettings callSettings = null)

Gets the access control policy for a resource. May be empty if no such policy or resource exists.

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

ResourcePoliciesClient.GetIamPolicyAsync(GetIamPolicyResourcePolicyRequest, CallSettings)

Insert(InsertResourcePolicyRequest, CallSettings)

public override Operation<Operation, Operation> Insert(InsertResourcePolicyRequest request, CallSettings callSettings = null)

Creates a new resource policy.

Parameters
Name	Description
request	InsertResourcePolicyRequest 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
OperationOperationOperation	The RPC response.

Overrides

ResourcePoliciesClient.Insert(InsertResourcePolicyRequest, CallSettings)

InsertAsync(InsertResourcePolicyRequest, CallSettings)

public override Task<Operation<Operation, Operation>> InsertAsync(InsertResourcePolicyRequest request, CallSettings callSettings = null)

Creates a new resource policy.

Parameters
Name	Description
request	InsertResourcePolicyRequest 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
TaskOperationOperationOperation	A Task containing the RPC response.

Overrides

ResourcePoliciesClient.InsertAsync(InsertResourcePolicyRequest, CallSettings)

List(ListResourcePoliciesRequest, CallSettings)

public override PagedEnumerable<ResourcePolicyList, ResourcePolicy> List(ListResourcePoliciesRequest request, CallSettings callSettings = null)

A list all the resource policies that have been configured for the specified project in specified region.

Parameters
Name	Description
request	ListResourcePoliciesRequest 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
PagedEnumerableResourcePolicyListResourcePolicy	A pageable sequence of ResourcePolicy resources.

Overrides

ResourcePoliciesClient.List(ListResourcePoliciesRequest, CallSettings)

ListAsync(ListResourcePoliciesRequest, CallSettings)

public override PagedAsyncEnumerable<ResourcePolicyList, ResourcePolicy> ListAsync(ListResourcePoliciesRequest request, CallSettings callSettings = null)

A list all the resource policies that have been configured for the specified project in specified region.

Parameters
Name	Description
request	ListResourcePoliciesRequest 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
PagedAsyncEnumerableResourcePolicyListResourcePolicy	A pageable asynchronous sequence of ResourcePolicy resources.

Overrides

ResourcePoliciesClient.ListAsync(ListResourcePoliciesRequest, CallSettings)

Patch(PatchResourcePolicyRequest, CallSettings)

public override Operation<Operation, Operation> Patch(PatchResourcePolicyRequest request, CallSettings callSettings = null)

Modify the specified resource policy.

Parameters
Name	Description
request	PatchResourcePolicyRequest 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
OperationOperationOperation	The RPC response.

Overrides

ResourcePoliciesClient.Patch(PatchResourcePolicyRequest, CallSettings)

PatchAsync(PatchResourcePolicyRequest, CallSettings)

public override Task<Operation<Operation, Operation>> PatchAsync(PatchResourcePolicyRequest request, CallSettings callSettings = null)

Modify the specified resource policy.

Parameters
Name	Description
request	PatchResourcePolicyRequest 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
TaskOperationOperationOperation	A Task containing the RPC response.

Overrides

ResourcePoliciesClient.PatchAsync(PatchResourcePolicyRequest, CallSettings)

SetIamPolicy(SetIamPolicyResourcePolicyRequest, CallSettings)

public override Policy SetIamPolicy(SetIamPolicyResourcePolicyRequest request, CallSettings callSettings = null)

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

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

ResourcePoliciesClient.SetIamPolicy(SetIamPolicyResourcePolicyRequest, CallSettings)

SetIamPolicyAsync(SetIamPolicyResourcePolicyRequest, CallSettings)

public override Task<Policy> SetIamPolicyAsync(SetIamPolicyResourcePolicyRequest request, CallSettings callSettings = null)

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

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

ResourcePoliciesClient.SetIamPolicyAsync(SetIamPolicyResourcePolicyRequest, CallSettings)

TestIamPermissions(TestIamPermissionsResourcePolicyRequest, CallSettings)

public override TestPermissionsResponse TestIamPermissions(TestIamPermissionsResourcePolicyRequest request, CallSettings callSettings = null)

Returns permissions that a caller has on the specified resource.

Parameters
Name	Description
request	TestIamPermissionsResourcePolicyRequest 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
TestPermissionsResponse	The RPC response.

Overrides

ResourcePoliciesClient.TestIamPermissions(TestIamPermissionsResourcePolicyRequest, CallSettings)

TestIamPermissionsAsync(TestIamPermissionsResourcePolicyRequest, CallSettings)

public override Task<TestPermissionsResponse> TestIamPermissionsAsync(TestIamPermissionsResourcePolicyRequest request, CallSettings callSettings = null)

Returns permissions that a caller has on the specified resource.

Parameters
Name	Description
request	TestIamPermissionsResourcePolicyRequest 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
TaskTestPermissionsResponse	A Task containing the RPC response.

Overrides

ResourcePoliciesClient.TestIamPermissionsAsync(TestIamPermissionsResourcePolicyRequest, CallSettings)