Bare Metal Solution v2 API - Class BareMetalSolution.BareMetalSolutionBase (1.5.0)

Version latest

• 1.5.0 (latest)
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.0

[BindServiceMethod(typeof(BareMetalSolution), "BindService")]
public abstract class BareMetalSolution.BareMetalSolutionBase

Reference documentation and code samples for the Bare Metal Solution v2 API class BareMetalSolution.BareMetalSolutionBase.

Base class for server-side implementations of BareMetalSolution

Inheritance

object > BareMetalSolution.BareMetalSolutionBase

Inherited Members

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

Google.Cloud.BareMetalSolution.V2

Assembly

Google.Cloud.BareMetalSolution.V2.dll

Methods

CreateNfsShare(CreateNfsShareRequest, ServerCallContext)

public virtual Task<Operation> CreateNfsShare(CreateNfsShareRequest request, ServerCallContext context)

Create an NFS share.

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

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

CreateProvisioningConfig(CreateProvisioningConfigRequest, ServerCallContext)

public virtual Task<ProvisioningConfig> CreateProvisioningConfig(CreateProvisioningConfigRequest request, ServerCallContext context)

Create new ProvisioningConfig.

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

Returns
Type	Description
TaskProvisioningConfig	The response to send back to the client (wrapped by a task).

CreateSSHKey(CreateSSHKeyRequest, ServerCallContext)

public virtual Task<SSHKey> CreateSSHKey(CreateSSHKeyRequest request, ServerCallContext context)

Register a public SSH key in the specified project for use with the interactive serial console feature.

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

Returns
Type	Description
TaskSSHKey	The response to send back to the client (wrapped by a task).

CreateVolumeSnapshot(CreateVolumeSnapshotRequest, ServerCallContext)

public virtual Task<VolumeSnapshot> CreateVolumeSnapshot(CreateVolumeSnapshotRequest request, ServerCallContext context)

Takes a snapshot of a boot volume. Returns INVALID_ARGUMENT if called for a non-boot volume.

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

Returns
Type	Description
TaskVolumeSnapshot	The response to send back to the client (wrapped by a task).

DeleteNfsShare(DeleteNfsShareRequest, ServerCallContext)

public virtual Task<Operation> DeleteNfsShare(DeleteNfsShareRequest request, ServerCallContext context)

Delete an NFS share. The underlying volume is automatically deleted.

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

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

DeleteSSHKey(DeleteSSHKeyRequest, ServerCallContext)

public virtual Task<Empty> DeleteSSHKey(DeleteSSHKeyRequest request, ServerCallContext context)

Deletes a public SSH key registered in the specified project.

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

Returns
Type	Description
TaskEmpty	The response to send back to the client (wrapped by a task).

DeleteVolumeSnapshot(DeleteVolumeSnapshotRequest, ServerCallContext)

public virtual Task<Empty> DeleteVolumeSnapshot(DeleteVolumeSnapshotRequest request, ServerCallContext context)

Deletes a volume snapshot. Returns INVALID_ARGUMENT if called for a non-boot volume.

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

Returns
Type	Description
TaskEmpty	The response to send back to the client (wrapped by a task).

DetachLun(DetachLunRequest, ServerCallContext)

public virtual Task<Operation> DetachLun(DetachLunRequest request, ServerCallContext context)

Detach LUN from Instance.

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

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

DisableInteractiveSerialConsole(DisableInteractiveSerialConsoleRequest, ServerCallContext)

public virtual Task<Operation> DisableInteractiveSerialConsole(DisableInteractiveSerialConsoleRequest request, ServerCallContext context)

Disable the interactive serial console feature on an instance.

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

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

EnableInteractiveSerialConsole(EnableInteractiveSerialConsoleRequest, ServerCallContext)

public virtual Task<Operation> EnableInteractiveSerialConsole(EnableInteractiveSerialConsoleRequest request, ServerCallContext context)

Enable the interactive serial console feature on an instance.

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

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

EvictLun(EvictLunRequest, ServerCallContext)

public virtual Task<Operation> EvictLun(EvictLunRequest request, ServerCallContext context)

Skips lun's cooloff and deletes it now. Lun must be in cooloff state.

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

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

EvictVolume(EvictVolumeRequest, ServerCallContext)

public virtual Task<Operation> EvictVolume(EvictVolumeRequest request, ServerCallContext context)

Skips volume's cooloff and deletes it now. Volume must be in cooloff state.

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

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

GetInstance(GetInstanceRequest, ServerCallContext)

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

Get details about a single server.

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
TaskInstance	The response to send back to the client (wrapped by a task).

GetLun(GetLunRequest, ServerCallContext)

public virtual Task<Lun> GetLun(GetLunRequest request, ServerCallContext context)

Get details of a single storage logical unit number(LUN).

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

