Compute Engine v1 API - Class SnapshotsClientImpl (2.5.0)

public sealed class SnapshotsClientImpl : SnapshotsClient

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

Snapshots client wrapper implementation, for convenient use.

Inheritance

Object > SnapshotsClient > SnapshotsClientImpl

Inherited Members

SnapshotsClient.DefaultEndpoint

SnapshotsClient.DefaultScopes

SnapshotsClient.ServiceMetadata

SnapshotsClient.CreateAsync(CancellationToken)

SnapshotsClient.Create()

SnapshotsClient.ShutdownDefaultChannelsAsync()

SnapshotsClient.DeleteAsync(DeleteSnapshotRequest, CancellationToken)

SnapshotsClient.PollOnceDelete(String, CallSettings)

SnapshotsClient.PollOnceDeleteAsync(String, CallSettings)

SnapshotsClient.Delete(String, String, CallSettings)

SnapshotsClient.DeleteAsync(String, String, CallSettings)

SnapshotsClient.DeleteAsync(String, String, CancellationToken)

SnapshotsClient.GetAsync(GetSnapshotRequest, CancellationToken)

SnapshotsClient.Get(String, String, CallSettings)

SnapshotsClient.GetAsync(String, String, CallSettings)

SnapshotsClient.GetAsync(String, String, CancellationToken)

SnapshotsClient.GetIamPolicyAsync(GetIamPolicySnapshotRequest, CancellationToken)

SnapshotsClient.GetIamPolicy(String, String, CallSettings)

SnapshotsClient.GetIamPolicyAsync(String, String, CallSettings)

SnapshotsClient.GetIamPolicyAsync(String, String, CancellationToken)

SnapshotsClient.InsertAsync(InsertSnapshotRequest, CancellationToken)

SnapshotsClient.PollOnceInsert(String, CallSettings)

SnapshotsClient.PollOnceInsertAsync(String, CallSettings)

SnapshotsClient.Insert(String, Snapshot, CallSettings)

SnapshotsClient.InsertAsync(String, Snapshot, CallSettings)

SnapshotsClient.InsertAsync(String, Snapshot, CancellationToken)

SnapshotsClient.List(String, String, Nullable<Int32>, CallSettings)

SnapshotsClient.ListAsync(String, String, Nullable<Int32>, CallSettings)

SnapshotsClient.SetIamPolicyAsync(SetIamPolicySnapshotRequest, CancellationToken)

SnapshotsClient.SetIamPolicy(String, String, GlobalSetPolicyRequest, CallSettings)

SnapshotsClient.SetIamPolicyAsync(String, String, GlobalSetPolicyRequest, CallSettings)

SnapshotsClient.SetIamPolicyAsync(String, String, GlobalSetPolicyRequest, CancellationToken)

SnapshotsClient.SetLabelsAsync(SetLabelsSnapshotRequest, CancellationToken)

SnapshotsClient.PollOnceSetLabels(String, CallSettings)

SnapshotsClient.PollOnceSetLabelsAsync(String, CallSettings)

SnapshotsClient.SetLabels(String, String, GlobalSetLabelsRequest, CallSettings)

SnapshotsClient.SetLabelsAsync(String, String, GlobalSetLabelsRequest, CallSettings)

SnapshotsClient.SetLabelsAsync(String, String, GlobalSetLabelsRequest, CancellationToken)

SnapshotsClient.TestIamPermissionsAsync(TestIamPermissionsSnapshotRequest, CancellationToken)

SnapshotsClient.TestIamPermissions(String, String, TestPermissionsRequest, CallSettings)

SnapshotsClient.TestIamPermissionsAsync(String, String, TestPermissionsRequest, CallSettings)

SnapshotsClient.TestIamPermissionsAsync(String, String, TestPermissionsRequest, CancellationToken)

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ToString()

Namespace

Google.Cloud.Compute.V1

Assembly

Google.Cloud.Compute.V1.dll

Remarks

The Snapshots API.

Constructors

SnapshotsClientImpl(Snapshots.SnapshotsClient, SnapshotsSettings, ILogger)

public SnapshotsClientImpl(Snapshots.SnapshotsClient grpcClient, SnapshotsSettings settings, ILogger logger)

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

Parameters
Name	Description
`grpcClient`	`Snapshots.SnapshotsClient` The underlying gRPC client.
`settings`	`SnapshotsSettings` The base SnapshotsSettings 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

SnapshotsClient.DeleteOperationsClient

GrpcClient

public override Snapshots.SnapshotsClient GrpcClient { get; }

The underlying gRPC Snapshots client

Property Value
Type	Description
`Snapshots.SnapshotsClient`

Overrides

SnapshotsClient.GrpcClient

InsertOperationsClient

