Compute Engine v1 API - Class RegionSnapshotsClientImpl (3.27.0)

3.27.0 (latest) 3.26.0 3.25.0 3.24.0 3.23.0 3.22.0 3.21.0 3.20.0 3.19.0 3.18.0 3.17.0 3.16.0 3.15.0 3.14.0 3.13.0 3.12.0 3.11.0 3.10.0 3.9.0 3.8.0 3.7.0 3.6.0 3.5.0 3.4.0 3.3.0 3.2.0 3.1.0 3.0.0 2.17.0 2.16.0 2.15.0 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 RegionSnapshotsClientImpl : RegionSnapshotsClient

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

RegionSnapshots client wrapper implementation, for convenient use.

Inheritance

object > RegionSnapshotsClient > RegionSnapshotsClientImpl

Inherited Members

RegionSnapshotsClient.DefaultEndpoint

RegionSnapshotsClient.DefaultScopes

RegionSnapshotsClient.ServiceMetadata

RegionSnapshotsClient.CreateAsync(CancellationToken)

RegionSnapshotsClient.Create()

RegionSnapshotsClient.ShutdownDefaultChannelsAsync()

RegionSnapshotsClient.DeleteAsync(DeleteRegionSnapshotRequest, CancellationToken)

RegionSnapshotsClient.PollOnceDelete(string, CallSettings)

RegionSnapshotsClient.PollOnceDeleteAsync(string, CallSettings)

RegionSnapshotsClient.Delete(string, string, string, CallSettings)

RegionSnapshotsClient.DeleteAsync(string, string, string, CallSettings)

RegionSnapshotsClient.DeleteAsync(string, string, string, CancellationToken)

RegionSnapshotsClient.GetAsync(GetRegionSnapshotRequest, CancellationToken)

RegionSnapshotsClient.Get(string, string, string, CallSettings)

RegionSnapshotsClient.GetAsync(string, string, string, CallSettings)

RegionSnapshotsClient.GetAsync(string, string, string, CancellationToken)

RegionSnapshotsClient.GetIamPolicyAsync(GetIamPolicyRegionSnapshotRequest, CancellationToken)

RegionSnapshotsClient.GetIamPolicy(string, string, string, CallSettings)

RegionSnapshotsClient.GetIamPolicyAsync(string, string, string, CallSettings)

RegionSnapshotsClient.GetIamPolicyAsync(string, string, string, CancellationToken)

RegionSnapshotsClient.InsertAsync(InsertRegionSnapshotRequest, CancellationToken)

RegionSnapshotsClient.PollOnceInsert(string, CallSettings)

RegionSnapshotsClient.PollOnceInsertAsync(string, CallSettings)

RegionSnapshotsClient.Insert(string, string, Snapshot, CallSettings)

RegionSnapshotsClient.InsertAsync(string, string, Snapshot, CallSettings)

RegionSnapshotsClient.InsertAsync(string, string, Snapshot, CancellationToken)

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

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

RegionSnapshotsClient.SetIamPolicyAsync(SetIamPolicyRegionSnapshotRequest, CancellationToken)

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

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

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

RegionSnapshotsClient.SetLabelsAsync(SetLabelsRegionSnapshotRequest, CancellationToken)

RegionSnapshotsClient.PollOnceSetLabels(string, CallSettings)

RegionSnapshotsClient.PollOnceSetLabelsAsync(string, CallSettings)

RegionSnapshotsClient.SetLabels(string, string, string, RegionSetLabelsRequest, CallSettings)

RegionSnapshotsClient.SetLabelsAsync(string, string, string, RegionSetLabelsRequest, CallSettings)

RegionSnapshotsClient.SetLabelsAsync(string, string, string, RegionSetLabelsRequest, CancellationToken)

RegionSnapshotsClient.TestIamPermissionsAsync(TestIamPermissionsRegionSnapshotRequest, CancellationToken)

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

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

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

RegionSnapshotsClient.UpdateKmsKeyAsync(UpdateKmsKeyRegionSnapshotRequest, CancellationToken)

RegionSnapshotsClient.PollOnceUpdateKmsKey(string, CallSettings)

RegionSnapshotsClient.PollOnceUpdateKmsKeyAsync(string, CallSettings)

RegionSnapshotsClient.UpdateKmsKey(string, string, string, RegionSnapshotUpdateKmsKeyRequest, CallSettings)