Returns
Type	Description
TaskLun	The response to send back to the client (wrapped by a task).

GetNetwork(GetNetworkRequest, ServerCallContext)

public virtual Task<Network> GetNetwork(GetNetworkRequest request, ServerCallContext context)

Get details of a single network.

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

Returns
Type	Description
TaskNetwork	The response to send back to the client (wrapped by a task).

GetNfsShare(GetNfsShareRequest, ServerCallContext)

public virtual Task<NfsShare> GetNfsShare(GetNfsShareRequest request, ServerCallContext context)

Get details of a single NFS share.

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

Returns
Type	Description
TaskNfsShare	The response to send back to the client (wrapped by a task).

GetProvisioningConfig(GetProvisioningConfigRequest, ServerCallContext)

public virtual Task<ProvisioningConfig> GetProvisioningConfig(GetProvisioningConfigRequest request, ServerCallContext context)

Get ProvisioningConfig by name.

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

Returns
Type	Description
TaskProvisioningConfig	The response to send back to the client (wrapped by a task).

GetVolume(GetVolumeRequest, ServerCallContext)

public virtual Task<Volume> GetVolume(GetVolumeRequest request, ServerCallContext context)

Get details of a single storage volume.

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

Returns
Type	Description
TaskVolume	The response to send back to the client (wrapped by a task).

GetVolumeSnapshot(GetVolumeSnapshotRequest, ServerCallContext)

public virtual Task<VolumeSnapshot> GetVolumeSnapshot(GetVolumeSnapshotRequest request, ServerCallContext context)

Returns the specified snapshot resource. Returns INVALID_ARGUMENT if called for a non-boot volume.

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

Returns
Type	Description
TaskVolumeSnapshot	The response to send back to the client (wrapped by a task).

ListInstances(ListInstancesRequest, ServerCallContext)

public virtual Task<ListInstancesResponse> ListInstances(ListInstancesRequest request, ServerCallContext context)

List servers in a given project and location.

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
TaskListInstancesResponse	The response to send back to the client (wrapped by a task).

ListLuns(ListLunsRequest, ServerCallContext)

public virtual Task<ListLunsResponse> ListLuns(ListLunsRequest request, ServerCallContext context)

List storage volume luns for given storage volume.

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

Returns
Type	Description
TaskListLunsResponse	The response to send back to the client (wrapped by a task).

ListNetworkUsage(ListNetworkUsageRequest, ServerCallContext)

public virtual Task<ListNetworkUsageResponse> ListNetworkUsage(ListNetworkUsageRequest request, ServerCallContext context)

List all Networks (and used IPs for each Network) in the vendor account associated with the specified project.

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

Returns
Type	Description
TaskListNetworkUsageResponse	The response to send back to the client (wrapped by a task).

ListNetworks(ListNetworksRequest, ServerCallContext)

public virtual Task<ListNetworksResponse> ListNetworks(ListNetworksRequest request, ServerCallContext context)

List network in a given project and location.

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

Returns
Type	Description
TaskListNetworksResponse	The response to send back to the client (wrapped by a task).

ListNfsShares(ListNfsSharesRequest, ServerCallContext)

public virtual Task<ListNfsSharesResponse> ListNfsShares(ListNfsSharesRequest request, ServerCallContext context)

List NFS shares.

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

Returns
Type	Description
TaskListNfsSharesResponse	The response to send back to the client (wrapped by a task).

ListOSImages(ListOSImagesRequest, ServerCallContext)

public virtual Task<ListOSImagesResponse> ListOSImages(ListOSImagesRequest request, ServerCallContext context)

Retrieves the list of OS images which are currently approved.

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

Returns
Type	Description
TaskListOSImagesResponse	The response to send back to the client (wrapped by a task).

ListProvisioningQuotas(ListProvisioningQuotasRequest, ServerCallContext)

public virtual Task<ListProvisioningQuotasResponse> ListProvisioningQuotas(ListProvisioningQuotasRequest request, ServerCallContext context)

List the budget details to provision resources on a given project.

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

Returns
Type	Description
TaskListProvisioningQuotasResponse	The response to send back to the client (wrapped by a task).

ListSSHKeys(ListSSHKeysRequest, ServerCallContext)

public virtual Task<ListSSHKeysResponse> ListSSHKeys(ListSSHKeysRequest request, ServerCallContext context)

Lists the public SSH keys registered for the specified project. These SSH keys are used only for the interactive serial console feature.

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

Returns
Type	Description
TaskListSSHKeysResponse	The response to send back to the client (wrapped by a task).

ListVolumeSnapshots(ListVolumeSnapshotsRequest, ServerCallContext)

public virtual Task<ListVolumeSnapshotsResponse> ListVolumeSnapshots(ListVolumeSnapshotsRequest request, ServerCallContext context)

