Bare Metal Solution v2 API - Class BareMetalSolution.BareMetalSolutionClient (1.0.0)

public class BareMetalSolutionClient : ClientBase<BareMetalSolution.BareMetalSolutionClient>

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

Client for BareMetalSolution

Inheritance

Object > ClientBase > ClientBase<BareMetalSolution.BareMetalSolutionClient> > BareMetalSolution.BareMetalSolutionClient

Namespace

Google.Cloud.BareMetalSolution.V2

Assembly

Google.Cloud.BareMetalSolution.V2.dll

Constructors

BareMetalSolutionClient()

protected BareMetalSolutionClient()

Protected parameterless constructor to allow creation of test doubles.

BareMetalSolutionClient(CallInvoker)

public BareMetalSolutionClient(CallInvoker callInvoker)

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

Parameter
Name Description
callInvoker CallInvoker

The callInvoker to use to make remote calls.

BareMetalSolutionClient(ChannelBase)

public BareMetalSolutionClient(ChannelBase channel)

Creates a new client for BareMetalSolution

Parameter
Name Description
channel ChannelBase

The channel to use to make remote calls.

BareMetalSolutionClient(ClientBase.ClientBaseConfiguration)

protected BareMetalSolutionClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name Description
configuration ClientBase.ClientBaseConfiguration

The client configuration.

Methods

CreateIAMPolicyClient()

public virtual IAMPolicy.IAMPolicyClient CreateIAMPolicyClient()

Creates a new instance of IAMPolicy.IAMPolicyClient using the same call invoker as this client.

Returns
Type Description
IAMPolicy.IAMPolicyClient

A new IAMPolicy.IAMPolicyClient for the same target as this client.

CreateLocationsClient()

public virtual Locations.LocationsClient CreateLocationsClient()

Creates a new instance of Locations.LocationsClient using the same call invoker as this client.

Returns
Type Description
Locations.LocationsClient

A new Locations.LocationsClient for the same target as this client.

CreateOperationsClient()

public virtual Operations.OperationsClient CreateOperationsClient()

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

Returns
Type Description
Operations.OperationsClient

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

DetachLun(DetachLunRequest, CallOptions)

public virtual Operation DetachLun(DetachLunRequest request, CallOptions options)

Detach LUN from Instance.

Parameters
Name Description
request DetachLunRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Operation

The response received from the server.

