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

Inherited Members

ClientBase<Zones.ZonesClient>.WithHost(String)

ClientBase.CallInvoker

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ToString()

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

ZonesClient(ChannelBase)

public ZonesClient(ChannelBase channel)

Creates a new client for Zones

Parameter
Name	Description
`channel`	`ChannelBase` 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
Name	Description
`configuration`	`ClientBase.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
Name	Description
`request`	`GetZoneRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`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
Name	Description
`request`	`GetZoneRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`Nullable<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
`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
Name	Description
`request`	`GetZoneRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`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
Name	Description
`request`	`GetZoneRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`Nullable<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
`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
Name	Description
`request`	`ListZonesRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`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
Name	Description
`request`	`ListZonesRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`Nullable<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
`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
Name	Description
`request`	`ListZonesRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`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
Name	Description
`request`	`ListZonesRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`Nullable<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
`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
Name	Description
`configuration`	`ClientBase.ClientBaseConfiguration`

Returns
Type	Description
`Zones.ZonesClient`

Overrides

Grpc.Core.ClientBase<Google.Cloud.Compute.V1.Zones.ZonesClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)