public override OperationsClient InsertOperationsClient { get; }

The long-running operations client for Insert.

Property Value
Type	Description
`OperationsClient`

Overrides

SnapshotsClient.InsertOperationsClient

SetLabelsOperationsClient

public override OperationsClient SetLabelsOperationsClient { get; }

The long-running operations client for SetLabels.

Property Value
Type	Description
`OperationsClient`

Overrides

SnapshotsClient.SetLabelsOperationsClient

Methods

Delete(DeleteSnapshotRequest, CallSettings)

public override Operation<Operation, Operation> Delete(DeleteSnapshotRequest 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, see Deleting snapshots.

Parameters
Name	Description
`request`	`DeleteSnapshotRequest` 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
`Operation<Operation, Operation>`	The RPC response.

Overrides

SnapshotsClient.Delete(DeleteSnapshotRequest, CallSettings)

DeleteAsync(DeleteSnapshotRequest, CallSettings)

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

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

Overrides

SnapshotsClient.DeleteAsync(DeleteSnapshotRequest, CallSettings)

Get(GetSnapshotRequest, CallSettings)

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

Returns the specified Snapshot resource. Gets a list of available snapshots by making a list() request.

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

SnapshotsClient.Get(GetSnapshotRequest, CallSettings)

GetAsync(GetSnapshotRequest, CallSettings)

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

Returns the specified Snapshot resource. Gets a list of available snapshots by making a list() request.

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

Overrides

SnapshotsClient.GetAsync(GetSnapshotRequest, CallSettings)

GetIamPolicy(GetIamPolicySnapshotRequest, CallSettings)

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

SnapshotsClient.GetIamPolicy(GetIamPolicySnapshotRequest, CallSettings)

GetIamPolicyAsync(GetIamPolicySnapshotRequest, CallSettings)

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

SnapshotsClient.GetIamPolicyAsync(GetIamPolicySnapshotRequest, CallSettings)

Insert(InsertSnapshotRequest, CallSettings)

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

Creates a snapshot in the specified project using the data included in the request. For regular snapshot creation, consider using this method instead of disks.createSnapshot, as this method supports more features, such as creating snapshots in a project different from the source disk project.

Parameters
Name	Description
`request`	`InsertSnapshotRequest` 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
`Operation<Operation, Operation>`	The RPC response.

Overrides

SnapshotsClient.Insert(InsertSnapshotRequest, CallSettings)

InsertAsync(InsertSnapshotRequest, CallSettings)

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

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

Overrides

SnapshotsClient.InsertAsync(InsertSnapshotRequest, CallSettings)

List(ListSnapshotsRequest, CallSettings)

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

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

Parameters
Name	Description
`request`	`ListSnapshotsRequest` 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
`PagedEnumerable<SnapshotList, Snapshot>`	A pageable sequence of Snapshot resources.

Overrides

SnapshotsClient.List(ListSnapshotsRequest, CallSettings)

ListAsync(ListSnapshotsRequest, CallSettings)

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

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

Parameters
Name	Description
`request`	`ListSnapshotsRequest` 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
`PagedAsyncEnumerable<SnapshotList, Snapshot>`	A pageable asynchronous sequence of Snapshot resources.

Overrides

SnapshotsClient.ListAsync(ListSnapshotsRequest, CallSettings)

SetIamPolicy(SetIamPolicySnapshotRequest, CallSettings)

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

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

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

SnapshotsClient.SetIamPolicy(SetIamPolicySnapshotRequest, CallSettings)

SetIamPolicyAsync(SetIamPolicySnapshotRequest, CallSettings)

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

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

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

SnapshotsClient.SetIamPolicyAsync(SetIamPolicySnapshotRequest, CallSettings)

SetLabels(SetLabelsSnapshotRequest, CallSettings)

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

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

Parameters
Name	Description
`request`	`SetLabelsSnapshotRequest` 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
`Operation<Operation, Operation>`	The RPC response.

Overrides

SnapshotsClient.SetLabels(SetLabelsSnapshotRequest, CallSettings)

SetLabelsAsync(SetLabelsSnapshotRequest, CallSettings)

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

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

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

Overrides

SnapshotsClient.SetLabelsAsync(SetLabelsSnapshotRequest, CallSettings)

TestIamPermissions(TestIamPermissionsSnapshotRequest, CallSettings)

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

Returns permissions that a caller has on the specified resource.

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

SnapshotsClient.TestIamPermissions(TestIamPermissionsSnapshotRequest, CallSettings)

TestIamPermissionsAsync(TestIamPermissionsSnapshotRequest, CallSettings)

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

Returns permissions that a caller has on the specified resource.

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

Overrides

SnapshotsClient.TestIamPermissionsAsync(TestIamPermissionsSnapshotRequest, CallSettings)