Class Instances.InstancesBase (1.0.0)

[BindServiceMethod(typeof(Instances), "BindService")]
public abstract class InstancesBase

Base class for server-side implementations of Instances

Inheritance

Object > Instances.InstancesBase

Inherited Members

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ToString()

Namespace

Google.Cloud.Compute.V1

Assembly

Google.Cloud.Compute.V1.dll

Methods

AddAccessConfig(AddAccessConfigInstanceRequest, ServerCallContext)

public virtual Task<Operation> AddAccessConfig(AddAccessConfigInstanceRequest request, ServerCallContext context)

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

Parameters
Name	Description
`request`	`AddAccessConfigInstanceRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`Task<Operation>`	The response to send back to the client (wrapped by a task).

AddResourcePolicies(AddResourcePoliciesInstanceRequest, ServerCallContext)

public virtual Task<Operation> AddResourcePolicies(AddResourcePoliciesInstanceRequest request, ServerCallContext context)

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
Name	Description
`request`	`AddResourcePoliciesInstanceRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`Task<Operation>`	The response to send back to the client (wrapped by a task).

AggregatedList(AggregatedListInstancesRequest, ServerCallContext)

public virtual Task<InstanceAggregatedList> AggregatedList(AggregatedListInstancesRequest request, ServerCallContext context)

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
Name	Description
`request`	`AggregatedListInstancesRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`Task<InstanceAggregatedList>`	The response to send back to the client (wrapped by a task).

AttachDisk(AttachDiskInstanceRequest, ServerCallContext)

public virtual Task<Operation> AttachDisk(AttachDiskInstanceRequest request, ServerCallContext context)

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
Name	Description
`request`	`AttachDiskInstanceRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`Task<Operation>`	The response to send back to the client (wrapped by a task).

BulkInsert(BulkInsertInstanceRequest, ServerCallContext)

public virtual Task<Operation> BulkInsert(BulkInsertInstanceRequest request, ServerCallContext context)

Creates multiple instances. Count specifies the number of instances to create.

Parameters
Name	Description
`request`	`BulkInsertInstanceRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`Task<Operation>`	The response to send back to the client (wrapped by a task).

Delete(DeleteInstanceRequest, ServerCallContext)

public virtual Task<Operation> Delete(DeleteInstanceRequest request, ServerCallContext context)

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

Parameters
Name	Description
`request`	`DeleteInstanceRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`Task<Operation>`	The response to send back to the client (wrapped by a task).

DeleteAccessConfig(DeleteAccessConfigInstanceRequest, ServerCallContext)

public virtual Task<Operation> DeleteAccessConfig(DeleteAccessConfigInstanceRequest request, ServerCallContext context)

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

Parameters
Name	Description
`request`	`DeleteAccessConfigInstanceRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`Task<Operation>`	The response to send back to the client (wrapped by a task).

DetachDisk(DetachDiskInstanceRequest, ServerCallContext)

public virtual Task<Operation> DetachDisk(DetachDiskInstanceRequest request, ServerCallContext context)

Detaches a disk from an instance.

Parameters
Name	Description
`request`	`DetachDiskInstanceRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`Task<Operation>`	The response to send back to the client (wrapped by a task).

Get(GetInstanceRequest, ServerCallContext)

public virtual Task<Instance> Get(GetInstanceRequest request, ServerCallContext context)

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

Parameters
Name	Description
`request`	`GetInstanceRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`Task<Instance>`	The response to send back to the client (wrapped by a task).

GetEffectiveFirewalls(GetEffectiveFirewallsInstanceRequest, ServerCallContext)

public virtual Task<InstancesGetEffectiveFirewallsResponse> GetEffectiveFirewalls(GetEffectiveFirewallsInstanceRequest request, ServerCallContext context)

Returns effective firewalls applied to an interface of the instance.

Parameters
Name	Description
`request`	`GetEffectiveFirewallsInstanceRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`Task<InstancesGetEffectiveFirewallsResponse>`	The response to send back to the client (wrapped by a task).

GetGuestAttributes(GetGuestAttributesInstanceRequest, ServerCallContext)

