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

Version 2.14.0

• 2.17.0 (latest)
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.12.0
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.0
• 2.2.0
• 2.1.0
• 2.0.0
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.0

public class GlobalAddresses.GlobalAddressesClient : ClientBase<GlobalAddresses.GlobalAddressesClient>

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

Client for GlobalAddresses

Inheritance

object > ClientBase > ClientBaseGlobalAddressesGlobalAddressesClient > GlobalAddresses.GlobalAddressesClient

Inherited Members

ClientBase<GlobalAddresses.GlobalAddressesClient>.WithHost(string)

ClientBase.CallInvoker

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

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

GlobalAddressesClient(ChannelBase)

public GlobalAddressesClient(ChannelBase channel)

Creates a new client for GlobalAddresses

Parameter
Name	Description
channel	ChannelBase The channel to use to make remote calls.

GlobalAddressesClient(ClientBaseConfiguration)

protected GlobalAddressesClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name	Description
configuration	ClientBaseClientBaseConfiguration 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
Type	Description
OperationsOperationsClient	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
Name	Description
request	DeleteGlobalAddressRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Operation	The response received from the server.

Delete(DeleteGlobalAddressRequest, Metadata, DateTime?, CancellationToken)

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

Deletes the specified address resource.

Parameters
Name	Description
request	DeleteGlobalAddressRequest 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
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
Name	Description
request	DeleteGlobalAddressRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

DeleteAsync(DeleteGlobalAddressRequest, Metadata, DateTime?, CancellationToken)

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

Deletes the specified address resource.

Parameters
Name	Description
request	DeleteGlobalAddressRequest 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
AsyncUnaryCallOperation	The call object.

Get(GetGlobalAddressRequest, CallOptions)

public virtual Address Get(GetGlobalAddressRequest request, CallOptions options)

Returns the specified address resource.

Parameters
Name	Description
request	GetGlobalAddressRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Address	The response received from the server.

Get(GetGlobalAddressRequest, Metadata, DateTime?, CancellationToken)

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

Returns the specified address resource.

Parameters
Name	Description
request	GetGlobalAddressRequest 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
Address	The response received from the server.

GetAsync(GetGlobalAddressRequest, CallOptions)

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

Returns the specified address resource.

Parameters
Name	Description
request	GetGlobalAddressRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallAddress	The call object.

GetAsync(GetGlobalAddressRequest, Metadata, DateTime?, CancellationToken)

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

Returns the specified address resource.

Parameters
Name	Description
request	GetGlobalAddressRequest 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
AsyncUnaryCallAddress	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
Name	Description
request	InsertGlobalAddressRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Operation	The response received from the server.

Insert(InsertGlobalAddressRequest, Metadata, DateTime?, CancellationToken)

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

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

Parameters
Name	Description
request	InsertGlobalAddressRequest 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
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
Name	Description
request	InsertGlobalAddressRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

InsertAsync(InsertGlobalAddressRequest, Metadata, DateTime?, CancellationToken)

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

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

Parameters
Name	Description
request	InsertGlobalAddressRequest 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
AsyncUnaryCallOperation	The call object.

List(ListGlobalAddressesRequest, CallOptions)

public virtual AddressList List(ListGlobalAddressesRequest request, CallOptions options)

Retrieves a list of global addresses.

Parameters
Name	Description
request	ListGlobalAddressesRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AddressList	The response received from the server.

List(ListGlobalAddressesRequest, Metadata, DateTime?, CancellationToken)

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

Retrieves a list of global addresses.

Parameters
Name	Description
request	ListGlobalAddressesRequest 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
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
Name	Description
request	ListGlobalAddressesRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallAddressList	The call object.

ListAsync(ListGlobalAddressesRequest, Metadata, DateTime?, CancellationToken)

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

Retrieves a list of global addresses.

Parameters
Name	Description
request	ListGlobalAddressesRequest 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
AsyncUnaryCallAddressList	The call object.

Move(MoveGlobalAddressRequest, CallOptions)

public virtual Operation Move(MoveGlobalAddressRequest request, CallOptions options)

Moves the specified address resource from one project to another project.

Parameters
Name	Description
request	MoveGlobalAddressRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Operation	The response received from the server.

Move(MoveGlobalAddressRequest, Metadata, DateTime?, CancellationToken)

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

Moves the specified address resource from one project to another project.

Parameters
Name	Description
request	MoveGlobalAddressRequest 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
Operation	The response received from the server.

MoveAsync(MoveGlobalAddressRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> MoveAsync(MoveGlobalAddressRequest request, CallOptions options)

Moves the specified address resource from one project to another project.

Parameters
Name	Description
request	MoveGlobalAddressRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

MoveAsync(MoveGlobalAddressRequest, Metadata, DateTime?, CancellationToken)

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

Moves the specified address resource from one project to another project.

Parameters
Name	Description
request	MoveGlobalAddressRequest 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
AsyncUnaryCallOperation	The call object.

NewInstance(ClientBaseConfiguration)

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

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name	Description
configuration	ClientBaseClientBaseConfiguration

Returns
Type	Description
GlobalAddressesGlobalAddressesClient

Overrides

ClientBase<GlobalAddresses.GlobalAddressesClient>.NewInstance(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
Name	Description
request	SetLabelsGlobalAddressRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Operation	The response received from the server.

SetLabels(SetLabelsGlobalAddressRequest, Metadata, DateTime?, CancellationToken)

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

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

Parameters
Name	Description
request	SetLabelsGlobalAddressRequest 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
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
Name	Description
request	SetLabelsGlobalAddressRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

SetLabelsAsync(SetLabelsGlobalAddressRequest, Metadata, DateTime?, CancellationToken)

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

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

Parameters
Name	Description
request	SetLabelsGlobalAddressRequest 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
AsyncUnaryCallOperation	The call object.