Retrieves the list of snapshots for the specified volume. Returns a response with an empty list of snapshots if called for a non-boot volume.

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

Returns
Type	Description
TaskListVolumeSnapshotsResponse	The response to send back to the client (wrapped by a task).

ListVolumes(ListVolumesRequest, ServerCallContext)

public virtual Task<ListVolumesResponse> ListVolumes(ListVolumesRequest request, ServerCallContext context)

List storage volumes in a given project and location.

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

Returns
Type	Description
TaskListVolumesResponse	The response to send back to the client (wrapped by a task).

RenameInstance(RenameInstanceRequest, ServerCallContext)

public virtual Task<Instance> RenameInstance(RenameInstanceRequest request, ServerCallContext context)

RenameInstance sets a new name for an instance. Use with caution, previous names become immediately invalidated.

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

Returns
Type	Description
TaskInstance	The response to send back to the client (wrapped by a task).

RenameNetwork(RenameNetworkRequest, ServerCallContext)

public virtual Task<Network> RenameNetwork(RenameNetworkRequest request, ServerCallContext context)

RenameNetwork sets a new name for a network. Use with caution, previous names become immediately invalidated.

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

Returns
Type	Description
TaskNetwork	The response to send back to the client (wrapped by a task).

RenameNfsShare(RenameNfsShareRequest, ServerCallContext)

public virtual Task<NfsShare> RenameNfsShare(RenameNfsShareRequest request, ServerCallContext context)

RenameNfsShare sets a new name for an nfsshare. Use with caution, previous names become immediately invalidated.

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

Returns
Type	Description
TaskNfsShare	The response to send back to the client (wrapped by a task).

RenameVolume(RenameVolumeRequest, ServerCallContext)

public virtual Task<Volume> RenameVolume(RenameVolumeRequest request, ServerCallContext context)

RenameVolume sets a new name for a volume. Use with caution, previous names become immediately invalidated.

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

Returns
Type	Description
TaskVolume	The response to send back to the client (wrapped by a task).

ResetInstance(ResetInstanceRequest, ServerCallContext)

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

Perform an ungraceful, hard reset on a server. Equivalent to shutting the power off and then turning it back on.

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
TaskOperation	The response to send back to the client (wrapped by a task).

ResizeVolume(ResizeVolumeRequest, ServerCallContext)

public virtual Task<Operation> ResizeVolume(ResizeVolumeRequest request, ServerCallContext context)

Emergency Volume resize.

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

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

RestoreVolumeSnapshot(RestoreVolumeSnapshotRequest, ServerCallContext)

public virtual Task<Operation> RestoreVolumeSnapshot(RestoreVolumeSnapshotRequest request, ServerCallContext context)

Uses the specified snapshot to restore its parent volume. Returns INVALID_ARGUMENT if called for a non-boot volume.

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

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

StartInstance(StartInstanceRequest, ServerCallContext)

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

Starts a server that was shutdown.

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
TaskOperation	The response to send back to the client (wrapped by a task).

StopInstance(StopInstanceRequest, ServerCallContext)

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

Stop a running server.

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
TaskOperation	The response to send back to the client (wrapped by a task).

SubmitProvisioningConfig(SubmitProvisioningConfigRequest, ServerCallContext)

public virtual Task<SubmitProvisioningConfigResponse> SubmitProvisioningConfig(SubmitProvisioningConfigRequest request, ServerCallContext context)

Submit a provisiong configuration for a given project.

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

Returns
Type	Description
TaskSubmitProvisioningConfigResponse	The response to send back to the client (wrapped by a task).

UpdateInstance(UpdateInstanceRequest, ServerCallContext)

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

Update details of a single server.

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
TaskOperation	The response to send back to the client (wrapped by a task).

UpdateNetwork(UpdateNetworkRequest, ServerCallContext)

public virtual Task<Operation> UpdateNetwork(UpdateNetworkRequest request, ServerCallContext context)

Update details of a single network.

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

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

UpdateNfsShare(UpdateNfsShareRequest, ServerCallContext)

public virtual Task<Operation> UpdateNfsShare(UpdateNfsShareRequest request, ServerCallContext context)

Update details of a single NFS share.

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

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

UpdateProvisioningConfig(UpdateProvisioningConfigRequest, ServerCallContext)

public virtual Task<ProvisioningConfig> UpdateProvisioningConfig(UpdateProvisioningConfigRequest request, ServerCallContext context)

Update existing ProvisioningConfig.

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

Returns
Type	Description
TaskProvisioningConfig	The response to send back to the client (wrapped by a task).

UpdateVolume(UpdateVolumeRequest, ServerCallContext)

public virtual Task<Operation> UpdateVolume(UpdateVolumeRequest request, ServerCallContext context)

Update details of a single storage volume.

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

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).