Compute Engine v1 API - Class MachineTypes.MachineTypesClient (2.4.0)

public class MachineTypesClient : ClientBase<MachineTypes.MachineTypesClient>

Reference documentation and code samples for the Compute Engine v1 API class MachineTypes.MachineTypesClient.

Client for MachineTypes

Inheritance

Object > ClientBase > ClientBase<MachineTypes.MachineTypesClient> > MachineTypes.MachineTypesClient

Namespace

Google.Cloud.Compute.V1

Assembly

Google.Cloud.Compute.V1.dll

Constructors

MachineTypesClient()

protected MachineTypesClient()

Protected parameterless constructor to allow creation of test doubles.

MachineTypesClient(CallInvoker)

public MachineTypesClient(CallInvoker callInvoker)

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

Parameter
NameDescription
callInvokerCallInvoker

The callInvoker to use to make remote calls.

MachineTypesClient(ChannelBase)

public MachineTypesClient(ChannelBase channel)

Creates a new client for MachineTypes

Parameter
NameDescription
channelChannelBase

The channel to use to make remote calls.

MachineTypesClient(ClientBase.ClientBaseConfiguration)

protected MachineTypesClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
NameDescription
configurationClientBase.ClientBaseConfiguration

The client configuration.

Methods

AggregatedList(AggregatedListMachineTypesRequest, CallOptions)

public virtual MachineTypeAggregatedList AggregatedList(AggregatedListMachineTypesRequest request, CallOptions options)

Retrieves an aggregated list of machine types.

Parameters
NameDescription
requestAggregatedListMachineTypesRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
MachineTypeAggregatedList

The response received from the server.

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

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

Retrieves an aggregated list of machine types.

Parameters
NameDescription
requestAggregatedListMachineTypesRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
MachineTypeAggregatedList

The response received from the server.

AggregatedListAsync(AggregatedListMachineTypesRequest, CallOptions)

public virtual AsyncUnaryCall<MachineTypeAggregatedList> AggregatedListAsync(AggregatedListMachineTypesRequest request, CallOptions options)

Retrieves an aggregated list of machine types.

Parameters
NameDescription
requestAggregatedListMachineTypesRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<MachineTypeAggregatedList>

The call object.

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

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

Retrieves an aggregated list of machine types.

Parameters
NameDescription
requestAggregatedListMachineTypesRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<MachineTypeAggregatedList>

The call object.

Get(GetMachineTypeRequest, CallOptions)

public virtual MachineType Get(GetMachineTypeRequest request, CallOptions options)

Returns the specified machine type. Gets a list of available machine types by making a list() request.

Parameters
NameDescription
requestGetMachineTypeRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
MachineType

The response received from the server.

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

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

Returns the specified machine type. Gets a list of available machine types by making a list() request.

Parameters
NameDescription
requestGetMachineTypeRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
MachineType

The response received from the server.

GetAsync(GetMachineTypeRequest, CallOptions)

public virtual AsyncUnaryCall<MachineType> GetAsync(GetMachineTypeRequest request, CallOptions options)

Returns the specified machine type. Gets a list of available machine types by making a list() request.

Parameters
NameDescription
requestGetMachineTypeRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<MachineType>

The call object.

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

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

Returns the specified machine type. Gets a list of available machine types by making a list() request.

Parameters
NameDescription
requestGetMachineTypeRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<MachineType>

The call object.

List(ListMachineTypesRequest, CallOptions)

public virtual MachineTypeList List(ListMachineTypesRequest request, CallOptions options)

Retrieves a list of machine types available to the specified project.

Parameters
NameDescription
requestListMachineTypesRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
MachineTypeList

The response received from the server.

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

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

Retrieves a list of machine types available to the specified project.

Parameters
NameDescription
requestListMachineTypesRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
MachineTypeList

The response received from the server.

ListAsync(ListMachineTypesRequest, CallOptions)

public virtual AsyncUnaryCall<MachineTypeList> ListAsync(ListMachineTypesRequest request, CallOptions options)

Retrieves a list of machine types available to the specified project.

Parameters
NameDescription
requestListMachineTypesRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<MachineTypeList>

The call object.

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

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

Retrieves a list of machine types available to the specified project.

Parameters
NameDescription
requestListMachineTypesRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<MachineTypeList>

The call object.

NewInstance(ClientBase.ClientBaseConfiguration)

protected override MachineTypes.MachineTypesClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

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