Compute Engine v1 API - Class AcceleratorTypes.AcceleratorTypesClient (2.15.0)

public class AcceleratorTypes.AcceleratorTypesClient : ClientBase<AcceleratorTypes.AcceleratorTypesClient>

Reference documentation and code samples for the Compute Engine v1 API class AcceleratorTypes.AcceleratorTypesClient.

Client for AcceleratorTypes

Inheritance

object > ClientBase > ClientBaseAcceleratorTypesAcceleratorTypesClient > AcceleratorTypes.AcceleratorTypesClient

Namespace

Google.Cloud.Compute.V1

Assembly

Google.Cloud.Compute.V1.dll

Constructors

AcceleratorTypesClient()

protected AcceleratorTypesClient()

Protected parameterless constructor to allow creation of test doubles.

AcceleratorTypesClient(CallInvoker)

public AcceleratorTypesClient(CallInvoker callInvoker)

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

Parameter
Name Description
callInvoker CallInvoker

The callInvoker to use to make remote calls.

AcceleratorTypesClient(ChannelBase)

public AcceleratorTypesClient(ChannelBase channel)

Creates a new client for AcceleratorTypes

Parameter
Name Description
channel ChannelBase

The channel to use to make remote calls.

AcceleratorTypesClient(ClientBaseConfiguration)

protected AcceleratorTypesClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name Description
configuration ClientBaseClientBaseConfiguration

The client configuration.

Methods

AggregatedList(AggregatedListAcceleratorTypesRequest, CallOptions)

public virtual AcceleratorTypeAggregatedList AggregatedList(AggregatedListAcceleratorTypesRequest request, CallOptions options)

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

Parameters
Name Description
request AggregatedListAcceleratorTypesRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AcceleratorTypeAggregatedList

The response received from the server.

AggregatedList(AggregatedListAcceleratorTypesRequest, Metadata, DateTime?, CancellationToken)

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

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

Parameters
Name Description
request AggregatedListAcceleratorTypesRequest

The request to send to the server.

headers Metadata

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

deadline 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
AcceleratorTypeAggregatedList

The response received from the server.

AggregatedListAsync(AggregatedListAcceleratorTypesRequest, CallOptions)

public virtual AsyncUnaryCall<AcceleratorTypeAggregatedList> AggregatedListAsync(AggregatedListAcceleratorTypesRequest request, CallOptions options)

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

Parameters
Name Description
request AggregatedListAcceleratorTypesRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallAcceleratorTypeAggregatedList

The call object.

AggregatedListAsync(AggregatedListAcceleratorTypesRequest, Metadata, DateTime?, CancellationToken)

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

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

Parameters
Name Description
request AggregatedListAcceleratorTypesRequest

The request to send to the server.

headers Metadata

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

deadline 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
AsyncUnaryCallAcceleratorTypeAggregatedList

The call object.

Get(GetAcceleratorTypeRequest, CallOptions)

public virtual AcceleratorType Get(GetAcceleratorTypeRequest request, CallOptions options)

Returns the specified accelerator type.

Parameters
Name Description
request GetAcceleratorTypeRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AcceleratorType

The response received from the server.

Get(GetAcceleratorTypeRequest, Metadata, DateTime?, CancellationToken)

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

Returns the specified accelerator type.

Parameters
Name Description
request GetAcceleratorTypeRequest

The request to send to the server.

headers Metadata

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

deadline 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
AcceleratorType

The response received from the server.

GetAsync(GetAcceleratorTypeRequest, CallOptions)

public virtual AsyncUnaryCall<AcceleratorType> GetAsync(GetAcceleratorTypeRequest request, CallOptions options)

Returns the specified accelerator type.

Parameters
Name Description
request GetAcceleratorTypeRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallAcceleratorType

The call object.

GetAsync(GetAcceleratorTypeRequest, Metadata, DateTime?, CancellationToken)

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

Returns the specified accelerator type.

Parameters
Name Description
request GetAcceleratorTypeRequest

The request to send to the server.

headers Metadata

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

deadline 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
AsyncUnaryCallAcceleratorType

The call object.

List(ListAcceleratorTypesRequest, CallOptions)

public virtual AcceleratorTypeList List(ListAcceleratorTypesRequest request, CallOptions options)

Retrieves a list of accelerator types that are available to the specified project.

Parameters
Name Description
request ListAcceleratorTypesRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AcceleratorTypeList

The response received from the server.

List(ListAcceleratorTypesRequest, Metadata, DateTime?, CancellationToken)

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

Retrieves a list of accelerator types that are available to the specified project.

Parameters
Name Description
request ListAcceleratorTypesRequest

The request to send to the server.

headers Metadata

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

deadline 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
AcceleratorTypeList

The response received from the server.

ListAsync(ListAcceleratorTypesRequest, CallOptions)

public virtual AsyncUnaryCall<AcceleratorTypeList> ListAsync(ListAcceleratorTypesRequest request, CallOptions options)

Retrieves a list of accelerator types that are available to the specified project.

Parameters
Name Description
request ListAcceleratorTypesRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallAcceleratorTypeList

The call object.

ListAsync(ListAcceleratorTypesRequest, Metadata, DateTime?, CancellationToken)

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

Retrieves a list of accelerator types that are available to the specified project.

Parameters
Name Description
request ListAcceleratorTypesRequest

The request to send to the server.

headers Metadata

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

deadline 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
AsyncUnaryCallAcceleratorTypeList

The call object.

NewInstance(ClientBaseConfiguration)

protected override AcceleratorTypes.AcceleratorTypesClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name Description
configuration ClientBaseClientBaseConfiguration
Returns
Type Description
AcceleratorTypesAcceleratorTypesClient
Overrides