Compute Engine v1 API - Class InstantSnapshotsClientImpl (2.14.0)

public sealed class InstantSnapshotsClientImpl : InstantSnapshotsClient

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

InstantSnapshots client wrapper implementation, for convenient use.

Inheritance

object > InstantSnapshotsClient > InstantSnapshotsClientImpl

Inherited Members

InstantSnapshotsClient.DefaultEndpoint

InstantSnapshotsClient.DefaultScopes

InstantSnapshotsClient.ServiceMetadata

InstantSnapshotsClient.CreateAsync(CancellationToken)

InstantSnapshotsClient.Create()

InstantSnapshotsClient.ShutdownDefaultChannelsAsync()

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

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

InstantSnapshotsClient.DeleteAsync(DeleteInstantSnapshotRequest, CancellationToken)

InstantSnapshotsClient.PollOnceDelete(string, CallSettings)

InstantSnapshotsClient.PollOnceDeleteAsync(string, CallSettings)

InstantSnapshotsClient.Delete(string, string, string, CallSettings)

InstantSnapshotsClient.DeleteAsync(string, string, string, CallSettings)

InstantSnapshotsClient.DeleteAsync(string, string, string, CancellationToken)

InstantSnapshotsClient.GetAsync(GetInstantSnapshotRequest, CancellationToken)

InstantSnapshotsClient.Get(string, string, string, CallSettings)

InstantSnapshotsClient.GetAsync(string, string, string, CallSettings)

InstantSnapshotsClient.GetAsync(string, string, string, CancellationToken)

InstantSnapshotsClient.GetIamPolicyAsync(GetIamPolicyInstantSnapshotRequest, CancellationToken)

InstantSnapshotsClient.GetIamPolicy(string, string, string, CallSettings)

InstantSnapshotsClient.GetIamPolicyAsync(string, string, string, CallSettings)

InstantSnapshotsClient.GetIamPolicyAsync(string, string, string, CancellationToken)

InstantSnapshotsClient.InsertAsync(InsertInstantSnapshotRequest, CancellationToken)

InstantSnapshotsClient.PollOnceInsert(string, CallSettings)

InstantSnapshotsClient.PollOnceInsertAsync(string, CallSettings)

InstantSnapshotsClient.Insert(string, string, InstantSnapshot, CallSettings)

InstantSnapshotsClient.InsertAsync(string, string, InstantSnapshot, CallSettings)

InstantSnapshotsClient.InsertAsync(string, string, InstantSnapshot, CancellationToken)

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

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

InstantSnapshotsClient.SetIamPolicyAsync(SetIamPolicyInstantSnapshotRequest, CancellationToken)

InstantSnapshotsClient.SetIamPolicy(string, string, string, ZoneSetPolicyRequest, CallSettings)

InstantSnapshotsClient.SetIamPolicyAsync(string, string, string, ZoneSetPolicyRequest, CallSettings)

InstantSnapshotsClient.SetIamPolicyAsync(string, string, string, ZoneSetPolicyRequest, CancellationToken)

InstantSnapshotsClient.SetLabelsAsync(SetLabelsInstantSnapshotRequest, CancellationToken)

InstantSnapshotsClient.PollOnceSetLabels(string, CallSettings)

InstantSnapshotsClient.PollOnceSetLabelsAsync(string, CallSettings)

InstantSnapshotsClient.SetLabels(string, string, string, ZoneSetLabelsRequest, CallSettings)

InstantSnapshotsClient.SetLabelsAsync(string, string, string, ZoneSetLabelsRequest, CallSettings)

InstantSnapshotsClient.SetLabelsAsync(string, string, string, ZoneSetLabelsRequest, CancellationToken)

InstantSnapshotsClient.TestIamPermissionsAsync(TestIamPermissionsInstantSnapshotRequest, CancellationToken)

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

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

InstantSnapshotsClient.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 InstantSnapshots API.

Constructors

InstantSnapshotsClientImpl(InstantSnapshotsClient, InstantSnapshotsSettings, ILogger)

public InstantSnapshotsClientImpl(InstantSnapshots.InstantSnapshotsClient grpcClient, InstantSnapshotsSettings settings, ILogger logger)

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

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

InstantSnapshotsClient.DeleteOperationsClient

GrpcClient

public override InstantSnapshots.InstantSnapshotsClient GrpcClient { get; }

The underlying gRPC InstantSnapshots client

Property Value
Type	Description
`InstantSnapshotsInstantSnapshotsClient`

Overrides

InstantSnapshotsClient.GrpcClient

InsertOperationsClient

public override OperationsClient InsertOperationsClient { get; }

The long-running operations client for Insert.

Property Value
Type	Description
`OperationsClient`

Overrides

InstantSnapshotsClient.InsertOperationsClient

SetLabelsOperationsClient

public override OperationsClient SetLabelsOperationsClient { get; }

The long-running operations client for SetLabels.

Property Value
Type	Description
`OperationsClient`

Overrides

InstantSnapshotsClient.SetLabelsOperationsClient

Methods

AggregatedList(AggregatedListInstantSnapshotsRequest, CallSettings)

public override PagedEnumerable<InstantSnapshotAggregatedList, KeyValuePair<string, InstantSnapshotsScopedList>> AggregatedList(AggregatedListInstantSnapshotsRequest request, CallSettings callSettings = null)

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

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

Overrides

InstantSnapshotsClient.AggregatedList(AggregatedListInstantSnapshotsRequest, CallSettings)

AggregatedListAsync(AggregatedListInstantSnapshotsRequest, CallSettings)