public virtual Task<GuestAttributes> GetGuestAttributes(GetGuestAttributesInstanceRequest request, ServerCallContext context)

Returns the specified guest attributes entry.

Parameters
Name	Description
`request`	`GetGuestAttributesInstanceRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`Task<GuestAttributes>`	The response to send back to the client (wrapped by a task).

GetIamPolicy(GetIamPolicyInstanceRequest, ServerCallContext)

public virtual Task<Policy> GetIamPolicy(GetIamPolicyInstanceRequest request, ServerCallContext context)

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

Parameters
Name	Description
`request`	`GetIamPolicyInstanceRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`Task<Policy>`	The response to send back to the client (wrapped by a task).

GetScreenshot(GetScreenshotInstanceRequest, ServerCallContext)

public virtual Task<Screenshot> GetScreenshot(GetScreenshotInstanceRequest request, ServerCallContext context)

Returns the screenshot from the specified instance.

Parameters
Name	Description
`request`	`GetScreenshotInstanceRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`Task<Screenshot>`	The response to send back to the client (wrapped by a task).

GetSerialPortOutput(GetSerialPortOutputInstanceRequest, ServerCallContext)

public virtual Task<SerialPortOutput> GetSerialPortOutput(GetSerialPortOutputInstanceRequest request, ServerCallContext context)

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

Parameters
Name	Description
`request`	`GetSerialPortOutputInstanceRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`Task<SerialPortOutput>`	The response to send back to the client (wrapped by a task).

GetShieldedInstanceIdentity(GetShieldedInstanceIdentityInstanceRequest, ServerCallContext)

public virtual Task<ShieldedInstanceIdentity> GetShieldedInstanceIdentity(GetShieldedInstanceIdentityInstanceRequest request, ServerCallContext context)

Returns the Shielded Instance Identity of an instance

Parameters
Name	Description
`request`	`GetShieldedInstanceIdentityInstanceRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`Task<ShieldedInstanceIdentity>`	The response to send back to the client (wrapped by a task).

Insert(InsertInstanceRequest, ServerCallContext)

public virtual Task<Operation> Insert(InsertInstanceRequest request, ServerCallContext context)

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

Parameters
Name	Description
`request`	`InsertInstanceRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`Task<Operation>`	The response to send back to the client (wrapped by a task).

List(ListInstancesRequest, ServerCallContext)

public virtual Task<InstanceList> List(ListInstancesRequest request, ServerCallContext context)

Retrieves the list of instances contained within the specified zone.

Parameters
Name	Description
`request`	`ListInstancesRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`Task<InstanceList>`	The response to send back to the client (wrapped by a task).

ListReferrers(ListReferrersInstancesRequest, ServerCallContext)

public virtual Task<InstanceListReferrers> ListReferrers(ListReferrersInstancesRequest request, ServerCallContext context)

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
Name	Description
`request`	`ListReferrersInstancesRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`Task<InstanceListReferrers>`	The response to send back to the client (wrapped by a task).

RemoveResourcePolicies(RemoveResourcePoliciesInstanceRequest, ServerCallContext)

public virtual Task<Operation> RemoveResourcePolicies(RemoveResourcePoliciesInstanceRequest request, ServerCallContext context)

Removes resource policies from an instance.

Parameters
Name	Description
`request`	`RemoveResourcePoliciesInstanceRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`Task<Operation>`	The response to send back to the client (wrapped by a task).

Reset(ResetInstanceRequest, ServerCallContext)

public virtual Task<Operation> Reset(ResetInstanceRequest request, ServerCallContext context)

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
Name	Description
`request`	`ResetInstanceRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`Task<Operation>`	The response to send back to the client (wrapped by a task).

SendDiagnosticInterrupt(SendDiagnosticInterruptInstanceRequest, ServerCallContext)

public virtual Task<SendDiagnosticInterruptInstanceResponse> SendDiagnosticInterrupt(SendDiagnosticInterruptInstanceRequest request, ServerCallContext context)

Sends diagnostic interrupt to the instance.

