Compute Engine v1 API - Class Zones.ZonesClient (2.4.0)

public class ZonesClient : ClientBase<Zones.ZonesClient>

Reference documentation and code samples for the Compute Engine v1 API class Zones.ZonesClient.

Client for Zones

Inheritance

Object > ClientBase > ClientBase<Zones.ZonesClient> > Zones.ZonesClient

Namespace

Google.Cloud.Compute.V1

Assembly

Google.Cloud.Compute.V1.dll

Constructors

ZonesClient()

protected ZonesClient()

Protected parameterless constructor to allow creation of test doubles.

ZonesClient(CallInvoker)

public ZonesClient(CallInvoker callInvoker)

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

Parameter
NameDescription
callInvokerCallInvoker

The callInvoker to use to make remote calls.

ZonesClient(ChannelBase)

public ZonesClient(ChannelBase channel)

Creates a new client for Zones

Parameter
NameDescription
channelChannelBase

The channel to use to make remote calls.

ZonesClient(ClientBase.ClientBaseConfiguration)

protected ZonesClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
NameDescription
configurationClientBase.ClientBaseConfiguration

The client configuration.

Methods

Get(GetZoneRequest, CallOptions)

public virtual Zone Get(GetZoneRequest request, CallOptions options)

Returns the specified Zone resource. Gets a list of available zones by making a list() request.

Parameters
NameDescription
requestGetZoneRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Zone

The response received from the server.

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

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

Returns the specified Zone resource. Gets a list of available zones by making a list() request.

Parameters
NameDescription
requestGetZoneRequest

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
Zone

The response received from the server.

GetAsync(GetZoneRequest, CallOptions)

public virtual AsyncUnaryCall<Zone> GetAsync(GetZoneRequest request, CallOptions options)

Returns the specified Zone resource. Gets a list of available zones by making a list() request.

Parameters
NameDescription
requestGetZoneRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Zone>

The call object.

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

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

Returns the specified Zone resource. Gets a list of available zones by making a list() request.

Parameters
NameDescription
requestGetZoneRequest

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<Zone>

The call object.

List(ListZonesRequest, CallOptions)

public virtual ZoneList List(ListZonesRequest request, CallOptions options)

Retrieves the list of Zone resources available to the specified project.

Parameters
NameDescription
requestListZonesRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
ZoneList

The response received from the server.

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

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

Retrieves the list of Zone resources available to the specified project.

Parameters
NameDescription
requestListZonesRequest

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
ZoneList

The response received from the server.

ListAsync(ListZonesRequest, CallOptions)

public virtual AsyncUnaryCall<ZoneList> ListAsync(ListZonesRequest request, CallOptions options)

Retrieves the list of Zone resources available to the specified project.

Parameters
NameDescription
requestListZonesRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<ZoneList>

The call object.

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

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

Retrieves the list of Zone resources available to the specified project.

Parameters
NameDescription
requestListZonesRequest

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<ZoneList>

The call object.

NewInstance(ClientBase.ClientBaseConfiguration)

protected override Zones.ZonesClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

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