Compute Engine v1 API - Class Instances.InstancesClient (2.4.0)

public class InstancesClient : ClientBase<Instances.InstancesClient>

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

Client for Instances

Inheritance

Object > ClientBase > ClientBase<Instances.InstancesClient> > Instances.InstancesClient

Namespace

Google.Cloud.Compute.V1

Assembly

Google.Cloud.Compute.V1.dll

Constructors

InstancesClient()

protected InstancesClient()

Protected parameterless constructor to allow creation of test doubles.

InstancesClient(CallInvoker)

public InstancesClient(CallInvoker callInvoker)

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

Parameter
NameDescription
callInvokerCallInvoker

The callInvoker to use to make remote calls.

InstancesClient(ChannelBase)

public InstancesClient(ChannelBase channel)

Creates a new client for Instances

Parameter
NameDescription
channelChannelBase

The channel to use to make remote calls.

InstancesClient(ClientBase.ClientBaseConfiguration)

protected InstancesClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
NameDescription
configurationClientBase.ClientBaseConfiguration

The client configuration.

Methods

AddAccessConfig(AddAccessConfigInstanceRequest, CallOptions)

public virtual Operation AddAccessConfig(AddAccessConfigInstanceRequest request, CallOptions options)

Adds an access config to an instance's network interface.

Parameters
NameDescription
requestAddAccessConfigInstanceRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