Parameters
Name	Description
`request`	`SendDiagnosticInterruptInstanceRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`Task<SendDiagnosticInterruptInstanceResponse>`	The response to send back to the client (wrapped by a task).

SetDeletionProtection(SetDeletionProtectionInstanceRequest, ServerCallContext)

public virtual Task<Operation> SetDeletionProtection(SetDeletionProtectionInstanceRequest request, ServerCallContext context)

Sets deletion protection on the instance.

Parameters
Name	Description
`request`	`SetDeletionProtectionInstanceRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`Task<Operation>`	The response to send back to the client (wrapped by a task).

SetDiskAutoDelete(SetDiskAutoDeleteInstanceRequest, ServerCallContext)

public virtual Task<Operation> SetDiskAutoDelete(SetDiskAutoDeleteInstanceRequest request, ServerCallContext context)

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

Parameters
Name	Description
`request`	`SetDiskAutoDeleteInstanceRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`Task<Operation>`	The response to send back to the client (wrapped by a task).

SetIamPolicy(SetIamPolicyInstanceRequest, ServerCallContext)

public virtual Task<Policy> SetIamPolicy(SetIamPolicyInstanceRequest request, ServerCallContext context)

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

Parameters
Name	Description
`request`	`SetIamPolicyInstanceRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`Task<Policy>`	The response to send back to the client (wrapped by a task).

SetLabels(SetLabelsInstanceRequest, ServerCallContext)

public virtual Task<Operation> SetLabels(SetLabelsInstanceRequest request, ServerCallContext context)

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

Parameters
Name	Description
`request`	`SetLabelsInstanceRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`Task<Operation>`	The response to send back to the client (wrapped by a task).

SetMachineResources(SetMachineResourcesInstanceRequest, ServerCallContext)

public virtual Task<Operation> SetMachineResources(SetMachineResourcesInstanceRequest request, ServerCallContext context)

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

Parameters
Name	Description
`request`	`SetMachineResourcesInstanceRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`Task<Operation>`	The response to send back to the client (wrapped by a task).

SetMachineType(SetMachineTypeInstanceRequest, ServerCallContext)

public virtual Task<Operation> SetMachineType(SetMachineTypeInstanceRequest request, ServerCallContext context)

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

Parameters
Name	Description
`request`	`SetMachineTypeInstanceRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`Task<Operation>`	The response to send back to the client (wrapped by a task).

SetMetadata(SetMetadataInstanceRequest, ServerCallContext)

public virtual Task<Operation> SetMetadata(SetMetadataInstanceRequest request, ServerCallContext context)

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

Parameters
Name	Description
`request`	`SetMetadataInstanceRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`Task<Operation>`	The response to send back to the client (wrapped by a task).

SetMinCpuPlatform(SetMinCpuPlatformInstanceRequest, ServerCallContext)

public virtual Task<Operation> SetMinCpuPlatform(SetMinCpuPlatformInstanceRequest request, ServerCallContext context)

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
Name	Description
`request`	`SetMinCpuPlatformInstanceRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`Task<Operation>`	The response to send back to the client (wrapped by a task).

SetScheduling(SetSchedulingInstanceRequest, ServerCallContext)

public virtual Task<Operation> SetScheduling(SetSchedulingInstanceRequest request, ServerCallContext context)

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.

Parameters
Name	Description
`request`	`SetSchedulingInstanceRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`Task<Operation>`	The response to send back to the client (wrapped by a task).

SetServiceAccount(SetServiceAccountInstanceRequest, ServerCallContext)

public virtual Task<Operation> SetServiceAccount(SetServiceAccountInstanceRequest request, ServerCallContext context)

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

Parameters
Name	Description
`request`	`SetServiceAccountInstanceRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`Task<Operation>`	The response to send back to the client (wrapped by a task).

SetShieldedInstanceIntegrityPolicy(SetShieldedInstanceIntegrityPolicyInstanceRequest, ServerCallContext)

public virtual Task<Operation> SetShieldedInstanceIntegrityPolicy(SetShieldedInstanceIntegrityPolicyInstanceRequest request, ServerCallContext context)

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
Name	Description
`request`	`SetShieldedInstanceIntegrityPolicyInstanceRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`Task<Operation>`	The response to send back to the client (wrapped by a task).

