Compute Engine v1 API - Class GlobalAddresses.GlobalAddressesClient (2.5.0)

public class GlobalAddressesClient : ClientBase<GlobalAddresses.GlobalAddressesClient>

Reference documentation and code samples for the Compute Engine v1 API class GlobalAddresses.GlobalAddressesClient.

Client for GlobalAddresses

Inheritance

Object > ClientBase > ClientBase<GlobalAddresses.GlobalAddressesClient> > GlobalAddresses.GlobalAddressesClient

Namespace

Google.Cloud.Compute.V1

Assembly

Google.Cloud.Compute.V1.dll

Constructors

GlobalAddressesClient()

protected GlobalAddressesClient()

Protected parameterless constructor to allow creation of test doubles.

GlobalAddressesClient(CallInvoker)

public GlobalAddressesClient(CallInvoker callInvoker)

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

Parameter
NameDescription
callInvokerCallInvoker

The callInvoker to use to make remote calls.

GlobalAddressesClient(ChannelBase)

public GlobalAddressesClient(ChannelBase channel)

Creates a new client for GlobalAddresses

Parameter
NameDescription
channelChannelBase

The channel to use to make remote calls.

GlobalAddressesClient(ClientBase.ClientBaseConfiguration)

protected GlobalAddressesClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
NameDescription
configurationClientBase.ClientBaseConfiguration

The client configuration.

Methods

CreateOperationsClientForGlobalOperations()

public virtual Operations.OperationsClient CreateOperationsClientForGlobalOperations()

Creates a new instance of Operations.OperationsClient using the same call invoker as this client, delegating to GlobalOperations.

Returns
TypeDescription
Operations.OperationsClient

A new Operations client for the same target as this client.

Delete(DeleteGlobalAddressRequest, CallOptions)

public virtual Operation Delete(DeleteGlobalAddressRequest request, CallOptions options)

Deletes the specified address resource.

Parameters
NameDescription
requestDeleteGlobalAddressRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

Delete(DeleteGlobalAddressRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Operation Delete(DeleteGlobalAddressRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Deletes the specified address resource.

Parameters
NameDescription
requestDeleteGlobalAddressRequest

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
Operation

The response received from the server.

DeleteAsync(DeleteGlobalAddressRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> DeleteAsync(DeleteGlobalAddressRequest request, CallOptions options)

Deletes the specified address resource.

Parameters
NameDescription
requestDeleteGlobalAddressRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

DeleteAsync(DeleteGlobalAddressRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Operation> DeleteAsync(DeleteGlobalAddressRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Deletes the specified address resource.

Parameters
NameDescription
requestDeleteGlobalAddressRequest

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

The call object.

Get(GetGlobalAddressRequest, CallOptions)

public virtual Address Get(GetGlobalAddressRequest request, CallOptions options)

Returns the specified address resource. Gets a list of available addresses by making a list() request.

Parameters
NameDescription
requestGetGlobalAddressRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Address

The response received from the server.

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

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

Returns the specified address resource. Gets a list of available addresses by making a list() request.

Parameters
NameDescription
requestGetGlobalAddressRequest

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
Address

The response received from the server.

GetAsync(GetGlobalAddressRequest, CallOptions)

public virtual AsyncUnaryCall<Address> GetAsync(GetGlobalAddressRequest request, CallOptions options)

Returns the specified address resource. Gets a list of available addresses by making a list() request.

Parameters
NameDescription
requestGetGlobalAddressRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Address>

The call object.

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

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

Returns the specified address resource. Gets a list of available addresses by making a list() request.

Parameters
NameDescription
requestGetGlobalAddressRequest

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

The call object.

Insert(InsertGlobalAddressRequest, CallOptions)

public virtual Operation Insert(InsertGlobalAddressRequest request, CallOptions options)

Creates an address resource in the specified project by using the data included in the request.

Parameters
NameDescription
requestInsertGlobalAddressRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

Insert(InsertGlobalAddressRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Operation Insert(InsertGlobalAddressRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Creates an address resource in the specified project by using the data included in the request.

Parameters
NameDescription
requestInsertGlobalAddressRequest

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
Operation

The response received from the server.

InsertAsync(InsertGlobalAddressRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> InsertAsync(InsertGlobalAddressRequest request, CallOptions options)

Creates an address resource in the specified project by using the data included in the request.

Parameters
NameDescription
requestInsertGlobalAddressRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

InsertAsync(InsertGlobalAddressRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Operation> InsertAsync(InsertGlobalAddressRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Creates an address resource in the specified project by using the data included in the request.

Parameters
NameDescription
requestInsertGlobalAddressRequest

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

The call object.

List(ListGlobalAddressesRequest, CallOptions)

public virtual AddressList List(ListGlobalAddressesRequest request, CallOptions options)

Retrieves a list of global addresses.

Parameters
NameDescription
requestListGlobalAddressesRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AddressList

The response received from the server.

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

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

Retrieves a list of global addresses.

Parameters
NameDescription
requestListGlobalAddressesRequest

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
AddressList

The response received from the server.

ListAsync(ListGlobalAddressesRequest, CallOptions)

public virtual AsyncUnaryCall<AddressList> ListAsync(ListGlobalAddressesRequest request, CallOptions options)

Retrieves a list of global addresses.

Parameters
NameDescription
requestListGlobalAddressesRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<AddressList>

The call object.

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

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

Retrieves a list of global addresses.

Parameters
NameDescription
requestListGlobalAddressesRequest

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

The call object.

NewInstance(ClientBase.ClientBaseConfiguration)

protected override GlobalAddresses.GlobalAddressesClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

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

SetLabels(SetLabelsGlobalAddressRequest, CallOptions)

public virtual Operation SetLabels(SetLabelsGlobalAddressRequest request, CallOptions options)

Sets the labels on a GlobalAddress. To learn more about labels, read the Labeling Resources documentation.

Parameters
NameDescription
requestSetLabelsGlobalAddressRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

SetLabels(SetLabelsGlobalAddressRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Operation SetLabels(SetLabelsGlobalAddressRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Sets the labels on a GlobalAddress. To learn more about labels, read the Labeling Resources documentation.

Parameters
NameDescription
requestSetLabelsGlobalAddressRequest

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
Operation

The response received from the server.

SetLabelsAsync(SetLabelsGlobalAddressRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> SetLabelsAsync(SetLabelsGlobalAddressRequest request, CallOptions options)

Sets the labels on a GlobalAddress. To learn more about labels, read the Labeling Resources documentation.

Parameters
NameDescription
requestSetLabelsGlobalAddressRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

SetLabelsAsync(SetLabelsGlobalAddressRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Operation> SetLabelsAsync(SetLabelsGlobalAddressRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Sets the labels on a GlobalAddress. To learn more about labels, read the Labeling Resources documentation.

Parameters
NameDescription
requestSetLabelsGlobalAddressRequest

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

The call object.