Compute Engine v1 API - Class RegionInstantSnapshots.RegionInstantSnapshotsClient (3.1.0)

Version latest

• 3.1.0 (latest)
• 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 class RegionInstantSnapshots.RegionInstantSnapshotsClient : ClientBase<RegionInstantSnapshots.RegionInstantSnapshotsClient>

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

Client for RegionInstantSnapshots

Inheritance

object > ClientBase > ClientBaseRegionInstantSnapshotsRegionInstantSnapshotsClient > RegionInstantSnapshots.RegionInstantSnapshotsClient

Inherited Members

ClientBase<RegionInstantSnapshots.RegionInstantSnapshotsClient>.WithHost(string)

ClientBase.CallInvoker

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

Google.Cloud.Compute.V1

Assembly

Google.Cloud.Compute.V1.dll

Constructors

RegionInstantSnapshotsClient()

protected RegionInstantSnapshotsClient()

Protected parameterless constructor to allow creation of test doubles.

RegionInstantSnapshotsClient(CallInvoker)

public RegionInstantSnapshotsClient(CallInvoker callInvoker)

Creates a new client for RegionInstantSnapshots that uses a custom CallInvoker.

Parameter
Name	Description
callInvoker	CallInvoker The callInvoker to use to make remote calls.

RegionInstantSnapshotsClient(ChannelBase)

public RegionInstantSnapshotsClient(ChannelBase channel)

Creates a new client for RegionInstantSnapshots

Parameter
Name	Description
channel	ChannelBase The channel to use to make remote calls.

RegionInstantSnapshotsClient(ClientBaseConfiguration)

protected RegionInstantSnapshotsClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name	Description
configuration	ClientBaseClientBaseConfiguration The client configuration.

Methods

CreateOperationsClientForRegionOperations()

public virtual Operations.OperationsClient CreateOperationsClientForRegionOperations()

Creates a new instance of Operations.OperationsClient using the same call invoker as this client, delegating to RegionOperations.

Returns
Type	Description
OperationsOperationsClient	A new Operations client for the same target as this client.

Delete(DeleteRegionInstantSnapshotRequest, CallOptions)

public virtual Operation Delete(DeleteRegionInstantSnapshotRequest request, CallOptions options)

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	DeleteRegionInstantSnapshotRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Operation	The response received from the server.

Delete(DeleteRegionInstantSnapshotRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation Delete(DeleteRegionInstantSnapshotRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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	DeleteRegionInstantSnapshotRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Operation	The response received from the server.

DeleteAsync(DeleteRegionInstantSnapshotRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> DeleteAsync(DeleteRegionInstantSnapshotRequest request, CallOptions options)

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	DeleteRegionInstantSnapshotRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

DeleteAsync(DeleteRegionInstantSnapshotRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> DeleteAsync(DeleteRegionInstantSnapshotRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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	DeleteRegionInstantSnapshotRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

Get(GetRegionInstantSnapshotRequest, CallOptions)

public virtual InstantSnapshot Get(GetRegionInstantSnapshotRequest request, CallOptions options)

Returns the specified InstantSnapshot resource in the specified region.

Parameters
Name	Description
request	GetRegionInstantSnapshotRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
InstantSnapshot	The response received from the server.

Get(GetRegionInstantSnapshotRequest, Metadata, DateTime?, CancellationToken)

public virtual InstantSnapshot Get(GetRegionInstantSnapshotRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Returns the specified InstantSnapshot resource in the specified region.

Parameters
Name	Description
request	GetRegionInstantSnapshotRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
InstantSnapshot	The response received from the server.

GetAsync(GetRegionInstantSnapshotRequest, CallOptions)

public virtual AsyncUnaryCall<InstantSnapshot> GetAsync(GetRegionInstantSnapshotRequest request, CallOptions options)

Returns the specified InstantSnapshot resource in the specified region.

Parameters
Name	Description
request	GetRegionInstantSnapshotRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallInstantSnapshot	The call object.

GetAsync(GetRegionInstantSnapshotRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<InstantSnapshot> GetAsync(GetRegionInstantSnapshotRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Returns the specified InstantSnapshot resource in the specified region.

Parameters
Name	Description
request	GetRegionInstantSnapshotRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallInstantSnapshot	The call object.

GetIamPolicy(GetIamPolicyRegionInstantSnapshotRequest, CallOptions)

public virtual Policy GetIamPolicy(GetIamPolicyRegionInstantSnapshotRequest request, CallOptions options)

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

Parameters
Name	Description
request	GetIamPolicyRegionInstantSnapshotRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Policy	The response received from the server.

GetIamPolicy(GetIamPolicyRegionInstantSnapshotRequest, Metadata, DateTime?, CancellationToken)

public virtual Policy GetIamPolicy(GetIamPolicyRegionInstantSnapshotRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name	Description
request	GetIamPolicyRegionInstantSnapshotRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Policy	The response received from the server.

GetIamPolicyAsync(GetIamPolicyRegionInstantSnapshotRequest, CallOptions)

public virtual AsyncUnaryCall<Policy> GetIamPolicyAsync(GetIamPolicyRegionInstantSnapshotRequest request, CallOptions options)

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

Parameters
Name	Description
request	GetIamPolicyRegionInstantSnapshotRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallPolicy	The call object.

GetIamPolicyAsync(GetIamPolicyRegionInstantSnapshotRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Policy> GetIamPolicyAsync(GetIamPolicyRegionInstantSnapshotRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name	Description
request	GetIamPolicyRegionInstantSnapshotRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallPolicy	The call object.

Insert(InsertRegionInstantSnapshotRequest, CallOptions)

public virtual Operation Insert(InsertRegionInstantSnapshotRequest request, CallOptions options)

Creates an instant snapshot in the specified region.

Parameters
Name	Description
request	InsertRegionInstantSnapshotRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Operation	The response received from the server.

Insert(InsertRegionInstantSnapshotRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation Insert(InsertRegionInstantSnapshotRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates an instant snapshot in the specified region.

Parameters
Name	Description
request	InsertRegionInstantSnapshotRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Operation	The response received from the server.

InsertAsync(InsertRegionInstantSnapshotRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> InsertAsync(InsertRegionInstantSnapshotRequest request, CallOptions options)

Creates an instant snapshot in the specified region.

Parameters
Name	Description
request	InsertRegionInstantSnapshotRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

InsertAsync(InsertRegionInstantSnapshotRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> InsertAsync(InsertRegionInstantSnapshotRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates an instant snapshot in the specified region.

Parameters
Name	Description
request	InsertRegionInstantSnapshotRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

List(ListRegionInstantSnapshotsRequest, CallOptions)

public virtual InstantSnapshotList List(ListRegionInstantSnapshotsRequest request, CallOptions options)

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

Parameters
Name	Description
request	ListRegionInstantSnapshotsRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
InstantSnapshotList	The response received from the server.

List(ListRegionInstantSnapshotsRequest, Metadata, DateTime?, CancellationToken)

public virtual InstantSnapshotList List(ListRegionInstantSnapshotsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name	Description
request	ListRegionInstantSnapshotsRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
InstantSnapshotList	The response received from the server.

ListAsync(ListRegionInstantSnapshotsRequest, CallOptions)

public virtual AsyncUnaryCall<InstantSnapshotList> ListAsync(ListRegionInstantSnapshotsRequest request, CallOptions options)

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

Parameters
Name	Description
request	ListRegionInstantSnapshotsRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallInstantSnapshotList	The call object.

ListAsync(ListRegionInstantSnapshotsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<InstantSnapshotList> ListAsync(ListRegionInstantSnapshotsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name	Description
request	ListRegionInstantSnapshotsRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallInstantSnapshotList	The call object.

NewInstance(ClientBaseConfiguration)

protected override RegionInstantSnapshots.RegionInstantSnapshotsClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name	Description
configuration	ClientBaseClientBaseConfiguration

Returns
Type	Description
RegionInstantSnapshotsRegionInstantSnapshotsClient

Overrides

Grpc.Core.ClientBase<Google.Cloud.Compute.V1.RegionInstantSnapshots.RegionInstantSnapshotsClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)

SetIamPolicy(SetIamPolicyRegionInstantSnapshotRequest, CallOptions)

public virtual Policy SetIamPolicy(SetIamPolicyRegionInstantSnapshotRequest request, CallOptions options)

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

Parameters
Name	Description
request	SetIamPolicyRegionInstantSnapshotRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Policy	The response received from the server.

SetIamPolicy(SetIamPolicyRegionInstantSnapshotRequest, Metadata, DateTime?, CancellationToken)

public virtual Policy SetIamPolicy(SetIamPolicyRegionInstantSnapshotRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name	Description
request	SetIamPolicyRegionInstantSnapshotRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Policy	The response received from the server.

SetIamPolicyAsync(SetIamPolicyRegionInstantSnapshotRequest, CallOptions)

public virtual AsyncUnaryCall<Policy> SetIamPolicyAsync(SetIamPolicyRegionInstantSnapshotRequest request, CallOptions options)

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

Parameters
Name	Description
request	SetIamPolicyRegionInstantSnapshotRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallPolicy	The call object.

SetIamPolicyAsync(SetIamPolicyRegionInstantSnapshotRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Policy> SetIamPolicyAsync(SetIamPolicyRegionInstantSnapshotRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name	Description
request	SetIamPolicyRegionInstantSnapshotRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallPolicy	The call object.

SetLabels(SetLabelsRegionInstantSnapshotRequest, CallOptions)

public virtual Operation SetLabels(SetLabelsRegionInstantSnapshotRequest request, CallOptions options)

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

Parameters
Name	Description
request	SetLabelsRegionInstantSnapshotRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Operation	The response received from the server.

SetLabels(SetLabelsRegionInstantSnapshotRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation SetLabels(SetLabelsRegionInstantSnapshotRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name	Description
request	SetLabelsRegionInstantSnapshotRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Operation	The response received from the server.

SetLabelsAsync(SetLabelsRegionInstantSnapshotRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> SetLabelsAsync(SetLabelsRegionInstantSnapshotRequest request, CallOptions options)

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

Parameters
Name	Description
request	SetLabelsRegionInstantSnapshotRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

SetLabelsAsync(SetLabelsRegionInstantSnapshotRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> SetLabelsAsync(SetLabelsRegionInstantSnapshotRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name	Description
request	SetLabelsRegionInstantSnapshotRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

TestIamPermissions(TestIamPermissionsRegionInstantSnapshotRequest, CallOptions)

public virtual TestPermissionsResponse TestIamPermissions(TestIamPermissionsRegionInstantSnapshotRequest request, CallOptions options)

Returns permissions that a caller has on the specified resource.

Parameters
Name	Description
request	TestIamPermissionsRegionInstantSnapshotRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
TestPermissionsResponse	The response received from the server.

TestIamPermissions(TestIamPermissionsRegionInstantSnapshotRequest, Metadata, DateTime?, CancellationToken)

public virtual TestPermissionsResponse TestIamPermissions(TestIamPermissionsRegionInstantSnapshotRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Returns permissions that a caller has on the specified resource.

Parameters
Name	Description
request	TestIamPermissionsRegionInstantSnapshotRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
TestPermissionsResponse	The response received from the server.

TestIamPermissionsAsync(TestIamPermissionsRegionInstantSnapshotRequest, CallOptions)

public virtual AsyncUnaryCall<TestPermissionsResponse> TestIamPermissionsAsync(TestIamPermissionsRegionInstantSnapshotRequest request, CallOptions options)

Returns permissions that a caller has on the specified resource.

Parameters
Name	Description
request	TestIamPermissionsRegionInstantSnapshotRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallTestPermissionsResponse	The call object.

TestIamPermissionsAsync(TestIamPermissionsRegionInstantSnapshotRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<TestPermissionsResponse> TestIamPermissionsAsync(TestIamPermissionsRegionInstantSnapshotRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Returns permissions that a caller has on the specified resource.

Parameters
Name	Description
request	TestIamPermissionsRegionInstantSnapshotRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallTestPermissionsResponse	The call object.