SetTags(SetTagsInstanceRequest, ServerCallContext)

public virtual Task<Operation> SetTags(SetTagsInstanceRequest request, ServerCallContext context)

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

Parameters
Name	Description
`request`	`SetTagsInstanceRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`Task<Operation>`	The response to send back to the client (wrapped by a task).

SimulateMaintenanceEvent(SimulateMaintenanceEventInstanceRequest, ServerCallContext)

public virtual Task<Operation> SimulateMaintenanceEvent(SimulateMaintenanceEventInstanceRequest request, ServerCallContext context)

Simulates a maintenance event on the instance.

Parameters
Name	Description
`request`	`SimulateMaintenanceEventInstanceRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`Task<Operation>`	The response to send back to the client (wrapped by a task).

Start(StartInstanceRequest, ServerCallContext)

public virtual Task<Operation> Start(StartInstanceRequest request, ServerCallContext context)

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

Parameters
Name	Description
`request`	`StartInstanceRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`Task<Operation>`	The response to send back to the client (wrapped by a task).

StartWithEncryptionKey(StartWithEncryptionKeyInstanceRequest, ServerCallContext)

public virtual Task<Operation> StartWithEncryptionKey(StartWithEncryptionKeyInstanceRequest request, ServerCallContext context)

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

Parameters
Name	Description
`request`	`StartWithEncryptionKeyInstanceRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`Task<Operation>`	The response to send back to the client (wrapped by a task).

Stop(StopInstanceRequest, ServerCallContext)

public virtual Task<Operation> Stop(StopInstanceRequest request, ServerCallContext context)

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
Name	Description
`request`	`StopInstanceRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`Task<Operation>`	The response to send back to the client (wrapped by a task).

TestIamPermissions(TestIamPermissionsInstanceRequest, ServerCallContext)

public virtual Task<TestPermissionsResponse> TestIamPermissions(TestIamPermissionsInstanceRequest request, ServerCallContext context)

Returns permissions that a caller has on the specified resource.

Parameters
Name	Description
`request`	`TestIamPermissionsInstanceRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`Task<TestPermissionsResponse>`	The response to send back to the client (wrapped by a task).

Update(UpdateInstanceRequest, ServerCallContext)

public virtual Task<Operation> Update(UpdateInstanceRequest request, ServerCallContext context)

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
Name	Description
`request`	`UpdateInstanceRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`Task<Operation>`	The response to send back to the client (wrapped by a task).

UpdateAccessConfig(UpdateAccessConfigInstanceRequest, ServerCallContext)

public virtual Task<Operation> UpdateAccessConfig(UpdateAccessConfigInstanceRequest request, ServerCallContext context)

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
Name	Description
`request`	`UpdateAccessConfigInstanceRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`Task<Operation>`	The response to send back to the client (wrapped by a task).

UpdateDisplayDevice(UpdateDisplayDeviceInstanceRequest, ServerCallContext)

public virtual Task<Operation> UpdateDisplayDevice(UpdateDisplayDeviceInstanceRequest request, ServerCallContext context)

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
Name	Description
`request`	`UpdateDisplayDeviceInstanceRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`Task<Operation>`	The response to send back to the client (wrapped by a task).

UpdateNetworkInterface(UpdateNetworkInterfaceInstanceRequest, ServerCallContext)

public virtual Task<Operation> UpdateNetworkInterface(UpdateNetworkInterfaceInstanceRequest request, ServerCallContext context)

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
Name	Description
`request`	`UpdateNetworkInterfaceInstanceRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`Task<Operation>`	The response to send back to the client (wrapped by a task).

UpdateShieldedInstanceConfig(UpdateShieldedInstanceConfigInstanceRequest, ServerCallContext)

public virtual Task<Operation> UpdateShieldedInstanceConfig(UpdateShieldedInstanceConfigInstanceRequest request, ServerCallContext context)

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
Name	Description
`request`	`UpdateShieldedInstanceConfigInstanceRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`Task<Operation>`	The response to send back to the client (wrapped by a task).