Compute Engine v1 API - Class Addresses.AddressesClient (3.0.0)

Version latest

• 3.0.0 (latest)
• 2.17.0
• 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 Addresses.AddressesClient : ClientBase<Addresses.AddressesClient>

Reference documentation and code samples for the Compute Engine v1 API class Addresses.AddressesClient.

Client for Addresses

Inheritance

object > ClientBase > ClientBaseAddressesAddressesClient > Addresses.AddressesClient

Inherited Members

ClientBase<Addresses.AddressesClient>.WithHost(string)

ClientBase.CallInvoker

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

Google.Cloud.Compute.V1

Assembly

Google.Cloud.Compute.V1.dll

Constructors

AddressesClient()

protected AddressesClient()

Protected parameterless constructor to allow creation of test doubles.

AddressesClient(CallInvoker)

public AddressesClient(CallInvoker callInvoker)

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

Parameter
Name	Description
callInvoker	CallInvoker The callInvoker to use to make remote calls.

AddressesClient(ChannelBase)

public AddressesClient(ChannelBase channel)

Creates a new client for Addresses

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

AddressesClient(ClientBaseConfiguration)

protected AddressesClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name	Description
configuration	ClientBaseClientBaseConfiguration The client configuration.

Methods

AggregatedList(AggregatedListAddressesRequest, CallOptions)

public virtual AddressAggregatedList AggregatedList(AggregatedListAddressesRequest request, CallOptions options)

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

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

Returns
Type	Description
AddressAggregatedList	The response received from the server.

AggregatedList(AggregatedListAddressesRequest, Metadata, DateTime?, CancellationToken)

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

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

Parameters
Name	Description
request	AggregatedListAddressesRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.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
AddressAggregatedList	The response received from the server.

AggregatedListAsync(AggregatedListAddressesRequest, CallOptions)

public virtual AsyncUnaryCall<AddressAggregatedList> AggregatedListAsync(AggregatedListAddressesRequest request, CallOptions options)

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

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

Returns
Type	Description
AsyncUnaryCallAddressAggregatedList	The call object.

AggregatedListAsync(AggregatedListAddressesRequest, Metadata, DateTime?, CancellationToken)

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

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

Parameters
Name	Description
request	AggregatedListAddressesRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.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
AsyncUnaryCallAddressAggregatedList	The call object.

CreateOperationsClientForRegionOperations()

public virtual Operations.OperationsClient CreateOperationsClientForRegionOperations()

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

Returns
Type	Description
OperationsOperationsClient	A new Operations client for the same target as this client.

Delete(DeleteAddressRequest, CallOptions)

public virtual Operation Delete(DeleteAddressRequest request, CallOptions options)

Deletes the specified address resource.

Parameters
Name	Description
request	DeleteAddressRequest 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(DeleteAddressRequest, Metadata, DateTime?, CancellationToken)

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

Deletes the specified address resource.

Parameters
Name	Description
request	DeleteAddressRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.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(DeleteAddressRequest, CallOptions)

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

Deletes the specified address resource.

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

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

DeleteAsync(DeleteAddressRequest, Metadata, DateTime?, CancellationToken)

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

Deletes the specified address resource.

Parameters
Name	Description
request	DeleteAddressRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.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(GetAddressRequest, CallOptions)

public virtual Address Get(GetAddressRequest request, CallOptions options)

Returns the specified address resource.

Parameters
Name	Description
request	GetAddressRequest 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(GetAddressRequest, Metadata, DateTime?, CancellationToken)

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

Returns the specified address resource.

Parameters
Name	Description
request	GetAddressRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.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(GetAddressRequest, CallOptions)

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

Returns the specified address resource.

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

Returns
Type	Description
AsyncUnaryCallAddress	The call object.

GetAsync(GetAddressRequest, Metadata, DateTime?, CancellationToken)

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

Returns the specified address resource.

Parameters
Name	Description
request	GetAddressRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.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(InsertAddressRequest, CallOptions)

public virtual Operation Insert(InsertAddressRequest request, CallOptions options)

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

Parameters
Name	Description
request	InsertAddressRequest 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(InsertAddressRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation Insert(InsertAddressRequest 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	InsertAddressRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.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(InsertAddressRequest, CallOptions)

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

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

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

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

InsertAsync(InsertAddressRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> InsertAsync(InsertAddressRequest 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	InsertAddressRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.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(ListAddressesRequest, CallOptions)

public virtual AddressList List(ListAddressesRequest request, CallOptions options)

Retrieves a list of addresses contained within the specified region.

Parameters
Name	Description
request	ListAddressesRequest 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(ListAddressesRequest, Metadata, DateTime?, CancellationToken)

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

Retrieves a list of addresses contained within the specified region.

Parameters
Name	Description
request	ListAddressesRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.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(ListAddressesRequest, CallOptions)

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

Retrieves a list of addresses contained within the specified region.

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

Returns
Type	Description
AsyncUnaryCallAddressList	The call object.

ListAsync(ListAddressesRequest, Metadata, DateTime?, CancellationToken)

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

Retrieves a list of addresses contained within the specified region.

Parameters
Name	Description
request	ListAddressesRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.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(MoveAddressRequest, CallOptions)

public virtual Operation Move(MoveAddressRequest request, CallOptions options)

Moves the specified address resource.

Parameters
Name	Description
request	MoveAddressRequest 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(MoveAddressRequest, Metadata, DateTime?, CancellationToken)

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

Moves the specified address resource.

Parameters
Name	Description
request	MoveAddressRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.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(MoveAddressRequest, CallOptions)

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

Moves the specified address resource.

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

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

MoveAsync(MoveAddressRequest, Metadata, DateTime?, CancellationToken)

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

Moves the specified address resource.

Parameters
Name	Description
request	MoveAddressRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.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 Addresses.AddressesClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name	Description
configuration	ClientBaseClientBaseConfiguration

Returns
Type	Description
AddressesAddressesClient

Overrides

Grpc.Core.ClientBase<Google.Cloud.Compute.V1.Addresses.AddressesClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)

SetLabels(SetLabelsAddressRequest, CallOptions)

public virtual Operation SetLabels(SetLabelsAddressRequest request, CallOptions options)

Sets the labels on an Address. To learn more about labels, read the Labeling Resources documentation.

Parameters
Name	Description
request	SetLabelsAddressRequest 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(SetLabelsAddressRequest, Metadata, DateTime?, CancellationToken)

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

Sets the labels on an Address. To learn more about labels, read the Labeling Resources documentation.

Parameters
Name	Description
request	SetLabelsAddressRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.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(SetLabelsAddressRequest, CallOptions)

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

Sets the labels on an Address. To learn more about labels, read the Labeling Resources documentation.

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

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

SetLabelsAsync(SetLabelsAddressRequest, Metadata, DateTime?, CancellationToken)

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

Sets the labels on an Address. To learn more about labels, read the Labeling Resources documentation.

Parameters
Name	Description
request	SetLabelsAddressRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.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.