Bare Metal Solution v2 API - Class BareMetalSolutionClientImpl (1.1.0) 

public sealed class BareMetalSolutionClientImpl : BareMetalSolutionClient

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

BareMetalSolution client wrapper implementation, for convenient use.

Inheritance

Object > BareMetalSolutionClient > BareMetalSolutionClientImpl

Namespace

Google.Cloud.BareMetalSolution.V2

Assembly

Google.Cloud.BareMetalSolution.V2.dll

Remarks

Performs management operations on Bare Metal Solution servers.

The baremetalsolution.googleapis.com service provides management capabilities for Bare Metal Solution servers. To access the API methods, you must assign Bare Metal Solution IAM roles containing the desired permissions to your staff in your Google Cloud project. You must also enable the Bare Metal Solution API. Once enabled, the methods act upon specific servers in your Bare Metal Solution environment.

Constructors

BareMetalSolutionClientImpl(BareMetalSolution.BareMetalSolutionClient, BareMetalSolutionSettings, ILogger)

public BareMetalSolutionClientImpl(BareMetalSolution.BareMetalSolutionClient grpcClient, BareMetalSolutionSettings settings, ILogger logger)

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

Parameters
Name Description
grpcClient BareMetalSolution.BareMetalSolutionClient

The underlying gRPC client.
settings BareMetalSolutionSettings

The base BareMetalSolutionSettings used within this client.
logger ILogger

Optional ILogger to use within this client.

Properties

DetachLunOperationsClient

public override OperationsClient DetachLunOperationsClient { get; }

The long-running operations client for DetachLun.

Property Value
Type Description
OperationsClient
Overrides

GrpcClient

public override BareMetalSolution.BareMetalSolutionClient GrpcClient { get; }

The underlying gRPC BareMetalSolution client

Property Value
Type Description
BareMetalSolution.BareMetalSolutionClient
Overrides

IAMPolicyClient

public override IAMPolicyClient IAMPolicyClient { get; }

The IAMPolicyClient associated with this client.

Property Value
Type Description
IAMPolicyClient
Overrides

LocationsClient

public override LocationsClient LocationsClient { get; }

The LocationsClient associated with this client.

Property Value
Type Description
LocationsClient
Overrides

ResetInstanceOperationsClient

public override OperationsClient ResetInstanceOperationsClient { get; }

The long-running operations client for ResetInstance.

Property Value
Type Description
OperationsClient
Overrides

ResizeVolumeOperationsClient

public override OperationsClient ResizeVolumeOperationsClient { get; }

The long-running operations client for ResizeVolume.

Property Value
Type Description
OperationsClient
Overrides

StartInstanceOperationsClient

public override OperationsClient StartInstanceOperationsClient { get; }

The long-running operations client for StartInstance.

Property Value
Type Description
OperationsClient
Overrides

StopInstanceOperationsClient

public override OperationsClient StopInstanceOperationsClient { get; }

The long-running operations client for StopInstance.

Property Value
Type Description
OperationsClient
Overrides

UpdateInstanceOperationsClient

public override OperationsClient UpdateInstanceOperationsClient { get; }

The long-running operations client for UpdateInstance.

Property Value
Type Description
OperationsClient
Overrides

UpdateNetworkOperationsClient

public override OperationsClient UpdateNetworkOperationsClient { get; }

The long-running operations client for UpdateNetwork.

Property Value
Type Description
OperationsClient
Overrides

UpdateNfsShareOperationsClient

public override OperationsClient UpdateNfsShareOperationsClient { get; }

The long-running operations client for UpdateNfsShare.

Property Value
Type Description
OperationsClient
Overrides

UpdateVolumeOperationsClient

public override OperationsClient UpdateVolumeOperationsClient { get; }

The long-running operations client for UpdateVolume.

Property Value
Type Description
OperationsClient
Overrides

Methods

DetachLun(DetachLunRequest, CallSettings)

public override Operation<Instance, OperationMetadata> DetachLun(DetachLunRequest request, CallSettings callSettings = null)

Detach LUN from Instance.

Parameters
Name Description
request DetachLunRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Operation<Instance, OperationMetadata>

The RPC response.
Overrides

DetachLunAsync(DetachLunRequest, CallSettings)

public override async Task<Operation<Instance, OperationMetadata>> DetachLunAsync(DetachLunRequest request, CallSettings callSettings = null)

Detach LUN from Instance.

