Compute Engine v1 API - Class DiskTypes.DiskTypesClient (2.15.0)

public class DiskTypes.DiskTypesClient : ClientBase<DiskTypes.DiskTypesClient>

Reference documentation and code samples for the Compute Engine v1 API class DiskTypes.DiskTypesClient.

Client for DiskTypes

Inheritance

object > ClientBase > ClientBaseDiskTypesDiskTypesClient > DiskTypes.DiskTypesClient

Namespace

Google.Cloud.Compute.V1

Assembly

Google.Cloud.Compute.V1.dll

Constructors

DiskTypesClient()

protected DiskTypesClient()

Protected parameterless constructor to allow creation of test doubles.

DiskTypesClient(CallInvoker)

public DiskTypesClient(CallInvoker callInvoker)

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

Parameter
Name Description
callInvoker CallInvoker

The callInvoker to use to make remote calls.

DiskTypesClient(ChannelBase)

public DiskTypesClient(ChannelBase channel)

Creates a new client for DiskTypes

Parameter
Name Description
channel ChannelBase

The channel to use to make remote calls.

DiskTypesClient(ClientBaseConfiguration)

protected DiskTypesClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name Description
configuration ClientBaseClientBaseConfiguration

The client configuration.

Methods

AggregatedList(AggregatedListDiskTypesRequest, CallOptions)

public virtual DiskTypeAggregatedList AggregatedList(AggregatedListDiskTypesRequest request, CallOptions options)

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

Parameters
Name Description
request AggregatedListDiskTypesRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
DiskTypeAggregatedList

The response received from the server.

AggregatedList(AggregatedListDiskTypesRequest, Metadata, DateTime?, CancellationToken)

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

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

Parameters
Name Description
request AggregatedListDiskTypesRequest

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
DiskTypeAggregatedList

The response received from the server.

AggregatedListAsync(AggregatedListDiskTypesRequest, CallOptions)

public virtual AsyncUnaryCall<DiskTypeAggregatedList> AggregatedListAsync(AggregatedListDiskTypesRequest request, CallOptions options)

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

Parameters
Name Description
request AggregatedListDiskTypesRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallDiskTypeAggregatedList

The call object.

AggregatedListAsync(AggregatedListDiskTypesRequest, Metadata, DateTime?, CancellationToken)

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

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

Parameters
Name Description
request AggregatedListDiskTypesRequest

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
AsyncUnaryCallDiskTypeAggregatedList

The call object.

Get(GetDiskTypeRequest, CallOptions)

public virtual DiskType Get(GetDiskTypeRequest request, CallOptions options)

Returns the specified disk type.

Parameters
Name Description
request GetDiskTypeRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
DiskType

The response received from the server.

Get(GetDiskTypeRequest, Metadata, DateTime?, CancellationToken)

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

Returns the specified disk type.

Parameters
Name Description
request GetDiskTypeRequest

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
DiskType

The response received from the server.

GetAsync(GetDiskTypeRequest, CallOptions)

public virtual AsyncUnaryCall<DiskType> GetAsync(GetDiskTypeRequest request, CallOptions options)

Returns the specified disk type.

Parameters
Name Description
request GetDiskTypeRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallDiskType

The call object.

GetAsync(GetDiskTypeRequest, Metadata, DateTime?, CancellationToken)

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

Returns the specified disk type.

Parameters
Name Description
request GetDiskTypeRequest

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
AsyncUnaryCallDiskType

The call object.

List(ListDiskTypesRequest, CallOptions)

public virtual DiskTypeList List(ListDiskTypesRequest request, CallOptions options)

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

Parameters
Name Description
request ListDiskTypesRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
DiskTypeList

The response received from the server.

List(ListDiskTypesRequest, Metadata, DateTime?, CancellationToken)

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

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

Parameters
Name Description
request ListDiskTypesRequest

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
DiskTypeList

The response received from the server.

ListAsync(ListDiskTypesRequest, CallOptions)

public virtual AsyncUnaryCall<DiskTypeList> ListAsync(ListDiskTypesRequest request, CallOptions options)

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

Parameters
Name Description
request ListDiskTypesRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallDiskTypeList

The call object.

ListAsync(ListDiskTypesRequest, Metadata, DateTime?, CancellationToken)

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

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

Parameters
Name Description
request ListDiskTypesRequest

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
AsyncUnaryCallDiskTypeList

The call object.

NewInstance(ClientBaseConfiguration)

protected override DiskTypes.DiskTypesClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name Description
configuration ClientBaseClientBaseConfiguration
Returns
Type Description
DiskTypesDiskTypesClient
Overrides