AddAccessConfig(AddAccessConfigInstanceRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Adds an access config to an instance's network interface.

Parameters
NameDescription
requestAddAccessConfigInstanceRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

AddAccessConfigAsync(AddAccessConfigInstanceRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> AddAccessConfigAsync(AddAccessConfigInstanceRequest request, CallOptions options)

Adds an access config to an instance's network interface.

Parameters
NameDescription
requestAddAccessConfigInstanceRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

AddAccessConfigAsync(AddAccessConfigInstanceRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Adds an access config to an instance's network interface.

Parameters
NameDescription
requestAddAccessConfigInstanceRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

AddResourcePolicies(AddResourcePoliciesInstanceRequest, CallOptions)

public virtual Operation AddResourcePolicies(AddResourcePoliciesInstanceRequest request, CallOptions options)

Adds existing resource policies to an instance. You can only add one policy right now which will be applied to this instance for scheduling live migrations.

Parameters
NameDescription
requestAddResourcePoliciesInstanceRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

AddResourcePolicies(AddResourcePoliciesInstanceRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Adds existing resource policies to an instance. You can only add one policy right now which will be applied to this instance for scheduling live migrations.

Parameters
NameDescription
requestAddResourcePoliciesInstanceRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

AddResourcePoliciesAsync(AddResourcePoliciesInstanceRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> AddResourcePoliciesAsync(AddResourcePoliciesInstanceRequest request, CallOptions options)

Adds existing resource policies to an instance. You can only add one policy right now which will be applied to this instance for scheduling live migrations.

Parameters
NameDescription
requestAddResourcePoliciesInstanceRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

AddResourcePoliciesAsync(AddResourcePoliciesInstanceRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Adds existing resource policies to an instance. You can only add one policy right now which will be applied to this instance for scheduling live migrations.

Parameters
NameDescription
requestAddResourcePoliciesInstanceRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

AggregatedList(AggregatedListInstancesRequest, CallOptions)

public virtual InstanceAggregatedList AggregatedList(AggregatedListInstancesRequest request, CallOptions options)

Retrieves an aggregated list of all of the instances in your project across all regions and zones. The performance of this method degrades when a filter is specified on a project that has a very large number of instances.

Parameters
NameDescription
requestAggregatedListInstancesRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
InstanceAggregatedList

The response received from the server.

AggregatedList(AggregatedListInstancesRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual InstanceAggregatedList AggregatedList(AggregatedListInstancesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Retrieves an aggregated list of all of the instances in your project across all regions and zones. The performance of this method degrades when a filter is specified on a project that has a very large number of instances.

Parameters
NameDescription
requestAggregatedListInstancesRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
InstanceAggregatedList

The response received from the server.

AggregatedListAsync(AggregatedListInstancesRequest, CallOptions)

public virtual AsyncUnaryCall<InstanceAggregatedList> AggregatedListAsync(AggregatedListInstancesRequest request, CallOptions options)

Retrieves an aggregated list of all of the instances in your project across all regions and zones. The performance of this method degrades when a filter is specified on a project that has a very large number of instances.

Parameters
NameDescription
requestAggregatedListInstancesRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<InstanceAggregatedList>

The call object.

AggregatedListAsync(AggregatedListInstancesRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<InstanceAggregatedList> AggregatedListAsync(AggregatedListInstancesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Retrieves an aggregated list of all of the instances in your project across all regions and zones. The performance of this method degrades when a filter is specified on a project that has a very large number of instances.

Parameters
NameDescription
requestAggregatedListInstancesRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<InstanceAggregatedList>

The call object.

AttachDisk(AttachDiskInstanceRequest, CallOptions)

public virtual Operation AttachDisk(AttachDiskInstanceRequest request, CallOptions options)

Attaches an existing Disk resource to an instance. You must first create the disk before you can attach it. It is not possible to create and attach a disk at the same time. For more information, read Adding a persistent disk to your instance.

Parameters
NameDescription
requestAttachDiskInstanceRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

AttachDisk(AttachDiskInstanceRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Attaches an existing Disk resource to an instance. You must first create the disk before you can attach it. It is not possible to create and attach a disk at the same time. For more information, read Adding a persistent disk to your instance.

Parameters
NameDescription
requestAttachDiskInstanceRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

AttachDiskAsync(AttachDiskInstanceRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> AttachDiskAsync(AttachDiskInstanceRequest request, CallOptions options)

Attaches an existing Disk resource to an instance. You must first create the disk before you can attach it. It is not possible to create and attach a disk at the same time. For more information, read Adding a persistent disk to your instance.

Parameters
NameDescription
requestAttachDiskInstanceRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

AttachDiskAsync(AttachDiskInstanceRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Attaches an existing Disk resource to an instance. You must first create the disk before you can attach it. It is not possible to create and attach a disk at the same time. For more information, read Adding a persistent disk to your instance.

Parameters
NameDescription
requestAttachDiskInstanceRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

BulkInsert(BulkInsertInstanceRequest, CallOptions)

public virtual Operation BulkInsert(BulkInsertInstanceRequest request, CallOptions options)

Creates multiple instances. Count specifies the number of instances to create. For more information, see About bulk creation of VMs.

Parameters
NameDescription
requestBulkInsertInstanceRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

BulkInsert(BulkInsertInstanceRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Creates multiple instances. Count specifies the number of instances to create. For more information, see About bulk creation of VMs.

Parameters
NameDescription
requestBulkInsertInstanceRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

BulkInsertAsync(BulkInsertInstanceRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> BulkInsertAsync(BulkInsertInstanceRequest request, CallOptions options)

Creates multiple instances. Count specifies the number of instances to create. For more information, see About bulk creation of VMs.

Parameters
NameDescription
requestBulkInsertInstanceRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

BulkInsertAsync(BulkInsertInstanceRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Creates multiple instances. Count specifies the number of instances to create. For more information, see About bulk creation of VMs.

Parameters
NameDescription
requestBulkInsertInstanceRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

CreateOperationsClientForZoneOperations()

public virtual Operations.OperationsClient CreateOperationsClientForZoneOperations()

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

Returns
TypeDescription
Operations.OperationsClient

A new Operations client for the same target as this client.

Delete(DeleteInstanceRequest, CallOptions)

public virtual Operation Delete(DeleteInstanceRequest request, CallOptions options)

Deletes the specified Instance resource. For more information, see Deleting an instance.

Parameters
NameDescription
requestDeleteInstanceRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

Delete(DeleteInstanceRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Deletes the specified Instance resource. For more information, see Deleting an instance.

Parameters
NameDescription
requestDeleteInstanceRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

DeleteAccessConfig(DeleteAccessConfigInstanceRequest, CallOptions)

public virtual Operation DeleteAccessConfig(DeleteAccessConfigInstanceRequest request, CallOptions options)

Deletes an access config from an instance's network interface.

Parameters
NameDescription
requestDeleteAccessConfigInstanceRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

DeleteAccessConfig(DeleteAccessConfigInstanceRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Deletes an access config from an instance's network interface.

Parameters
NameDescription
requestDeleteAccessConfigInstanceRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

DeleteAccessConfigAsync(DeleteAccessConfigInstanceRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> DeleteAccessConfigAsync(DeleteAccessConfigInstanceRequest request, CallOptions options)

Deletes an access config from an instance's network interface.

Parameters
NameDescription
requestDeleteAccessConfigInstanceRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

DeleteAccessConfigAsync(DeleteAccessConfigInstanceRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Deletes an access config from an instance's network interface.

Parameters
NameDescription
requestDeleteAccessConfigInstanceRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

DeleteAsync(DeleteInstanceRequest, CallOptions)

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

Deletes the specified Instance resource. For more information, see Deleting an instance.

Parameters
NameDescription
requestDeleteInstanceRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

DeleteAsync(DeleteInstanceRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Deletes the specified Instance resource. For more information, see Deleting an instance.

Parameters
NameDescription
requestDeleteInstanceRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

DetachDisk(DetachDiskInstanceRequest, CallOptions)

public virtual Operation DetachDisk(DetachDiskInstanceRequest request, CallOptions options)

Detaches a disk from an instance.

Parameters
NameDescription
requestDetachDiskInstanceRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

DetachDisk(DetachDiskInstanceRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Detaches a disk from an instance.

Parameters
NameDescription
requestDetachDiskInstanceRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

DetachDiskAsync(DetachDiskInstanceRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> DetachDiskAsync(DetachDiskInstanceRequest request, CallOptions options)

Detaches a disk from an instance.

Parameters
NameDescription
requestDetachDiskInstanceRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

DetachDiskAsync(DetachDiskInstanceRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Detaches a disk from an instance.

Parameters
NameDescription
requestDetachDiskInstanceRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

Get(GetInstanceRequest, CallOptions)

public virtual Instance Get(GetInstanceRequest request, CallOptions options)

Returns the specified Instance resource. Gets a list of available instances by making a list() request.

Parameters
NameDescription
requestGetInstanceRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Instance

The response received from the server.

Get(GetInstanceRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Returns the specified Instance resource. Gets a list of available instances by making a list() request.

Parameters
NameDescription
requestGetInstanceRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Instance

The response received from the server.

GetAsync(GetInstanceRequest, CallOptions)

public virtual AsyncUnaryCall<Instance> GetAsync(GetInstanceRequest request, CallOptions options)

Returns the specified Instance resource. Gets a list of available instances by making a list() request.

Parameters
NameDescription
requestGetInstanceRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Instance>

The call object.

GetAsync(GetInstanceRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Returns the specified Instance resource. Gets a list of available instances by making a list() request.

Parameters
NameDescription
requestGetInstanceRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Instance>

The call object.

GetEffectiveFirewalls(GetEffectiveFirewallsInstanceRequest, CallOptions)

public virtual InstancesGetEffectiveFirewallsResponse GetEffectiveFirewalls(GetEffectiveFirewallsInstanceRequest request, CallOptions options)

Returns effective firewalls applied to an interface of the instance.

Parameters
NameDescription
requestGetEffectiveFirewallsInstanceRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
InstancesGetEffectiveFirewallsResponse

The response received from the server.

GetEffectiveFirewalls(GetEffectiveFirewallsInstanceRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual InstancesGetEffectiveFirewallsResponse GetEffectiveFirewalls(GetEffectiveFirewallsInstanceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Returns effective firewalls applied to an interface of the instance.

Parameters
NameDescription
requestGetEffectiveFirewallsInstanceRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
InstancesGetEffectiveFirewallsResponse

The response received from the server.

GetEffectiveFirewallsAsync(GetEffectiveFirewallsInstanceRequest, CallOptions)

public virtual AsyncUnaryCall<InstancesGetEffectiveFirewallsResponse> GetEffectiveFirewallsAsync(GetEffectiveFirewallsInstanceRequest request, CallOptions options)

Returns effective firewalls applied to an interface of the instance.

Parameters
NameDescription
requestGetEffectiveFirewallsInstanceRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<InstancesGetEffectiveFirewallsResponse>

The call object.

GetEffectiveFirewallsAsync(GetEffectiveFirewallsInstanceRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<InstancesGetEffectiveFirewallsResponse> GetEffectiveFirewallsAsync(GetEffectiveFirewallsInstanceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Returns effective firewalls applied to an interface of the instance.

Parameters
NameDescription
requestGetEffectiveFirewallsInstanceRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<InstancesGetEffectiveFirewallsResponse>

The call object.

GetGuestAttributes(GetGuestAttributesInstanceRequest, CallOptions)

public virtual GuestAttributes GetGuestAttributes(GetGuestAttributesInstanceRequest request, CallOptions options)

Returns the specified guest attributes entry.

Parameters
NameDescription
requestGetGuestAttributesInstanceRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
GuestAttributes

The response received from the server.

GetGuestAttributes(GetGuestAttributesInstanceRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual GuestAttributes GetGuestAttributes(GetGuestAttributesInstanceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Returns the specified guest attributes entry.

Parameters
NameDescription
requestGetGuestAttributesInstanceRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
GuestAttributes

The response received from the server.

GetGuestAttributesAsync(GetGuestAttributesInstanceRequest, CallOptions)

public virtual AsyncUnaryCall<GuestAttributes> GetGuestAttributesAsync(GetGuestAttributesInstanceRequest request, CallOptions options)

Returns the specified guest attributes entry.

Parameters
NameDescription
requestGetGuestAttributesInstanceRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<GuestAttributes>

The call object.

GetGuestAttributesAsync(GetGuestAttributesInstanceRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<GuestAttributes> GetGuestAttributesAsync(GetGuestAttributesInstanceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Returns the specified guest attributes entry.

Parameters
NameDescription
requestGetGuestAttributesInstanceRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<GuestAttributes>

The call object.

GetIamPolicy(GetIamPolicyInstanceRequest, CallOptions)

public virtual Policy GetIamPolicy(GetIamPolicyInstanceRequest request, CallOptions options)

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

Parameters
NameDescription
requestGetIamPolicyInstanceRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Policy

The response received from the server.

GetIamPolicy(GetIamPolicyInstanceRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

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

Parameters
NameDescription
requestGetIamPolicyInstanceRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Policy

The response received from the server.

GetIamPolicyAsync(GetIamPolicyInstanceRequest, CallOptions)

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

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

Parameters
NameDescription
requestGetIamPolicyInstanceRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Policy>

The call object.

GetIamPolicyAsync(GetIamPolicyInstanceRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

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

Parameters
NameDescription
requestGetIamPolicyInstanceRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Policy>

The call object.

GetScreenshot(GetScreenshotInstanceRequest, CallOptions)

public virtual Screenshot GetScreenshot(GetScreenshotInstanceRequest request, CallOptions options)

Returns the screenshot from the specified instance.

Parameters
NameDescription
requestGetScreenshotInstanceRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Screenshot

The response received from the server.

GetScreenshot(GetScreenshotInstanceRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Screenshot GetScreenshot(GetScreenshotInstanceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Returns the screenshot from the specified instance.

Parameters
NameDescription
requestGetScreenshotInstanceRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Screenshot

The response received from the server.

GetScreenshotAsync(GetScreenshotInstanceRequest, CallOptions)

public virtual AsyncUnaryCall<Screenshot> GetScreenshotAsync(GetScreenshotInstanceRequest request, CallOptions options)

Returns the screenshot from the specified instance.

Parameters
NameDescription
requestGetScreenshotInstanceRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Screenshot>

The call object.

GetScreenshotAsync(GetScreenshotInstanceRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Screenshot> GetScreenshotAsync(GetScreenshotInstanceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Returns the screenshot from the specified instance.

Parameters
NameDescription
requestGetScreenshotInstanceRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Screenshot>

The call object.

GetSerialPortOutput(GetSerialPortOutputInstanceRequest, CallOptions)

public virtual SerialPortOutput GetSerialPortOutput(GetSerialPortOutputInstanceRequest request, CallOptions options)

Returns the last 1 MB of serial port output from the specified instance.

Parameters
NameDescription
requestGetSerialPortOutputInstanceRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
SerialPortOutput

The response received from the server.

GetSerialPortOutput(GetSerialPortOutputInstanceRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual SerialPortOutput GetSerialPortOutput(GetSerialPortOutputInstanceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Returns the last 1 MB of serial port output from the specified instance.

Parameters
NameDescription
requestGetSerialPortOutputInstanceRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
SerialPortOutput

The response received from the server.

GetSerialPortOutputAsync(GetSerialPortOutputInstanceRequest, CallOptions)

public virtual AsyncUnaryCall<SerialPortOutput> GetSerialPortOutputAsync(GetSerialPortOutputInstanceRequest request, CallOptions options)

Returns the last 1 MB of serial port output from the specified instance.

Parameters
NameDescription
requestGetSerialPortOutputInstanceRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<SerialPortOutput>

The call object.

GetSerialPortOutputAsync(GetSerialPortOutputInstanceRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<SerialPortOutput> GetSerialPortOutputAsync(GetSerialPortOutputInstanceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Returns the last 1 MB of serial port output from the specified instance.

Parameters
NameDescription
requestGetSerialPortOutputInstanceRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<SerialPortOutput>

The call object.

GetShieldedInstanceIdentity(GetShieldedInstanceIdentityInstanceRequest, CallOptions)

public virtual ShieldedInstanceIdentity GetShieldedInstanceIdentity(GetShieldedInstanceIdentityInstanceRequest request, CallOptions options)

Returns the Shielded Instance Identity of an instance

Parameters
NameDescription
requestGetShieldedInstanceIdentityInstanceRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
ShieldedInstanceIdentity

The response received from the server.

GetShieldedInstanceIdentity(GetShieldedInstanceIdentityInstanceRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual ShieldedInstanceIdentity GetShieldedInstanceIdentity(GetShieldedInstanceIdentityInstanceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Returns the Shielded Instance Identity of an instance

Parameters
NameDescription
requestGetShieldedInstanceIdentityInstanceRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
ShieldedInstanceIdentity

The response received from the server.

GetShieldedInstanceIdentityAsync(GetShieldedInstanceIdentityInstanceRequest, CallOptions)

public virtual AsyncUnaryCall<ShieldedInstanceIdentity> GetShieldedInstanceIdentityAsync(GetShieldedInstanceIdentityInstanceRequest request, CallOptions options)

Returns the Shielded Instance Identity of an instance

Parameters
NameDescription
requestGetShieldedInstanceIdentityInstanceRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<ShieldedInstanceIdentity>

The call object.

GetShieldedInstanceIdentityAsync(GetShieldedInstanceIdentityInstanceRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<ShieldedInstanceIdentity> GetShieldedInstanceIdentityAsync(GetShieldedInstanceIdentityInstanceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Returns the Shielded Instance Identity of an instance

Parameters
NameDescription
requestGetShieldedInstanceIdentityInstanceRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<ShieldedInstanceIdentity>

The call object.

Insert(InsertInstanceRequest, CallOptions)

public virtual Operation Insert(InsertInstanceRequest request, CallOptions options)

Creates an instance resource in the specified project using the data included in the request.

Parameters
NameDescription
requestInsertInstanceRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

Insert(InsertInstanceRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Creates an instance resource in the specified project using the data included in the request.

Parameters
NameDescription
requestInsertInstanceRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

InsertAsync(InsertInstanceRequest, CallOptions)

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

Creates an instance resource in the specified project using the data included in the request.

Parameters
NameDescription
requestInsertInstanceRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

InsertAsync(InsertInstanceRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Creates an instance resource in the specified project using the data included in the request.

Parameters
NameDescription
requestInsertInstanceRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

List(ListInstancesRequest, CallOptions)

public virtual InstanceList List(ListInstancesRequest request, CallOptions options)

Retrieves the list of instances contained within the specified zone.

Parameters
NameDescription
requestListInstancesRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
InstanceList

The response received from the server.

List(ListInstancesRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Retrieves the list of instances contained within the specified zone.

Parameters
NameDescription
requestListInstancesRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
InstanceList

The response received from the server.

ListAsync(ListInstancesRequest, CallOptions)

public virtual AsyncUnaryCall<InstanceList> ListAsync(ListInstancesRequest request, CallOptions options)

Retrieves the list of instances contained within the specified zone.

Parameters
NameDescription
requestListInstancesRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<InstanceList>

The call object.

ListAsync(ListInstancesRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Retrieves the list of instances contained within the specified zone.

Parameters
NameDescription
requestListInstancesRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<InstanceList>

The call object.

ListReferrers(ListReferrersInstancesRequest, CallOptions)

public virtual InstanceListReferrers ListReferrers(ListReferrersInstancesRequest request, CallOptions options)

Retrieves a list of resources that refer to the VM instance specified in the request. For example, if the VM instance is part of a managed or unmanaged instance group, the referrers list includes the instance group. For more information, read Viewing referrers to VM instances.

Parameters
NameDescription
requestListReferrersInstancesRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
InstanceListReferrers

The response received from the server.

ListReferrers(ListReferrersInstancesRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual InstanceListReferrers ListReferrers(ListReferrersInstancesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Retrieves a list of resources that refer to the VM instance specified in the request. For example, if the VM instance is part of a managed or unmanaged instance group, the referrers list includes the instance group. For more information, read Viewing referrers to VM instances.

Parameters
NameDescription
requestListReferrersInstancesRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
InstanceListReferrers

The response received from the server.

ListReferrersAsync(ListReferrersInstancesRequest, CallOptions)

public virtual AsyncUnaryCall<InstanceListReferrers> ListReferrersAsync(ListReferrersInstancesRequest request, CallOptions options)

Retrieves a list of resources that refer to the VM instance specified in the request. For example, if the VM instance is part of a managed or unmanaged instance group, the referrers list includes the instance group. For more information, read Viewing referrers to VM instances.

Parameters
NameDescription
requestListReferrersInstancesRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<InstanceListReferrers>

The call object.

ListReferrersAsync(ListReferrersInstancesRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<InstanceListReferrers> ListReferrersAsync(ListReferrersInstancesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Retrieves a list of resources that refer to the VM instance specified in the request. For example, if the VM instance is part of a managed or unmanaged instance group, the referrers list includes the instance group. For more information, read Viewing referrers to VM instances.

Parameters
NameDescription
requestListReferrersInstancesRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<InstanceListReferrers>

The call object.

NewInstance(ClientBase.ClientBaseConfiguration)

protected override Instances.InstancesClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
NameDescription
configurationClientBase.ClientBaseConfiguration
Returns
TypeDescription
Instances.InstancesClient
Overrides
Grpc.Core.ClientBase<Google.Cloud.Compute.V1.Instances.InstancesClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)

RemoveResourcePolicies(RemoveResourcePoliciesInstanceRequest, CallOptions)

public virtual Operation RemoveResourcePolicies(RemoveResourcePoliciesInstanceRequest request, CallOptions options)

Removes resource policies from an instance.

Parameters
NameDescription
requestRemoveResourcePoliciesInstanceRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

RemoveResourcePolicies(RemoveResourcePoliciesInstanceRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Removes resource policies from an instance.

Parameters
NameDescription
requestRemoveResourcePoliciesInstanceRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

RemoveResourcePoliciesAsync(RemoveResourcePoliciesInstanceRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> RemoveResourcePoliciesAsync(RemoveResourcePoliciesInstanceRequest request, CallOptions options)

Removes resource policies from an instance.

Parameters
NameDescription
requestRemoveResourcePoliciesInstanceRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

RemoveResourcePoliciesAsync(RemoveResourcePoliciesInstanceRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Removes resource policies from an instance.

Parameters
NameDescription
requestRemoveResourcePoliciesInstanceRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

Reset(ResetInstanceRequest, CallOptions)

public virtual Operation Reset(ResetInstanceRequest request, CallOptions options)

Performs a reset on the instance. This is a hard reset. The VM does not do a graceful shutdown. For more information, see Resetting an instance.

Parameters
NameDescription
requestResetInstanceRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

Reset(ResetInstanceRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Performs a reset on the instance. This is a hard reset. The VM does not do a graceful shutdown. For more information, see Resetting an instance.

Parameters
NameDescription
requestResetInstanceRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

ResetAsync(ResetInstanceRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> ResetAsync(ResetInstanceRequest request, CallOptions options)

Performs a reset on the instance. This is a hard reset. The VM does not do a graceful shutdown. For more information, see Resetting an instance.

Parameters
NameDescription
requestResetInstanceRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

ResetAsync(ResetInstanceRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Performs a reset on the instance. This is a hard reset. The VM does not do a graceful shutdown. For more information, see Resetting an instance.

Parameters
NameDescription
requestResetInstanceRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

Resume(ResumeInstanceRequest, CallOptions)

public virtual Operation Resume(ResumeInstanceRequest request, CallOptions options)

Resumes an instance that was suspended using the instances().suspend method.

Parameters
NameDescription
requestResumeInstanceRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

Resume(ResumeInstanceRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Resumes an instance that was suspended using the instances().suspend method.

Parameters
NameDescription
requestResumeInstanceRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

ResumeAsync(ResumeInstanceRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> ResumeAsync(ResumeInstanceRequest request, CallOptions options)

Resumes an instance that was suspended using the instances().suspend method.

Parameters
NameDescription
requestResumeInstanceRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

ResumeAsync(ResumeInstanceRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Resumes an instance that was suspended using the instances().suspend method.

Parameters
NameDescription
requestResumeInstanceRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

SendDiagnosticInterrupt(SendDiagnosticInterruptInstanceRequest, CallOptions)

public virtual SendDiagnosticInterruptInstanceResponse SendDiagnosticInterrupt(SendDiagnosticInterruptInstanceRequest request, CallOptions options)

Sends diagnostic interrupt to the instance.

Parameters
NameDescription
requestSendDiagnosticInterruptInstanceRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
SendDiagnosticInterruptInstanceResponse

The response received from the server.

SendDiagnosticInterrupt(SendDiagnosticInterruptInstanceRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual SendDiagnosticInterruptInstanceResponse SendDiagnosticInterrupt(SendDiagnosticInterruptInstanceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Sends diagnostic interrupt to the instance.

Parameters
NameDescription
requestSendDiagnosticInterruptInstanceRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
SendDiagnosticInterruptInstanceResponse

The response received from the server.

SendDiagnosticInterruptAsync(SendDiagnosticInterruptInstanceRequest, CallOptions)

public virtual AsyncUnaryCall<SendDiagnosticInterruptInstanceResponse> SendDiagnosticInterruptAsync(SendDiagnosticInterruptInstanceRequest request, CallOptions options)

Sends diagnostic interrupt to the instance.

Parameters
NameDescription
requestSendDiagnosticInterruptInstanceRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<SendDiagnosticInterruptInstanceResponse>

The call object.

SendDiagnosticInterruptAsync(SendDiagnosticInterruptInstanceRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<SendDiagnosticInterruptInstanceResponse> SendDiagnosticInterruptAsync(SendDiagnosticInterruptInstanceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Sends diagnostic interrupt to the instance.

Parameters
NameDescription
requestSendDiagnosticInterruptInstanceRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<SendDiagnosticInterruptInstanceResponse>

The call object.

SetDeletionProtection(SetDeletionProtectionInstanceRequest, CallOptions)

public virtual Operation SetDeletionProtection(SetDeletionProtectionInstanceRequest request, CallOptions options)

Sets deletion protection on the instance.

Parameters
NameDescription
requestSetDeletionProtectionInstanceRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

SetDeletionProtection(SetDeletionProtectionInstanceRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Sets deletion protection on the instance.

Parameters
NameDescription
requestSetDeletionProtectionInstanceRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

SetDeletionProtectionAsync(SetDeletionProtectionInstanceRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> SetDeletionProtectionAsync(SetDeletionProtectionInstanceRequest request, CallOptions options)

Sets deletion protection on the instance.

Parameters
NameDescription
requestSetDeletionProtectionInstanceRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

SetDeletionProtectionAsync(SetDeletionProtectionInstanceRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Sets deletion protection on the instance.

Parameters
NameDescription
requestSetDeletionProtectionInstanceRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

SetDiskAutoDelete(SetDiskAutoDeleteInstanceRequest, CallOptions)

public virtual Operation SetDiskAutoDelete(SetDiskAutoDeleteInstanceRequest request, CallOptions options)

Sets the auto-delete flag for a disk attached to an instance.

Parameters
NameDescription
requestSetDiskAutoDeleteInstanceRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

SetDiskAutoDelete(SetDiskAutoDeleteInstanceRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Sets the auto-delete flag for a disk attached to an instance.

Parameters
NameDescription
requestSetDiskAutoDeleteInstanceRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

SetDiskAutoDeleteAsync(SetDiskAutoDeleteInstanceRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> SetDiskAutoDeleteAsync(SetDiskAutoDeleteInstanceRequest request, CallOptions options)

Sets the auto-delete flag for a disk attached to an instance.

Parameters
NameDescription
requestSetDiskAutoDeleteInstanceRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

SetDiskAutoDeleteAsync(SetDiskAutoDeleteInstanceRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Sets the auto-delete flag for a disk attached to an instance.

Parameters
NameDescription
requestSetDiskAutoDeleteInstanceRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

SetIamPolicy(SetIamPolicyInstanceRequest, CallOptions)

public virtual Policy SetIamPolicy(SetIamPolicyInstanceRequest request, CallOptions options)

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

Parameters
NameDescription
requestSetIamPolicyInstanceRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Policy

The response received from the server.

SetIamPolicy(SetIamPolicyInstanceRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

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

Parameters
NameDescription
requestSetIamPolicyInstanceRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Policy

The response received from the server.

SetIamPolicyAsync(SetIamPolicyInstanceRequest, CallOptions)

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

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

Parameters
NameDescription
requestSetIamPolicyInstanceRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Policy>

The call object.

SetIamPolicyAsync(SetIamPolicyInstanceRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

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

Parameters
NameDescription
requestSetIamPolicyInstanceRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Policy>

The call object.

SetLabels(SetLabelsInstanceRequest, CallOptions)

public virtual Operation SetLabels(SetLabelsInstanceRequest request, CallOptions options)

Sets labels on an instance. To learn more about labels, read the Labeling Resources documentation.

Parameters
NameDescription
requestSetLabelsInstanceRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

SetLabels(SetLabelsInstanceRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Sets labels on an instance. To learn more about labels, read the Labeling Resources documentation.

Parameters
NameDescription
requestSetLabelsInstanceRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

SetLabelsAsync(SetLabelsInstanceRequest, CallOptions)

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

Sets labels on an instance. To learn more about labels, read the Labeling Resources documentation.

Parameters
NameDescription
requestSetLabelsInstanceRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

SetLabelsAsync(SetLabelsInstanceRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Sets labels on an instance. To learn more about labels, read the Labeling Resources documentation.

Parameters
NameDescription
requestSetLabelsInstanceRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

SetMachineResources(SetMachineResourcesInstanceRequest, CallOptions)

public virtual Operation SetMachineResources(SetMachineResourcesInstanceRequest request, CallOptions options)

Changes the number and/or type of accelerator for a stopped instance to the values specified in the request.

Parameters
NameDescription
requestSetMachineResourcesInstanceRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

SetMachineResources(SetMachineResourcesInstanceRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Changes the number and/or type of accelerator for a stopped instance to the values specified in the request.

Parameters
NameDescription
requestSetMachineResourcesInstanceRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

SetMachineResourcesAsync(SetMachineResourcesInstanceRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> SetMachineResourcesAsync(SetMachineResourcesInstanceRequest request, CallOptions options)

Changes the number and/or type of accelerator for a stopped instance to the values specified in the request.

Parameters
NameDescription
requestSetMachineResourcesInstanceRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

SetMachineResourcesAsync(SetMachineResourcesInstanceRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Changes the number and/or type of accelerator for a stopped instance to the values specified in the request.

Parameters
NameDescription
requestSetMachineResourcesInstanceRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

SetMachineType(SetMachineTypeInstanceRequest, CallOptions)

public virtual Operation SetMachineType(SetMachineTypeInstanceRequest request, CallOptions options)

Changes the machine type for a stopped instance to the machine type specified in the request.

Parameters
NameDescription
requestSetMachineTypeInstanceRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

SetMachineType(SetMachineTypeInstanceRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Changes the machine type for a stopped instance to the machine type specified in the request.

Parameters
NameDescription
requestSetMachineTypeInstanceRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

SetMachineTypeAsync(SetMachineTypeInstanceRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> SetMachineTypeAsync(SetMachineTypeInstanceRequest request, CallOptions options)

Changes the machine type for a stopped instance to the machine type specified in the request.

Parameters
NameDescription
requestSetMachineTypeInstanceRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

SetMachineTypeAsync(SetMachineTypeInstanceRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Changes the machine type for a stopped instance to the machine type specified in the request.

Parameters
NameDescription
requestSetMachineTypeInstanceRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

SetMetadata(SetMetadataInstanceRequest, CallOptions)

public virtual Operation SetMetadata(SetMetadataInstanceRequest request, CallOptions options)

Sets metadata for the specified instance to the data included in the request.

Parameters
NameDescription
requestSetMetadataInstanceRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

SetMetadata(SetMetadataInstanceRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Sets metadata for the specified instance to the data included in the request.

Parameters
NameDescription
requestSetMetadataInstanceRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

SetMetadataAsync(SetMetadataInstanceRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> SetMetadataAsync(SetMetadataInstanceRequest request, CallOptions options)

Sets metadata for the specified instance to the data included in the request.

Parameters
NameDescription
requestSetMetadataInstanceRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

SetMetadataAsync(SetMetadataInstanceRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Sets metadata for the specified instance to the data included in the request.

Parameters
NameDescription
requestSetMetadataInstanceRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

SetMinCpuPlatform(SetMinCpuPlatformInstanceRequest, CallOptions)

public virtual Operation SetMinCpuPlatform(SetMinCpuPlatformInstanceRequest request, CallOptions options)

Changes the minimum CPU platform that this instance should use. This method can only be called on a stopped instance. For more information, read Specifying a Minimum CPU Platform.

Parameters
NameDescription
requestSetMinCpuPlatformInstanceRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

SetMinCpuPlatform(SetMinCpuPlatformInstanceRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Changes the minimum CPU platform that this instance should use. This method can only be called on a stopped instance. For more information, read Specifying a Minimum CPU Platform.

Parameters
NameDescription
requestSetMinCpuPlatformInstanceRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

SetMinCpuPlatformAsync(SetMinCpuPlatformInstanceRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> SetMinCpuPlatformAsync(SetMinCpuPlatformInstanceRequest request, CallOptions options)

Changes the minimum CPU platform that this instance should use. This method can only be called on a stopped instance. For more information, read Specifying a Minimum CPU Platform.

Parameters
NameDescription
requestSetMinCpuPlatformInstanceRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

SetMinCpuPlatformAsync(SetMinCpuPlatformInstanceRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Changes the minimum CPU platform that this instance should use. This method can only be called on a stopped instance. For more information, read Specifying a Minimum CPU Platform.

Parameters
NameDescription
requestSetMinCpuPlatformInstanceRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

SetScheduling(SetSchedulingInstanceRequest, CallOptions)

public virtual Operation SetScheduling(SetSchedulingInstanceRequest request, CallOptions options)

Sets an instance's scheduling options. You can only call this method on a stopped instance, that is, a VM instance that is in a TERMINATED state. See Instance Life Cycle for more information on the possible instance states. For more information about setting scheduling options for a VM, see Set VM host maintenance policy.

Parameters
NameDescription
requestSetSchedulingInstanceRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

SetScheduling(SetSchedulingInstanceRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Sets an instance's scheduling options. You can only call this method on a stopped instance, that is, a VM instance that is in a TERMINATED state. See Instance Life Cycle for more information on the possible instance states. For more information about setting scheduling options for a VM, see Set VM host maintenance policy.

Parameters
NameDescription
requestSetSchedulingInstanceRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

SetSchedulingAsync(SetSchedulingInstanceRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> SetSchedulingAsync(SetSchedulingInstanceRequest request, CallOptions options)

Sets an instance's scheduling options. You can only call this method on a stopped instance, that is, a VM instance that is in a TERMINATED state. See Instance Life Cycle for more information on the possible instance states. For more information about setting scheduling options for a VM, see Set VM host maintenance policy.

Parameters
NameDescription
requestSetSchedulingInstanceRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

SetSchedulingAsync(SetSchedulingInstanceRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Sets an instance's scheduling options. You can only call this method on a stopped instance, that is, a VM instance that is in a TERMINATED state. See Instance Life Cycle for more information on the possible instance states. For more information about setting scheduling options for a VM, see Set VM host maintenance policy.

Parameters
NameDescription
requestSetSchedulingInstanceRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

SetServiceAccount(SetServiceAccountInstanceRequest, CallOptions)

public virtual Operation SetServiceAccount(SetServiceAccountInstanceRequest request, CallOptions options)

Sets the service account on the instance. For more information, read Changing the service account and access scopes for an instance.

Parameters
NameDescription
requestSetServiceAccountInstanceRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

SetServiceAccount(SetServiceAccountInstanceRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Sets the service account on the instance. For more information, read Changing the service account and access scopes for an instance.

Parameters
NameDescription
requestSetServiceAccountInstanceRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

SetServiceAccountAsync(SetServiceAccountInstanceRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> SetServiceAccountAsync(SetServiceAccountInstanceRequest request, CallOptions options)

Sets the service account on the instance. For more information, read Changing the service account and access scopes for an instance.

Parameters
NameDescription
requestSetServiceAccountInstanceRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

SetServiceAccountAsync(SetServiceAccountInstanceRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Sets the service account on the instance. For more information, read Changing the service account and access scopes for an instance.

Parameters
NameDescription
requestSetServiceAccountInstanceRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

SetShieldedInstanceIntegrityPolicy(SetShieldedInstanceIntegrityPolicyInstanceRequest, CallOptions)

public virtual Operation SetShieldedInstanceIntegrityPolicy(SetShieldedInstanceIntegrityPolicyInstanceRequest request, CallOptions options)

Sets the Shielded Instance integrity policy for an instance. You can only use this method on a running instance. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.

Parameters
NameDescription
requestSetShieldedInstanceIntegrityPolicyInstanceRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

SetShieldedInstanceIntegrityPolicy(SetShieldedInstanceIntegrityPolicyInstanceRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Sets the Shielded Instance integrity policy for an instance. You can only use this method on a running instance. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.

Parameters
NameDescription
requestSetShieldedInstanceIntegrityPolicyInstanceRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

SetShieldedInstanceIntegrityPolicyAsync(SetShieldedInstanceIntegrityPolicyInstanceRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> SetShieldedInstanceIntegrityPolicyAsync(SetShieldedInstanceIntegrityPolicyInstanceRequest request, CallOptions options)

Sets the Shielded Instance integrity policy for an instance. You can only use this method on a running instance. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.

Parameters
NameDescription
requestSetShieldedInstanceIntegrityPolicyInstanceRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

SetShieldedInstanceIntegrityPolicyAsync(SetShieldedInstanceIntegrityPolicyInstanceRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Sets the Shielded Instance integrity policy for an instance. You can only use this method on a running instance. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.

Parameters
NameDescription
requestSetShieldedInstanceIntegrityPolicyInstanceRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

SetTags(SetTagsInstanceRequest, CallOptions)

public virtual Operation SetTags(SetTagsInstanceRequest request, CallOptions options)

Sets network tags for the specified instance to the data included in the request.

Parameters
NameDescription
requestSetTagsInstanceRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

SetTags(SetTagsInstanceRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Sets network tags for the specified instance to the data included in the request.

Parameters
NameDescription
requestSetTagsInstanceRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

SetTagsAsync(SetTagsInstanceRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> SetTagsAsync(SetTagsInstanceRequest request, CallOptions options)

Sets network tags for the specified instance to the data included in the request.

Parameters
NameDescription
requestSetTagsInstanceRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

SetTagsAsync(SetTagsInstanceRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Sets network tags for the specified instance to the data included in the request.

Parameters
NameDescription
requestSetTagsInstanceRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

SimulateMaintenanceEvent(SimulateMaintenanceEventInstanceRequest, CallOptions)

public virtual Operation SimulateMaintenanceEvent(SimulateMaintenanceEventInstanceRequest request, CallOptions options)

Simulates a host maintenance event on a VM. For more information, see Simulate a host maintenance event.

Parameters
NameDescription
requestSimulateMaintenanceEventInstanceRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

SimulateMaintenanceEvent(SimulateMaintenanceEventInstanceRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Simulates a host maintenance event on a VM. For more information, see Simulate a host maintenance event.

Parameters
NameDescription
requestSimulateMaintenanceEventInstanceRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

SimulateMaintenanceEventAsync(SimulateMaintenanceEventInstanceRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> SimulateMaintenanceEventAsync(SimulateMaintenanceEventInstanceRequest request, CallOptions options)

Simulates a host maintenance event on a VM. For more information, see Simulate a host maintenance event.

Parameters
NameDescription
requestSimulateMaintenanceEventInstanceRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

SimulateMaintenanceEventAsync(SimulateMaintenanceEventInstanceRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Simulates a host maintenance event on a VM. For more information, see Simulate a host maintenance event.

Parameters
NameDescription
requestSimulateMaintenanceEventInstanceRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

Start(StartInstanceRequest, CallOptions)

public virtual Operation Start(StartInstanceRequest request, CallOptions options)

Starts an instance that was stopped using the instances().stop method. For more information, see Restart an instance.

Parameters
NameDescription
requestStartInstanceRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

Start(StartInstanceRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Starts an instance that was stopped using the instances().stop method. For more information, see Restart an instance.

Parameters
NameDescription
requestStartInstanceRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

StartAsync(StartInstanceRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> StartAsync(StartInstanceRequest request, CallOptions options)

Starts an instance that was stopped using the instances().stop method. For more information, see Restart an instance.

Parameters
NameDescription
requestStartInstanceRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

StartAsync(StartInstanceRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Starts an instance that was stopped using the instances().stop method. For more information, see Restart an instance.

Parameters
NameDescription
requestStartInstanceRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

StartWithEncryptionKey(StartWithEncryptionKeyInstanceRequest, CallOptions)

public virtual Operation StartWithEncryptionKey(StartWithEncryptionKeyInstanceRequest request, CallOptions options)

Starts an instance that was stopped using the instances().stop method. For more information, see Restart an instance.

Parameters
NameDescription
requestStartWithEncryptionKeyInstanceRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

StartWithEncryptionKey(StartWithEncryptionKeyInstanceRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Starts an instance that was stopped using the instances().stop method. For more information, see Restart an instance.

Parameters
NameDescription
requestStartWithEncryptionKeyInstanceRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

StartWithEncryptionKeyAsync(StartWithEncryptionKeyInstanceRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> StartWithEncryptionKeyAsync(StartWithEncryptionKeyInstanceRequest request, CallOptions options)

Starts an instance that was stopped using the instances().stop method. For more information, see Restart an instance.

Parameters
NameDescription
requestStartWithEncryptionKeyInstanceRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

StartWithEncryptionKeyAsync(StartWithEncryptionKeyInstanceRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Starts an instance that was stopped using the instances().stop method. For more information, see Restart an instance.

Parameters
NameDescription
requestStartWithEncryptionKeyInstanceRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

Stop(StopInstanceRequest, CallOptions)

public virtual Operation Stop(StopInstanceRequest request, CallOptions options)

Stops a running instance, shutting it down cleanly, and allows you to restart the instance at a later time. Stopped instances do not incur VM usage charges while they are stopped. However, resources that the VM is using, such as persistent disks and static IP addresses, will continue to be charged until they are deleted. For more information, see Stopping an instance.

Parameters
NameDescription
requestStopInstanceRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

Stop(StopInstanceRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Stops a running instance, shutting it down cleanly, and allows you to restart the instance at a later time. Stopped instances do not incur VM usage charges while they are stopped. However, resources that the VM is using, such as persistent disks and static IP addresses, will continue to be charged until they are deleted. For more information, see Stopping an instance.

Parameters
NameDescription
requestStopInstanceRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

StopAsync(StopInstanceRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> StopAsync(StopInstanceRequest request, CallOptions options)

Stops a running instance, shutting it down cleanly, and allows you to restart the instance at a later time. Stopped instances do not incur VM usage charges while they are stopped. However, resources that the VM is using, such as persistent disks and static IP addresses, will continue to be charged until they are deleted. For more information, see Stopping an instance.

Parameters
NameDescription
requestStopInstanceRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

StopAsync(StopInstanceRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Stops a running instance, shutting it down cleanly, and allows you to restart the instance at a later time. Stopped instances do not incur VM usage charges while they are stopped. However, resources that the VM is using, such as persistent disks and static IP addresses, will continue to be charged until they are deleted. For more information, see Stopping an instance.

Parameters
NameDescription
requestStopInstanceRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

Suspend(SuspendInstanceRequest, CallOptions)

public virtual Operation Suspend(SuspendInstanceRequest request, CallOptions options)

This method suspends a running instance, saving its state to persistent storage, and allows you to resume the instance at a later time. Suspended instances have no compute costs (cores or RAM), and incur only storage charges for the saved VM memory and localSSD data. Any charged resources the virtual machine was using, such as persistent disks and static IP addresses, will continue to be charged while the instance is suspended. For more information, see Suspending and resuming an instance.

Parameters
NameDescription
requestSuspendInstanceRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

Suspend(SuspendInstanceRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

This method suspends a running instance, saving its state to persistent storage, and allows you to resume the instance at a later time. Suspended instances have no compute costs (cores or RAM), and incur only storage charges for the saved VM memory and localSSD data. Any charged resources the virtual machine was using, such as persistent disks and static IP addresses, will continue to be charged while the instance is suspended. For more information, see Suspending and resuming an instance.

Parameters
NameDescription
requestSuspendInstanceRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

SuspendAsync(SuspendInstanceRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> SuspendAsync(SuspendInstanceRequest request, CallOptions options)

This method suspends a running instance, saving its state to persistent storage, and allows you to resume the instance at a later time. Suspended instances have no compute costs (cores or RAM), and incur only storage charges for the saved VM memory and localSSD data. Any charged resources the virtual machine was using, such as persistent disks and static IP addresses, will continue to be charged while the instance is suspended. For more information, see Suspending and resuming an instance.

Parameters
NameDescription
requestSuspendInstanceRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

SuspendAsync(SuspendInstanceRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

This method suspends a running instance, saving its state to persistent storage, and allows you to resume the instance at a later time. Suspended instances have no compute costs (cores or RAM), and incur only storage charges for the saved VM memory and localSSD data. Any charged resources the virtual machine was using, such as persistent disks and static IP addresses, will continue to be charged while the instance is suspended. For more information, see Suspending and resuming an instance.

Parameters
NameDescription
requestSuspendInstanceRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

TestIamPermissions(TestIamPermissionsInstanceRequest, CallOptions)

public virtual TestPermissionsResponse TestIamPermissions(TestIamPermissionsInstanceRequest request, CallOptions options)

Returns permissions that a caller has on the specified resource.

Parameters
NameDescription
requestTestIamPermissionsInstanceRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
TestPermissionsResponse

The response received from the server.

TestIamPermissions(TestIamPermissionsInstanceRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Returns permissions that a caller has on the specified resource.

Parameters
NameDescription
requestTestIamPermissionsInstanceRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
TestPermissionsResponse

The response received from the server.

TestIamPermissionsAsync(TestIamPermissionsInstanceRequest, CallOptions)

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

Returns permissions that a caller has on the specified resource.

Parameters
NameDescription
requestTestIamPermissionsInstanceRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<TestPermissionsResponse>

The call object.

TestIamPermissionsAsync(TestIamPermissionsInstanceRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Returns permissions that a caller has on the specified resource.

Parameters
NameDescription
requestTestIamPermissionsInstanceRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<TestPermissionsResponse>

The call object.

Update(UpdateInstanceRequest, CallOptions)

public virtual Operation Update(UpdateInstanceRequest request, CallOptions options)

Updates an instance only if the necessary resources are available. This method can update only a specific set of instance properties. See Updating a running instance for a list of updatable instance properties.

Parameters
NameDescription
requestUpdateInstanceRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

Update(UpdateInstanceRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Updates an instance only if the necessary resources are available. This method can update only a specific set of instance properties. See Updating a running instance for a list of updatable instance properties.

Parameters
NameDescription
requestUpdateInstanceRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

UpdateAccessConfig(UpdateAccessConfigInstanceRequest, CallOptions)

public virtual Operation UpdateAccessConfig(UpdateAccessConfigInstanceRequest request, CallOptions options)

Updates the specified access config from an instance's network interface with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.

Parameters
NameDescription
requestUpdateAccessConfigInstanceRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

UpdateAccessConfig(UpdateAccessConfigInstanceRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Updates the specified access config from an instance's network interface with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.

Parameters
NameDescription
requestUpdateAccessConfigInstanceRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

UpdateAccessConfigAsync(UpdateAccessConfigInstanceRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> UpdateAccessConfigAsync(UpdateAccessConfigInstanceRequest request, CallOptions options)

Updates the specified access config from an instance's network interface with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.

Parameters
NameDescription
requestUpdateAccessConfigInstanceRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

UpdateAccessConfigAsync(UpdateAccessConfigInstanceRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Updates the specified access config from an instance's network interface with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.

Parameters
NameDescription
requestUpdateAccessConfigInstanceRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

UpdateAsync(UpdateInstanceRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> UpdateAsync(UpdateInstanceRequest request, CallOptions options)

Updates an instance only if the necessary resources are available. This method can update only a specific set of instance properties. See Updating a running instance for a list of updatable instance properties.

Parameters
NameDescription
requestUpdateInstanceRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

UpdateAsync(UpdateInstanceRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Updates an instance only if the necessary resources are available. This method can update only a specific set of instance properties. See Updating a running instance for a list of updatable instance properties.

Parameters
NameDescription
requestUpdateInstanceRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

UpdateDisplayDevice(UpdateDisplayDeviceInstanceRequest, CallOptions)

public virtual Operation UpdateDisplayDevice(UpdateDisplayDeviceInstanceRequest request, CallOptions options)

Updates the Display config for a VM instance. You can only use this method on a stopped VM instance. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.

Parameters
NameDescription
requestUpdateDisplayDeviceInstanceRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

UpdateDisplayDevice(UpdateDisplayDeviceInstanceRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Updates the Display config for a VM instance. You can only use this method on a stopped VM instance. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.

Parameters
NameDescription
requestUpdateDisplayDeviceInstanceRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

UpdateDisplayDeviceAsync(UpdateDisplayDeviceInstanceRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> UpdateDisplayDeviceAsync(UpdateDisplayDeviceInstanceRequest request, CallOptions options)

Updates the Display config for a VM instance. You can only use this method on a stopped VM instance. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.

Parameters
NameDescription
requestUpdateDisplayDeviceInstanceRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

UpdateDisplayDeviceAsync(UpdateDisplayDeviceInstanceRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Updates the Display config for a VM instance. You can only use this method on a stopped VM instance. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.

Parameters
NameDescription
requestUpdateDisplayDeviceInstanceRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

UpdateNetworkInterface(UpdateNetworkInterfaceInstanceRequest, CallOptions)

public virtual Operation UpdateNetworkInterface(UpdateNetworkInterfaceInstanceRequest request, CallOptions options)

Updates an instance's network interface. This method can only update an interface's alias IP range and attached network. See Modifying alias IP ranges for an existing instance for instructions on changing alias IP ranges. See Migrating a VM between networks for instructions on migrating an interface. This method follows PATCH semantics.

Parameters
NameDescription
requestUpdateNetworkInterfaceInstanceRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

UpdateNetworkInterface(UpdateNetworkInterfaceInstanceRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Updates an instance's network interface. This method can only update an interface's alias IP range and attached network. See Modifying alias IP ranges for an existing instance for instructions on changing alias IP ranges. See Migrating a VM between networks for instructions on migrating an interface. This method follows PATCH semantics.

Parameters
NameDescription
requestUpdateNetworkInterfaceInstanceRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

UpdateNetworkInterfaceAsync(UpdateNetworkInterfaceInstanceRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> UpdateNetworkInterfaceAsync(UpdateNetworkInterfaceInstanceRequest request, CallOptions options)

Updates an instance's network interface. This method can only update an interface's alias IP range and attached network. See Modifying alias IP ranges for an existing instance for instructions on changing alias IP ranges. See Migrating a VM between networks for instructions on migrating an interface. This method follows PATCH semantics.

Parameters
NameDescription
requestUpdateNetworkInterfaceInstanceRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

UpdateNetworkInterfaceAsync(UpdateNetworkInterfaceInstanceRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Updates an instance's network interface. This method can only update an interface's alias IP range and attached network. See Modifying alias IP ranges for an existing instance for instructions on changing alias IP ranges. See Migrating a VM between networks for instructions on migrating an interface. This method follows PATCH semantics.

Parameters
NameDescription
requestUpdateNetworkInterfaceInstanceRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

UpdateShieldedInstanceConfig(UpdateShieldedInstanceConfigInstanceRequest, CallOptions)

public virtual Operation UpdateShieldedInstanceConfig(UpdateShieldedInstanceConfigInstanceRequest request, CallOptions options)

Updates the Shielded Instance config for an instance. You can only use this method on a stopped instance. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.

Parameters
NameDescription
requestUpdateShieldedInstanceConfigInstanceRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

UpdateShieldedInstanceConfig(UpdateShieldedInstanceConfigInstanceRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Updates the Shielded Instance config for an instance. You can only use this method on a stopped instance. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.

Parameters
NameDescription
requestUpdateShieldedInstanceConfigInstanceRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

UpdateShieldedInstanceConfigAsync(UpdateShieldedInstanceConfigInstanceRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> UpdateShieldedInstanceConfigAsync(UpdateShieldedInstanceConfigInstanceRequest request, CallOptions options)

Updates the Shielded Instance config for an instance. You can only use this method on a stopped instance. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.

Parameters
NameDescription
requestUpdateShieldedInstanceConfigInstanceRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

UpdateShieldedInstanceConfigAsync(UpdateShieldedInstanceConfigInstanceRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Updates the Shielded Instance config for an instance. You can only use this method on a stopped instance. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.

Parameters
NameDescription
requestUpdateShieldedInstanceConfigInstanceRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.