Parameters
Name Description
request DetachLunRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Task<Operation<Instance, OperationMetadata>>

A Task containing the RPC response.
Overrides

GetInstance(GetInstanceRequest, CallSettings)

public override Instance GetInstance(GetInstanceRequest request, CallSettings callSettings = null)

Get details about a single server.

Parameters
Name Description
request GetInstanceRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Instance

The RPC response.
Overrides

GetInstanceAsync(GetInstanceRequest, CallSettings)

public override Task<Instance> GetInstanceAsync(GetInstanceRequest request, CallSettings callSettings = null)

Get details about a single server.

Parameters
Name Description
request GetInstanceRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Task<Instance>

A Task containing the RPC response.
Overrides

GetLun(GetLunRequest, CallSettings)

public override Lun GetLun(GetLunRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request GetLunRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Lun

The RPC response.
Overrides

GetLunAsync(GetLunRequest, CallSettings)

public override Task<Lun> GetLunAsync(GetLunRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request GetLunRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Task<Lun>

A Task containing the RPC response.
Overrides

GetNetwork(GetNetworkRequest, CallSettings)

public override Network GetNetwork(GetNetworkRequest request, CallSettings callSettings = null)

Get details of a single network.

Parameters
Name Description
request GetNetworkRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Network

The RPC response.
Overrides

GetNetworkAsync(GetNetworkRequest, CallSettings)

public override Task<Network> GetNetworkAsync(GetNetworkRequest request, CallSettings callSettings = null)

Get details of a single network.

Parameters
Name Description
request GetNetworkRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Task<Network>

A Task containing the RPC response.
Overrides

GetNfsShare(GetNfsShareRequest, CallSettings)

public override NfsShare GetNfsShare(GetNfsShareRequest request, CallSettings callSettings = null)

Get details of a single NFS share.

Parameters
Name Description
request GetNfsShareRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
NfsShare

The RPC response.
Overrides

GetNfsShareAsync(GetNfsShareRequest, CallSettings)

public override Task<NfsShare> GetNfsShareAsync(GetNfsShareRequest request, CallSettings callSettings = null)

Get details of a single NFS share.

Parameters
Name Description
request GetNfsShareRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Task<NfsShare>

A Task containing the RPC response.
Overrides

GetVolume(GetVolumeRequest, CallSettings)

public override Volume GetVolume(GetVolumeRequest request, CallSettings callSettings = null)

Get details of a single storage volume.

Parameters
Name Description
request GetVolumeRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Volume

The RPC response.
Overrides

GetVolumeAsync(GetVolumeRequest, CallSettings)

public override Task<Volume> GetVolumeAsync(GetVolumeRequest request, CallSettings callSettings = null)

Get details of a single storage volume.

Parameters
Name Description
request GetVolumeRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Task<Volume>

A Task containing the RPC response.
Overrides

ListInstances(ListInstancesRequest, CallSettings)

public override PagedEnumerable<ListInstancesResponse, Instance> ListInstances(ListInstancesRequest request, CallSettings callSettings = null)

List servers in a given project and location.

Parameters
Name Description
request ListInstancesRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerable<ListInstancesResponse, Instance>

A pageable sequence of Instance resources.
Overrides

ListInstancesAsync(ListInstancesRequest, CallSettings)

public override PagedAsyncEnumerable<ListInstancesResponse, Instance> ListInstancesAsync(ListInstancesRequest request, CallSettings callSettings = null)

List servers in a given project and location.

Parameters
Name Description
request ListInstancesRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerable<ListInstancesResponse, Instance>

A pageable asynchronous sequence of Instance resources.
Overrides

ListLuns(ListLunsRequest, CallSettings)

public override PagedEnumerable<ListLunsResponse, Lun> ListLuns(ListLunsRequest request, CallSettings callSettings = null)

List storage volume luns for given storage volume.

Parameters
Name Description
request ListLunsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerable<ListLunsResponse, Lun>

A pageable sequence of Lun resources.
Overrides

ListLunsAsync(ListLunsRequest, CallSettings)

public override PagedAsyncEnumerable<ListLunsResponse, Lun> ListLunsAsync(ListLunsRequest request, CallSettings callSettings = null)

List storage volume luns for given storage volume.

Parameters
Name Description
request ListLunsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerable<ListLunsResponse, Lun>

A pageable asynchronous sequence of Lun resources.
Overrides

ListNetworks(ListNetworksRequest, CallSettings)

public override PagedEnumerable<ListNetworksResponse, Network> ListNetworks(ListNetworksRequest request, CallSettings callSettings = null)

List network in a given project and location.

Parameters
Name Description
request ListNetworksRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerable<ListNetworksResponse, Network>

A pageable sequence of Network resources.
Overrides

ListNetworksAsync(ListNetworksRequest, CallSettings)

public override PagedAsyncEnumerable<ListNetworksResponse, Network> ListNetworksAsync(ListNetworksRequest request, CallSettings callSettings = null)

List network in a given project and location.

Parameters
Name Description
request ListNetworksRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerable<ListNetworksResponse, Network>

A pageable asynchronous sequence of Network resources.
Overrides

ListNetworkUsage(ListNetworkUsageRequest, CallSettings)

public override ListNetworkUsageResponse ListNetworkUsage(ListNetworkUsageRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
ListNetworkUsageResponse

The RPC response.
Overrides

ListNetworkUsageAsync(ListNetworkUsageRequest, CallSettings)

public override Task<ListNetworkUsageResponse> ListNetworkUsageAsync(ListNetworkUsageRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Task<ListNetworkUsageResponse>

A Task containing the RPC response.
Overrides

ListNfsShares(ListNfsSharesRequest, CallSettings)

public override PagedEnumerable<ListNfsSharesResponse, NfsShare> ListNfsShares(ListNfsSharesRequest request, CallSettings callSettings = null)

List NFS shares.

Parameters
Name Description
request ListNfsSharesRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerable<ListNfsSharesResponse, NfsShare>

A pageable sequence of NfsShare resources.
Overrides

ListNfsSharesAsync(ListNfsSharesRequest, CallSettings)

public override PagedAsyncEnumerable<ListNfsSharesResponse, NfsShare> ListNfsSharesAsync(ListNfsSharesRequest request, CallSettings callSettings = null)

List NFS shares.

Parameters
Name Description
request ListNfsSharesRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerable<ListNfsSharesResponse, NfsShare>

A pageable asynchronous sequence of NfsShare resources.
Overrides

ListVolumes(ListVolumesRequest, CallSettings)

public override PagedEnumerable<ListVolumesResponse, Volume> ListVolumes(ListVolumesRequest request, CallSettings callSettings = null)

List storage volumes in a given project and location.

Parameters
Name Description
request ListVolumesRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerable<ListVolumesResponse, Volume>

A pageable sequence of Volume resources.
Overrides

ListVolumesAsync(ListVolumesRequest, CallSettings)

public override PagedAsyncEnumerable<ListVolumesResponse, Volume> ListVolumesAsync(ListVolumesRequest request, CallSettings callSettings = null)

List storage volumes in a given project and location.

Parameters
Name Description
request ListVolumesRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerable<ListVolumesResponse, Volume>

A pageable asynchronous sequence of Volume resources.
Overrides

ResetInstance(ResetInstanceRequest, CallSettings)

public override Operation<ResetInstanceResponse, OperationMetadata> ResetInstance(ResetInstanceRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Operation<ResetInstanceResponse, OperationMetadata>

The RPC response.
Overrides

ResetInstanceAsync(ResetInstanceRequest, CallSettings)

public override async Task<Operation<ResetInstanceResponse, OperationMetadata>> ResetInstanceAsync(ResetInstanceRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Task<Operation<ResetInstanceResponse, OperationMetadata>>

A Task containing the RPC response.
Overrides

ResizeVolume(ResizeVolumeRequest, CallSettings)

public override Operation<Volume, OperationMetadata> ResizeVolume(ResizeVolumeRequest request, CallSettings callSettings = null)

Emergency Volume resize.

Parameters
Name Description
request ResizeVolumeRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Operation<Volume, OperationMetadata>

The RPC response.
Overrides

ResizeVolumeAsync(ResizeVolumeRequest, CallSettings)

public override async Task<Operation<Volume, OperationMetadata>> ResizeVolumeAsync(ResizeVolumeRequest request, CallSettings callSettings = null)

Emergency Volume resize.

Parameters
Name Description
request ResizeVolumeRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Task<Operation<Volume, OperationMetadata>>

A Task containing the RPC response.
Overrides

StartInstance(StartInstanceRequest, CallSettings)

public override Operation<StartInstanceResponse, OperationMetadata> StartInstance(StartInstanceRequest request, CallSettings callSettings = null)

Starts a server that was shutdown.

Parameters
Name Description
request StartInstanceRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Operation<StartInstanceResponse, OperationMetadata>

The RPC response.
Overrides

StartInstanceAsync(StartInstanceRequest, CallSettings)

public override async Task<Operation<StartInstanceResponse, OperationMetadata>> StartInstanceAsync(StartInstanceRequest request, CallSettings callSettings = null)

Starts a server that was shutdown.

Parameters
Name Description
request StartInstanceRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Task<Operation<StartInstanceResponse, OperationMetadata>>

A Task containing the RPC response.
Overrides

StopInstance(StopInstanceRequest, CallSettings)

public override Operation<StopInstanceResponse, OperationMetadata> StopInstance(StopInstanceRequest request, CallSettings callSettings = null)

Stop a running server.

Parameters
Name Description
request StopInstanceRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Operation<StopInstanceResponse, OperationMetadata>

The RPC response.
Overrides

StopInstanceAsync(StopInstanceRequest, CallSettings)

public override async Task<Operation<StopInstanceResponse, OperationMetadata>> StopInstanceAsync(StopInstanceRequest request, CallSettings callSettings = null)

Stop a running server.

Parameters
Name Description
request StopInstanceRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Task<Operation<StopInstanceResponse, OperationMetadata>>

A Task containing the RPC response.
Overrides

UpdateInstance(UpdateInstanceRequest, CallSettings)

public override Operation<Instance, OperationMetadata> UpdateInstance(UpdateInstanceRequest request, CallSettings callSettings = null)

Update details of a single server.

Parameters
Name Description
request UpdateInstanceRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Operation<Instance, OperationMetadata>

The RPC response.
Overrides

UpdateInstanceAsync(UpdateInstanceRequest, CallSettings)

public override async Task<Operation<Instance, OperationMetadata>> UpdateInstanceAsync(UpdateInstanceRequest request, CallSettings callSettings = null)

Update details of a single server.

Parameters
Name Description
request UpdateInstanceRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Task<Operation<Instance, OperationMetadata>>

A Task containing the RPC response.
Overrides

UpdateNetwork(UpdateNetworkRequest, CallSettings)

public override Operation<Network, OperationMetadata> UpdateNetwork(UpdateNetworkRequest request, CallSettings callSettings = null)

Update details of a single network.

Parameters
Name Description
request UpdateNetworkRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Operation<Network, OperationMetadata>

The RPC response.
Overrides

UpdateNetworkAsync(UpdateNetworkRequest, CallSettings)

public override async Task<Operation<Network, OperationMetadata>> UpdateNetworkAsync(UpdateNetworkRequest request, CallSettings callSettings = null)

Update details of a single network.

Parameters
Name Description
request UpdateNetworkRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Task<Operation<Network, OperationMetadata>>

A Task containing the RPC response.
Overrides

UpdateNfsShare(UpdateNfsShareRequest, CallSettings)

public override Operation<NfsShare, OperationMetadata> UpdateNfsShare(UpdateNfsShareRequest request, CallSettings callSettings = null)

Update details of a single NFS share.

Parameters
Name Description
request UpdateNfsShareRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Operation<NfsShare, OperationMetadata>

The RPC response.
Overrides

UpdateNfsShareAsync(UpdateNfsShareRequest, CallSettings)

public override async Task<Operation<NfsShare, OperationMetadata>> UpdateNfsShareAsync(UpdateNfsShareRequest request, CallSettings callSettings = null)

Update details of a single NFS share.

Parameters
Name Description
request UpdateNfsShareRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Task<Operation<NfsShare, OperationMetadata>>

A Task containing the RPC response.
Overrides

UpdateVolume(UpdateVolumeRequest, CallSettings)

public override Operation<Volume, OperationMetadata> UpdateVolume(UpdateVolumeRequest request, CallSettings callSettings = null)

Update details of a single storage volume.

Parameters
Name Description
request UpdateVolumeRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Operation<Volume, OperationMetadata>

The RPC response.
Overrides

UpdateVolumeAsync(UpdateVolumeRequest, CallSettings)

public override async Task<Operation<Volume, OperationMetadata>> UpdateVolumeAsync(UpdateVolumeRequest request, CallSettings callSettings = null)

Update details of a single storage volume.

Parameters
Name Description
request UpdateVolumeRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Task<Operation<Volume, OperationMetadata>>

A Task containing the RPC response.
Overrides