RegionSnapshotsClient.UpdateKmsKeyAsync(string, string, string, RegionSnapshotUpdateKmsKeyRequest, CallSettings)

RegionSnapshotsClient.UpdateKmsKeyAsync(string, string, string, RegionSnapshotUpdateKmsKeyRequest, CancellationToken)

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.Compute.V1

Assembly

Google.Cloud.Compute.V1.dll

Remarks

The RegionSnapshots API.

Constructors

RegionSnapshotsClientImpl(RegionSnapshotsClient, RegionSnapshotsSettings, ILogger)

public RegionSnapshotsClientImpl(RegionSnapshots.RegionSnapshotsClient grpcClient, RegionSnapshotsSettings settings, ILogger logger)

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

Parameters
Name	Description
grpcClient	RegionSnapshotsRegionSnapshotsClient The underlying gRPC client.
settings	RegionSnapshotsSettings The base RegionSnapshotsSettings 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

RegionSnapshotsClient.DeleteOperationsClient

GrpcClient

public override RegionSnapshots.RegionSnapshotsClient GrpcClient { get; }

The underlying gRPC RegionSnapshots client

Property Value
Type	Description
RegionSnapshotsRegionSnapshotsClient

Overrides

RegionSnapshotsClient.GrpcClient

InsertOperationsClient

public override OperationsClient InsertOperationsClient { get; }

The long-running operations client for Insert.

Property Value
Type	Description
OperationsClient

Overrides

RegionSnapshotsClient.InsertOperationsClient

SetLabelsOperationsClient

public override OperationsClient SetLabelsOperationsClient { get; }

The long-running operations client for SetLabels.

Property Value
Type	Description
OperationsClient

Overrides

RegionSnapshotsClient.SetLabelsOperationsClient

UpdateKmsKeyOperationsClient

public override OperationsClient UpdateKmsKeyOperationsClient { get; }

The long-running operations client for UpdateKmsKey.

Property Value
Type	Description
OperationsClient

Overrides

RegionSnapshotsClient.UpdateKmsKeyOperationsClient

Methods

Delete(DeleteRegionSnapshotRequest, CallSettings)

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

Deletes the specified Snapshot resource. Keep in mind that deleting a single snapshot might not necessarily delete all the data on that snapshot. If any data on the snapshot that is marked for deletion is needed for subsequent snapshots, the data will be moved to the next corresponding snapshot.

For more information, seeDeleting snapshots.

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

RegionSnapshotsClient.Delete(DeleteRegionSnapshotRequest, CallSettings)

DeleteAsync(DeleteRegionSnapshotRequest, CallSettings)

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

Deletes the specified Snapshot resource. Keep in mind that deleting a single snapshot might not necessarily delete all the data on that snapshot. If any data on the snapshot that is marked for deletion is needed for subsequent snapshots, the data will be moved to the next corresponding snapshot.

For more information, seeDeleting snapshots.

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

RegionSnapshotsClient.DeleteAsync(DeleteRegionSnapshotRequest, CallSettings)

Get(GetRegionSnapshotRequest, CallSettings)

public override Snapshot Get(GetRegionSnapshotRequest request, CallSettings callSettings = null)

Returns the specified Snapshot resource.

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

Overrides

RegionSnapshotsClient.Get(GetRegionSnapshotRequest, CallSettings)

GetAsync(GetRegionSnapshotRequest, CallSettings)

public override Task<Snapshot> GetAsync(GetRegionSnapshotRequest request, CallSettings callSettings = null)

Returns the specified Snapshot resource.

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

Overrides

RegionSnapshotsClient.GetAsync(GetRegionSnapshotRequest, CallSettings)

GetIamPolicy(GetIamPolicyRegionSnapshotRequest, CallSettings)

