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

Version latest

• 3.2.0 (latest)
• 3.1.0
• 3.0.0
• 2.17.0
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.12.0
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.0
• 2.2.0
• 2.1.0
• 2.0.0
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.0

public class MachineTypes.MachineTypesClient : ClientBase<MachineTypes.MachineTypesClient>

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

Client for MachineTypes

Inheritance

object > ClientBase > ClientBaseMachineTypesMachineTypesClient > MachineTypes.MachineTypesClient

Inherited Members

ClientBase<MachineTypes.MachineTypesClient>.WithHost(string)

ClientBase.CallInvoker

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

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
Name	Description
callInvoker	CallInvoker The callInvoker to use to make remote calls.

MachineTypesClient(ChannelBase)

public MachineTypesClient(ChannelBase channel)

Creates a new client for MachineTypes

Parameter
Name	Description
channel	ChannelBase The channel to use to make remote calls.

MachineTypesClient(ClientBaseConfiguration)

protected MachineTypesClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name	Description
configuration	ClientBaseClientBaseConfiguration The client configuration.

Methods

AggregatedList(AggregatedListMachineTypesRequest, CallOptions)

public virtual MachineTypeAggregatedList AggregatedList(AggregatedListMachineTypesRequest request, CallOptions options)

Retrieves an aggregated list of machine types. To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.

Parameters
Name	Description
request	AggregatedListMachineTypesRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
MachineTypeAggregatedList	The response received from the server.

AggregatedList(AggregatedListMachineTypesRequest, Metadata, DateTime?, CancellationToken)

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

Retrieves an aggregated list of machine types. To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.

Parameters
Name	Description
request	AggregatedListMachineTypesRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.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
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. To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.

Parameters
Name	Description
request	AggregatedListMachineTypesRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallMachineTypeAggregatedList	The call object.

AggregatedListAsync(AggregatedListMachineTypesRequest, Metadata, DateTime?, CancellationToken)

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

Retrieves an aggregated list of machine types. To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.

Parameters
Name	Description
request	AggregatedListMachineTypesRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.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
AsyncUnaryCallMachineTypeAggregatedList	The call object.

Get(GetMachineTypeRequest, CallOptions)

public virtual MachineType Get(GetMachineTypeRequest request, CallOptions options)

Returns the specified machine type.

Parameters
Name	Description
request	GetMachineTypeRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
MachineType	The response received from the server.

Get(GetMachineTypeRequest, Metadata, DateTime?, CancellationToken)

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

Returns the specified machine type.

Parameters
Name	Description
request	GetMachineTypeRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.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
MachineType	The response received from the server.

GetAsync(GetMachineTypeRequest, CallOptions)

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

Returns the specified machine type.

Parameters
Name	Description
request	GetMachineTypeRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallMachineType	The call object.

GetAsync(GetMachineTypeRequest, Metadata, DateTime?, CancellationToken)

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

Returns the specified machine type.

Parameters
Name	Description
request	GetMachineTypeRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.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
AsyncUnaryCallMachineType	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
Name	Description
request	ListMachineTypesRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
MachineTypeList	The response received from the server.

List(ListMachineTypesRequest, Metadata, DateTime?, CancellationToken)

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

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

Parameters
Name	Description
request	ListMachineTypesRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.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
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
Name	Description
request	ListMachineTypesRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallMachineTypeList	The call object.

ListAsync(ListMachineTypesRequest, Metadata, DateTime?, CancellationToken)

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

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

Parameters
Name	Description
request	ListMachineTypesRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.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
AsyncUnaryCallMachineTypeList	The call object.

NewInstance(ClientBaseConfiguration)

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

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name	Description
configuration	ClientBaseClientBaseConfiguration

Returns
Type	Description
MachineTypesMachineTypesClient

Overrides

Grpc.Core.ClientBase<Google.Cloud.Compute.V1.MachineTypes.MachineTypesClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)