DetachLun(DetachLunRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Detach LUN from Instance.

Parameters
Name Description
request DetachLunRequest

The request to send to the server.

headers Metadata

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

deadline Nullable<DateTime>

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

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
Operation

The response received from the server.

DetachLunAsync(DetachLunRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> DetachLunAsync(DetachLunRequest request, CallOptions options)

Detach LUN from Instance.

Parameters
Name Description
request DetachLunRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCall<Operation>

The call object.

DetachLunAsync(DetachLunRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Detach LUN from Instance.

Parameters
Name Description
request DetachLunRequest

The request to send to the server.

headers Metadata

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

deadline Nullable<DateTime>

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

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCall<Operation>

The call object.

GetInstance(GetInstanceRequest, CallOptions)

public virtual Instance GetInstance(GetInstanceRequest request, CallOptions options)

Get details about a single server.

Parameters
Name Description
request GetInstanceRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Instance

The response received from the server.

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

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

Get details about a single server.

Parameters
Name Description
request GetInstanceRequest

The request to send to the server.

headers Metadata

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

deadline Nullable<DateTime>

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

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
Instance

The response received from the server.

GetInstanceAsync(GetInstanceRequest, CallOptions)

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

Get details about a single server.

Parameters
Name Description
request GetInstanceRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCall<Instance>

The call object.

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

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

Get details about a single server.

Parameters
Name Description
request GetInstanceRequest

The request to send to the server.

headers Metadata

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

deadline Nullable<DateTime>

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

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCall<Instance>

The call object.

GetLun(GetLunRequest, CallOptions)

public virtual Lun GetLun(GetLunRequest request, CallOptions options)

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

Parameters
Name Description
request GetLunRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Lun

The response received from the server.

GetLun(GetLunRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Lun GetLun(GetLunRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

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

Parameters
Name Description
request GetLunRequest

The request to send to the server.

headers Metadata

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

deadline Nullable<DateTime>

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

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
Lun

The response received from the server.

GetLunAsync(GetLunRequest, CallOptions)

public virtual AsyncUnaryCall<Lun> GetLunAsync(GetLunRequest request, CallOptions options)

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

Parameters
Name Description
request GetLunRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCall<Lun>

The call object.

GetLunAsync(GetLunRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Lun> GetLunAsync(GetLunRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

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

Parameters
Name Description
request GetLunRequest

The request to send to the server.

headers Metadata

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

deadline Nullable<DateTime>

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

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCall<Lun>

The call object.

GetNetwork(GetNetworkRequest, CallOptions)

public virtual Network GetNetwork(GetNetworkRequest request, CallOptions options)

Get details of a single network.

Parameters
Name Description
request GetNetworkRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Network

The response received from the server.

GetNetwork(GetNetworkRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Network GetNetwork(GetNetworkRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Get details of a single network.

Parameters
Name Description
request GetNetworkRequest

The request to send to the server.

headers Metadata

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

deadline Nullable<DateTime>

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

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
Network

The response received from the server.

GetNetworkAsync(GetNetworkRequest, CallOptions)

public virtual AsyncUnaryCall<Network> GetNetworkAsync(GetNetworkRequest request, CallOptions options)

Get details of a single network.

Parameters
Name Description
request GetNetworkRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCall<Network>

The call object.

GetNetworkAsync(GetNetworkRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Network> GetNetworkAsync(GetNetworkRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Get details of a single network.

Parameters
Name Description
request GetNetworkRequest

The request to send to the server.

headers Metadata

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

deadline Nullable<DateTime>

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

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCall<Network>

The call object.

GetNfsShare(GetNfsShareRequest, CallOptions)

public virtual NfsShare GetNfsShare(GetNfsShareRequest request, CallOptions options)

Get details of a single NFS share.

Parameters
Name Description
request GetNfsShareRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
NfsShare

The response received from the server.

GetNfsShare(GetNfsShareRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual NfsShare GetNfsShare(GetNfsShareRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Get details of a single NFS share.

Parameters
Name Description
request GetNfsShareRequest

The request to send to the server.

headers Metadata

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

deadline Nullable<DateTime>

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

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
NfsShare

The response received from the server.

GetNfsShareAsync(GetNfsShareRequest, CallOptions)

public virtual AsyncUnaryCall<NfsShare> GetNfsShareAsync(GetNfsShareRequest request, CallOptions options)

Get details of a single NFS share.

Parameters
Name Description
request GetNfsShareRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCall<NfsShare>

The call object.

GetNfsShareAsync(GetNfsShareRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<NfsShare> GetNfsShareAsync(GetNfsShareRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Get details of a single NFS share.

Parameters
Name Description
request GetNfsShareRequest

The request to send to the server.

headers Metadata

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

deadline Nullable<DateTime>

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

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCall<NfsShare>

The call object.

GetVolume(GetVolumeRequest, CallOptions)

public virtual Volume GetVolume(GetVolumeRequest request, CallOptions options)

Get details of a single storage volume.

Parameters
Name Description
request GetVolumeRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Volume

The response received from the server.

GetVolume(GetVolumeRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Volume GetVolume(GetVolumeRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Get details of a single storage volume.

Parameters
Name Description
request GetVolumeRequest

The request to send to the server.

headers Metadata

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

deadline Nullable<DateTime>

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

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
Volume

The response received from the server.

GetVolumeAsync(GetVolumeRequest, CallOptions)

public virtual AsyncUnaryCall<Volume> GetVolumeAsync(GetVolumeRequest request, CallOptions options)

Get details of a single storage volume.

Parameters
Name Description
request GetVolumeRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCall<Volume>

The call object.

GetVolumeAsync(GetVolumeRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Volume> GetVolumeAsync(GetVolumeRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Get details of a single storage volume.

Parameters
Name Description
request GetVolumeRequest

The request to send to the server.

headers Metadata

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

deadline Nullable<DateTime>

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

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCall<Volume>

The call object.

ListInstances(ListInstancesRequest, CallOptions)

public virtual ListInstancesResponse ListInstances(ListInstancesRequest request, CallOptions options)

List servers in a given project and location.

Parameters
Name Description
request ListInstancesRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
ListInstancesResponse

The response received from the server.

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

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

List servers in a given project and location.

Parameters
Name Description
request ListInstancesRequest

The request to send to the server.

headers Metadata

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

deadline Nullable<DateTime>

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

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
ListInstancesResponse

The response received from the server.

ListInstancesAsync(ListInstancesRequest, CallOptions)

public virtual AsyncUnaryCall<ListInstancesResponse> ListInstancesAsync(ListInstancesRequest request, CallOptions options)

List servers in a given project and location.

Parameters
Name Description
request ListInstancesRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCall<ListInstancesResponse>

The call object.

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

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

List servers in a given project and location.

Parameters
Name Description
request ListInstancesRequest

The request to send to the server.

headers Metadata

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

deadline Nullable<DateTime>

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

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCall<ListInstancesResponse>

The call object.

ListLuns(ListLunsRequest, CallOptions)

public virtual ListLunsResponse ListLuns(ListLunsRequest request, CallOptions options)

List storage volume luns for given storage volume.

Parameters
Name Description
request ListLunsRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
ListLunsResponse

The response received from the server.

ListLuns(ListLunsRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual ListLunsResponse ListLuns(ListLunsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

List storage volume luns for given storage volume.

Parameters
Name Description
request ListLunsRequest

The request to send to the server.

headers Metadata

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

deadline Nullable<DateTime>

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

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
ListLunsResponse

The response received from the server.

ListLunsAsync(ListLunsRequest, CallOptions)

public virtual AsyncUnaryCall<ListLunsResponse> ListLunsAsync(ListLunsRequest request, CallOptions options)

List storage volume luns for given storage volume.

Parameters
Name Description
request ListLunsRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCall<ListLunsResponse>

The call object.

ListLunsAsync(ListLunsRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<ListLunsResponse> ListLunsAsync(ListLunsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

List storage volume luns for given storage volume.

Parameters
Name Description
request ListLunsRequest

The request to send to the server.

headers Metadata

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

deadline Nullable<DateTime>

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

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCall<ListLunsResponse>

The call object.

ListNetworks(ListNetworksRequest, CallOptions)

public virtual ListNetworksResponse ListNetworks(ListNetworksRequest request, CallOptions options)

List network in a given project and location.

Parameters
Name Description
request ListNetworksRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
ListNetworksResponse

The response received from the server.

ListNetworks(ListNetworksRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual ListNetworksResponse ListNetworks(ListNetworksRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

List network in a given project and location.

Parameters
Name Description
request ListNetworksRequest

The request to send to the server.

headers Metadata

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

deadline Nullable<DateTime>

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

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
ListNetworksResponse

The response received from the server.

ListNetworksAsync(ListNetworksRequest, CallOptions)

public virtual AsyncUnaryCall<ListNetworksResponse> ListNetworksAsync(ListNetworksRequest request, CallOptions options)

List network in a given project and location.

Parameters
Name Description
request ListNetworksRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCall<ListNetworksResponse>

The call object.

ListNetworksAsync(ListNetworksRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<ListNetworksResponse> ListNetworksAsync(ListNetworksRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

List network in a given project and location.

Parameters
Name Description
request ListNetworksRequest

The request to send to the server.

headers Metadata

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

deadline Nullable<DateTime>

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

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCall<ListNetworksResponse>

The call object.

ListNetworkUsage(ListNetworkUsageRequest, CallOptions)

public virtual ListNetworkUsageResponse ListNetworkUsage(ListNetworkUsageRequest request, CallOptions options)

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 to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
ListNetworkUsageResponse

The response received from the server.

ListNetworkUsage(ListNetworkUsageRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual ListNetworkUsageResponse ListNetworkUsage(ListNetworkUsageRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

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 to send to the server.

headers Metadata

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

deadline Nullable<DateTime>

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

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
ListNetworkUsageResponse

The response received from the server.

ListNetworkUsageAsync(ListNetworkUsageRequest, CallOptions)

public virtual AsyncUnaryCall<ListNetworkUsageResponse> ListNetworkUsageAsync(ListNetworkUsageRequest request, CallOptions options)

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 to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCall<ListNetworkUsageResponse>

The call object.

ListNetworkUsageAsync(ListNetworkUsageRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<ListNetworkUsageResponse> ListNetworkUsageAsync(ListNetworkUsageRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

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 to send to the server.

headers Metadata

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

deadline Nullable<DateTime>

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

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCall<ListNetworkUsageResponse>

The call object.

ListNfsShares(ListNfsSharesRequest, CallOptions)

public virtual ListNfsSharesResponse ListNfsShares(ListNfsSharesRequest request, CallOptions options)

List NFS shares.

Parameters
Name Description
request ListNfsSharesRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
ListNfsSharesResponse

The response received from the server.

ListNfsShares(ListNfsSharesRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual ListNfsSharesResponse ListNfsShares(ListNfsSharesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

List NFS shares.

Parameters
Name Description
request ListNfsSharesRequest

The request to send to the server.

headers Metadata

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

deadline Nullable<DateTime>

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

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
ListNfsSharesResponse

The response received from the server.

ListNfsSharesAsync(ListNfsSharesRequest, CallOptions)

public virtual AsyncUnaryCall<ListNfsSharesResponse> ListNfsSharesAsync(ListNfsSharesRequest request, CallOptions options)

List NFS shares.

Parameters
Name Description
request ListNfsSharesRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCall<ListNfsSharesResponse>

The call object.

ListNfsSharesAsync(ListNfsSharesRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<ListNfsSharesResponse> ListNfsSharesAsync(ListNfsSharesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

List NFS shares.

Parameters
Name Description
request ListNfsSharesRequest

The request to send to the server.

headers Metadata

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

deadline Nullable<DateTime>

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

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCall<ListNfsSharesResponse>

The call object.

ListVolumes(ListVolumesRequest, CallOptions)

public virtual ListVolumesResponse ListVolumes(ListVolumesRequest request, CallOptions options)

List storage volumes in a given project and location.

Parameters
Name Description
request ListVolumesRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
ListVolumesResponse

The response received from the server.

ListVolumes(ListVolumesRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual ListVolumesResponse ListVolumes(ListVolumesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

List storage volumes in a given project and location.

Parameters
Name Description
request ListVolumesRequest

The request to send to the server.

headers Metadata

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

deadline Nullable<DateTime>

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

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
ListVolumesResponse

The response received from the server.

ListVolumesAsync(ListVolumesRequest, CallOptions)

public virtual AsyncUnaryCall<ListVolumesResponse> ListVolumesAsync(ListVolumesRequest request, CallOptions options)

List storage volumes in a given project and location.

Parameters
Name Description
request ListVolumesRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCall<ListVolumesResponse>

The call object.

ListVolumesAsync(ListVolumesRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<ListVolumesResponse> ListVolumesAsync(ListVolumesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

List storage volumes in a given project and location.

Parameters
Name Description
request ListVolumesRequest

The request to send to the server.

headers Metadata

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

deadline Nullable<DateTime>

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

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCall<ListVolumesResponse>

The call object.

NewInstance(ClientBase.ClientBaseConfiguration)

protected override BareMetalSolution.BareMetalSolutionClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name Description
configuration ClientBase.ClientBaseConfiguration
Returns
Type Description
BareMetalSolution.BareMetalSolutionClient
Overrides
Grpc.Core.ClientBase<Google.Cloud.BareMetalSolution.V2.BareMetalSolution.BareMetalSolutionClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)

ResetInstance(ResetInstanceRequest, CallOptions)

public virtual Operation ResetInstance(ResetInstanceRequest request, CallOptions options)

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 to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Operation

The response received from the server.

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

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

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 to send to the server.

headers Metadata

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

deadline Nullable<DateTime>

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

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
Operation

The response received from the server.

ResetInstanceAsync(ResetInstanceRequest, CallOptions)

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

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 to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCall<Operation>

The call object.

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

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

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 to send to the server.

headers Metadata

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

deadline Nullable<DateTime>

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

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCall<Operation>

The call object.

ResizeVolume(ResizeVolumeRequest, CallOptions)

public virtual Operation ResizeVolume(ResizeVolumeRequest request, CallOptions options)

Emergency Volume resize.

Parameters
Name Description
request ResizeVolumeRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Operation

The response received from the server.

ResizeVolume(ResizeVolumeRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Emergency Volume resize.

Parameters
Name Description
request ResizeVolumeRequest

The request to send to the server.

headers Metadata

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

deadline Nullable<DateTime>

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

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
Operation

The response received from the server.

ResizeVolumeAsync(ResizeVolumeRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> ResizeVolumeAsync(ResizeVolumeRequest request, CallOptions options)

Emergency Volume resize.

Parameters
Name Description
request ResizeVolumeRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCall<Operation>

The call object.

ResizeVolumeAsync(ResizeVolumeRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Emergency Volume resize.

Parameters
Name Description
request ResizeVolumeRequest

The request to send to the server.

headers Metadata

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

deadline Nullable<DateTime>

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

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCall<Operation>

The call object.

StartInstance(StartInstanceRequest, CallOptions)

public virtual Operation StartInstance(StartInstanceRequest request, CallOptions options)

Starts a server that was shutdown.

Parameters
Name Description
request StartInstanceRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Operation

The response received from the server.

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

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

Starts a server that was shutdown.

Parameters
Name Description
request StartInstanceRequest

The request to send to the server.

headers Metadata

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

deadline Nullable<DateTime>

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

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
Operation

The response received from the server.

StartInstanceAsync(StartInstanceRequest, CallOptions)

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

Starts a server that was shutdown.

Parameters
Name Description
request StartInstanceRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCall<Operation>

The call object.

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

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

Starts a server that was shutdown.

Parameters
Name Description
request StartInstanceRequest

The request to send to the server.

headers Metadata

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

deadline Nullable<DateTime>

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

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCall<Operation>

The call object.

StopInstance(StopInstanceRequest, CallOptions)

public virtual Operation StopInstance(StopInstanceRequest request, CallOptions options)

Stop a running server.

Parameters
Name Description
request StopInstanceRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Operation

The response received from the server.

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

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

Stop a running server.

Parameters
Name Description
request StopInstanceRequest

The request to send to the server.

headers Metadata

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

deadline Nullable<DateTime>

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

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
Operation

The response received from the server.

StopInstanceAsync(StopInstanceRequest, CallOptions)

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

Stop a running server.

Parameters
Name Description
request StopInstanceRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCall<Operation>

The call object.

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

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

Stop a running server.

Parameters
Name Description
request StopInstanceRequest

The request to send to the server.

headers Metadata

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

deadline Nullable<DateTime>

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

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCall<Operation>

The call object.

UpdateInstance(UpdateInstanceRequest, CallOptions)

public virtual Operation UpdateInstance(UpdateInstanceRequest request, CallOptions options)

Update details of a single server.

Parameters
Name Description
request UpdateInstanceRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Operation

The response received from the server.

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

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

Update details of a single server.

Parameters
Name Description
request UpdateInstanceRequest

The request to send to the server.

headers Metadata

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

deadline Nullable<DateTime>

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

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
Operation

The response received from the server.

UpdateInstanceAsync(UpdateInstanceRequest, CallOptions)

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

Update details of a single server.

Parameters
Name Description
request UpdateInstanceRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCall<Operation>

The call object.

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

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

Update details of a single server.

Parameters
Name Description
request UpdateInstanceRequest

The request to send to the server.

headers Metadata

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

deadline Nullable<DateTime>

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

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCall<Operation>

The call object.

UpdateNetwork(UpdateNetworkRequest, CallOptions)

public virtual Operation UpdateNetwork(UpdateNetworkRequest request, CallOptions options)

Update details of a single network.

Parameters
Name Description
request UpdateNetworkRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Operation

The response received from the server.

UpdateNetwork(UpdateNetworkRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Update details of a single network.

Parameters
Name Description
request UpdateNetworkRequest

The request to send to the server.

headers Metadata

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

deadline Nullable<DateTime>

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

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
Operation

The response received from the server.

UpdateNetworkAsync(UpdateNetworkRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> UpdateNetworkAsync(UpdateNetworkRequest request, CallOptions options)

Update details of a single network.

Parameters
Name Description
request UpdateNetworkRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCall<Operation>

The call object.

UpdateNetworkAsync(UpdateNetworkRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Update details of a single network.

Parameters
Name Description
request UpdateNetworkRequest

The request to send to the server.

headers Metadata

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

deadline Nullable<DateTime>

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

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCall<Operation>

The call object.

UpdateNfsShare(UpdateNfsShareRequest, CallOptions)

public virtual Operation UpdateNfsShare(UpdateNfsShareRequest request, CallOptions options)

Update details of a single NFS share.

Parameters
Name Description
request UpdateNfsShareRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Operation

The response received from the server.

UpdateNfsShare(UpdateNfsShareRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Update details of a single NFS share.

Parameters
Name Description
request UpdateNfsShareRequest

The request to send to the server.

headers Metadata

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

deadline Nullable<DateTime>

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

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
Operation

The response received from the server.

UpdateNfsShareAsync(UpdateNfsShareRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> UpdateNfsShareAsync(UpdateNfsShareRequest request, CallOptions options)

Update details of a single NFS share.

Parameters
Name Description
request UpdateNfsShareRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCall<Operation>

The call object.

UpdateNfsShareAsync(UpdateNfsShareRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Update details of a single NFS share.

Parameters
Name Description
request UpdateNfsShareRequest

The request to send to the server.

headers Metadata

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

deadline Nullable<DateTime>

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

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCall<Operation>

The call object.

UpdateVolume(UpdateVolumeRequest, CallOptions)

public virtual Operation UpdateVolume(UpdateVolumeRequest request, CallOptions options)

Update details of a single storage volume.

Parameters
Name Description
request UpdateVolumeRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Operation

The response received from the server.

UpdateVolume(UpdateVolumeRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Update details of a single storage volume.

Parameters
Name Description
request UpdateVolumeRequest

The request to send to the server.

headers Metadata

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

deadline Nullable<DateTime>

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

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
Operation

The response received from the server.

UpdateVolumeAsync(UpdateVolumeRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> UpdateVolumeAsync(UpdateVolumeRequest request, CallOptions options)

Update details of a single storage volume.

Parameters
Name Description
request UpdateVolumeRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCall<Operation>

The call object.

UpdateVolumeAsync(UpdateVolumeRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Update details of a single storage volume.

Parameters
Name Description
request UpdateVolumeRequest

The request to send to the server.

headers Metadata

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

deadline Nullable<DateTime>

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

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCall<Operation>

The call object.