public override Policy GetIamPolicy(GetIamPolicyRegionSnapshotRequest 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	GetIamPolicyRegionSnapshotRequest 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

RegionSnapshotsClient.GetIamPolicy(GetIamPolicyRegionSnapshotRequest, CallSettings)

GetIamPolicyAsync(GetIamPolicyRegionSnapshotRequest, CallSettings)

public override Task<Policy> GetIamPolicyAsync(GetIamPolicyRegionSnapshotRequest 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	GetIamPolicyRegionSnapshotRequest 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

RegionSnapshotsClient.GetIamPolicyAsync(GetIamPolicyRegionSnapshotRequest, CallSettings)

Insert(InsertRegionSnapshotRequest, CallSettings)

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

Creates a snapshot in the specified region using the data included in the request.

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

RegionSnapshotsClient.Insert(InsertRegionSnapshotRequest, CallSettings)

InsertAsync(InsertRegionSnapshotRequest, CallSettings)

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

Creates a snapshot in the specified region using the data included in the request.

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

RegionSnapshotsClient.InsertAsync(InsertRegionSnapshotRequest, CallSettings)

List(ListRegionSnapshotsRequest, CallSettings)

public override PagedEnumerable<SnapshotList, Snapshot> List(ListRegionSnapshotsRequest request, CallSettings callSettings = null)

Retrieves the list of Snapshot resources contained within the specified region.

Parameters
Name	Description
request	ListRegionSnapshotsRequest 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
PagedEnumerableSnapshotListSnapshot	A pageable sequence of Snapshot resources.

Overrides

RegionSnapshotsClient.List(ListRegionSnapshotsRequest, CallSettings)

ListAsync(ListRegionSnapshotsRequest, CallSettings)

public override PagedAsyncEnumerable<SnapshotList, Snapshot> ListAsync(ListRegionSnapshotsRequest request, CallSettings callSettings = null)

Retrieves the list of Snapshot resources contained within the specified region.

Parameters
Name	Description
request	ListRegionSnapshotsRequest 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
PagedAsyncEnumerableSnapshotListSnapshot	A pageable asynchronous sequence of Snapshot resources.

Overrides

RegionSnapshotsClient.ListAsync(ListRegionSnapshotsRequest, CallSettings)

SetIamPolicy(SetIamPolicyRegionSnapshotRequest, CallSettings)

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

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

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

RegionSnapshotsClient.SetIamPolicy(SetIamPolicyRegionSnapshotRequest, CallSettings)

SetIamPolicyAsync(SetIamPolicyRegionSnapshotRequest, CallSettings)

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

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

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

RegionSnapshotsClient.SetIamPolicyAsync(SetIamPolicyRegionSnapshotRequest, CallSettings)

SetLabels(SetLabelsRegionSnapshotRequest, CallSettings)

public override Operation<Operation, Operation> SetLabels(SetLabelsRegionSnapshotRequest request, CallSettings callSettings = null)

Sets the labels on a regional snapshot. To learn more about labels, read the Labeling Resources documentation.

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

RegionSnapshotsClient.SetLabels(SetLabelsRegionSnapshotRequest, CallSettings)

SetLabelsAsync(SetLabelsRegionSnapshotRequest, CallSettings)

public override Task<Operation<Operation, Operation>> SetLabelsAsync(SetLabelsRegionSnapshotRequest request, CallSettings callSettings = null)

Sets the labels on a regional snapshot. To learn more about labels, read the Labeling Resources documentation.

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

RegionSnapshotsClient.SetLabelsAsync(SetLabelsRegionSnapshotRequest, CallSettings)

TestIamPermissions(TestIamPermissionsRegionSnapshotRequest, CallSettings)

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

Returns permissions that a caller has on the specified resource.

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

RegionSnapshotsClient.TestIamPermissions(TestIamPermissionsRegionSnapshotRequest, CallSettings)

TestIamPermissionsAsync(TestIamPermissionsRegionSnapshotRequest, CallSettings)

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

Returns permissions that a caller has on the specified resource.

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

RegionSnapshotsClient.TestIamPermissionsAsync(TestIamPermissionsRegionSnapshotRequest, CallSettings)

UpdateKmsKey(UpdateKmsKeyRegionSnapshotRequest, CallSettings)

public override Operation<Operation, Operation> UpdateKmsKey(UpdateKmsKeyRegionSnapshotRequest request, CallSettings callSettings = null)

Rotates the customer-managed encryption key to the latest version for the specified snapshot.

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

RegionSnapshotsClient.UpdateKmsKey(UpdateKmsKeyRegionSnapshotRequest, CallSettings)

UpdateKmsKeyAsync(UpdateKmsKeyRegionSnapshotRequest, CallSettings)

public override Task<Operation<Operation, Operation>> UpdateKmsKeyAsync(UpdateKmsKeyRegionSnapshotRequest request, CallSettings callSettings = null)

Rotates the customer-managed encryption key to the latest version for the specified snapshot.

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

RegionSnapshotsClient.UpdateKmsKeyAsync(UpdateKmsKeyRegionSnapshotRequest, CallSettings)