public override PagedAsyncEnumerable<InstantSnapshotAggregatedList, KeyValuePair<string, InstantSnapshotsScopedList>> AggregatedListAsync(AggregatedListInstantSnapshotsRequest request, CallSettings callSettings = null)

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

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

Overrides

InstantSnapshotsClient.AggregatedListAsync(AggregatedListInstantSnapshotsRequest, CallSettings)

Delete(DeleteInstantSnapshotRequest, CallSettings)

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

Deletes the specified InstantSnapshot resource. Keep in mind that deleting a single instantSnapshot might not necessarily delete all the data on that instantSnapshot. If any data on the instantSnapshot that is marked for deletion is needed for subsequent instantSnapshots, the data will be moved to the next corresponding instantSnapshot. For more information, see Deleting instantSnapshots.

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

InstantSnapshotsClient.Delete(DeleteInstantSnapshotRequest, CallSettings)

DeleteAsync(DeleteInstantSnapshotRequest, CallSettings)

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

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

InstantSnapshotsClient.DeleteAsync(DeleteInstantSnapshotRequest, CallSettings)

Get(GetInstantSnapshotRequest, CallSettings)

public override InstantSnapshot Get(GetInstantSnapshotRequest request, CallSettings callSettings = null)

Returns the specified InstantSnapshot resource in the specified zone.

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

Overrides

InstantSnapshotsClient.Get(GetInstantSnapshotRequest, CallSettings)

GetAsync(GetInstantSnapshotRequest, CallSettings)

public override Task<InstantSnapshot> GetAsync(GetInstantSnapshotRequest request, CallSettings callSettings = null)

Returns the specified InstantSnapshot resource in the specified zone.

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

Overrides

InstantSnapshotsClient.GetAsync(GetInstantSnapshotRequest, CallSettings)

GetIamPolicy(GetIamPolicyInstantSnapshotRequest, CallSettings)

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

InstantSnapshotsClient.GetIamPolicy(GetIamPolicyInstantSnapshotRequest, CallSettings)

GetIamPolicyAsync(GetIamPolicyInstantSnapshotRequest, CallSettings)

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

InstantSnapshotsClient.GetIamPolicyAsync(GetIamPolicyInstantSnapshotRequest, CallSettings)

Insert(InsertInstantSnapshotRequest, CallSettings)

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

Creates an instant snapshot in the specified zone.

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

InstantSnapshotsClient.Insert(InsertInstantSnapshotRequest, CallSettings)

InsertAsync(InsertInstantSnapshotRequest, CallSettings)

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

Creates an instant snapshot in the specified zone.

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

InstantSnapshotsClient.InsertAsync(InsertInstantSnapshotRequest, CallSettings)

List(ListInstantSnapshotsRequest, CallSettings)

public override PagedEnumerable<InstantSnapshotList, InstantSnapshot> List(ListInstantSnapshotsRequest request, CallSettings callSettings = null)

Retrieves the list of InstantSnapshot resources contained within the specified zone.

Parameters
Name	Description
`request`	`ListInstantSnapshotsRequest` 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
`PagedEnumerableInstantSnapshotListInstantSnapshot`	A pageable sequence of InstantSnapshot resources.

Overrides

InstantSnapshotsClient.List(ListInstantSnapshotsRequest, CallSettings)

ListAsync(ListInstantSnapshotsRequest, CallSettings)

public override PagedAsyncEnumerable<InstantSnapshotList, InstantSnapshot> ListAsync(ListInstantSnapshotsRequest request, CallSettings callSettings = null)

Retrieves the list of InstantSnapshot resources contained within the specified zone.

Parameters
Name	Description
`request`	`ListInstantSnapshotsRequest` 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
`PagedAsyncEnumerableInstantSnapshotListInstantSnapshot`	A pageable asynchronous sequence of InstantSnapshot resources.

Overrides

InstantSnapshotsClient.ListAsync(ListInstantSnapshotsRequest, CallSettings)

SetIamPolicy(SetIamPolicyInstantSnapshotRequest, CallSettings)

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

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

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

InstantSnapshotsClient.SetIamPolicy(SetIamPolicyInstantSnapshotRequest, CallSettings)

SetIamPolicyAsync(SetIamPolicyInstantSnapshotRequest, CallSettings)

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

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

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

InstantSnapshotsClient.SetIamPolicyAsync(SetIamPolicyInstantSnapshotRequest, CallSettings)

SetLabels(SetLabelsInstantSnapshotRequest, CallSettings)

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

Sets the labels on a instantSnapshot in the given zone. To learn more about labels, read the Labeling Resources documentation.

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

InstantSnapshotsClient.SetLabels(SetLabelsInstantSnapshotRequest, CallSettings)

SetLabelsAsync(SetLabelsInstantSnapshotRequest, CallSettings)

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

Sets the labels on a instantSnapshot in the given zone. To learn more about labels, read the Labeling Resources documentation.

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

InstantSnapshotsClient.SetLabelsAsync(SetLabelsInstantSnapshotRequest, CallSettings)

TestIamPermissions(TestIamPermissionsInstantSnapshotRequest, CallSettings)

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

Returns permissions that a caller has on the specified resource.

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

InstantSnapshotsClient.TestIamPermissions(TestIamPermissionsInstantSnapshotRequest, CallSettings)

TestIamPermissionsAsync(TestIamPermissionsInstantSnapshotRequest, CallSettings)

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

Returns permissions that a caller has on the specified resource.

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

InstantSnapshotsClient.TestIamPermissionsAsync(TestIamPermissionsInstantSnapshotRequest, CallSettings)