Compute Engine v1 API - Class AddressesClientImpl (3.0.0) 

public sealed class AddressesClientImpl : AddressesClient

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

Addresses client wrapper implementation, for convenient use.

Inheritance

object > AddressesClient > AddressesClientImpl

Namespace

Google.Cloud.Compute.V1

Assembly

Google.Cloud.Compute.V1.dll

Remarks

The Addresses API.

Constructors

AddressesClientImpl(AddressesClient, AddressesSettings, ILogger)

public AddressesClientImpl(Addresses.AddressesClient grpcClient, AddressesSettings settings, ILogger logger)

Constructs a client wrapper for the Addresses service, with the specified gRPC client and settings.

Parameters
Name Description
grpcClient AddressesAddressesClient

The underlying gRPC client.
settings AddressesSettings

The base AddressesSettings used within this client.
logger ILogger

Optional ILogger to use within this client.

Properties

DeleteOperationsClient

public override OperationsClient DeleteOperationsClient { get; }

The long-running operations client for Delete.

Property Value
Type Description
OperationsClient
Overrides

GrpcClient

public override Addresses.AddressesClient GrpcClient { get; }

The underlying gRPC Addresses client

Property Value
Type Description
AddressesAddressesClient
Overrides

InsertOperationsClient

public override OperationsClient InsertOperationsClient { get; }

The long-running operations client for Insert.

Property Value
Type Description
OperationsClient
Overrides

MoveOperationsClient

public override OperationsClient MoveOperationsClient { get; }

The long-running operations client for Move.

Property Value
Type Description
OperationsClient
Overrides

SetLabelsOperationsClient

public override OperationsClient SetLabelsOperationsClient { get; }

The long-running operations client for SetLabels.

Property Value
Type Description
OperationsClient
Overrides

Methods

AggregatedList(AggregatedListAddressesRequest, CallSettings)

public override PagedEnumerable<AddressAggregatedList, KeyValuePair<string, AddressesScopedList>> AggregatedList(AggregatedListAddressesRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableAddressAggregatedListKeyValuePairstringAddressesScopedList

A pageable sequence of KeyValuePair<TKey, TValue> resources.
Overrides

AggregatedListAsync(AggregatedListAddressesRequest, CallSettings)

public override PagedAsyncEnumerable<AddressAggregatedList, KeyValuePair<string, AddressesScopedList>> AggregatedListAsync(AggregatedListAddressesRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableAddressAggregatedListKeyValuePairstringAddressesScopedList

A pageable asynchronous sequence of KeyValuePair<TKey, TValue> resources.
Overrides

Delete(DeleteAddressRequest, CallSettings)

public override Operation<Operation, Operation> Delete(DeleteAddressRequest request, CallSettings callSettings = null)

Deletes the specified address resource.

Parameters
Name Description
request DeleteAddressRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationOperationOperation

The RPC response.
Overrides

DeleteAsync(DeleteAddressRequest, CallSettings)

public override Task<Operation<Operation, Operation>> DeleteAsync(DeleteAddressRequest request, CallSettings callSettings = null)

Deletes the specified address resource.

Parameters
Name Description
request DeleteAddressRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationOperationOperation

A Task containing the RPC response.
Overrides

Get(GetAddressRequest, CallSettings)

public override Address Get(GetAddressRequest request, CallSettings callSettings = null)

Returns the specified address resource.

Parameters
Name Description
request GetAddressRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Address

The RPC response.
Overrides

GetAsync(GetAddressRequest, CallSettings)

public override Task<Address> GetAsync(GetAddressRequest request, CallSettings callSettings = null)

Returns the specified address resource.

Parameters
Name Description
request GetAddressRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskAddress

A Task containing the RPC response.
Overrides

Insert(InsertAddressRequest, CallSettings)

public override Operation<Operation, Operation> Insert(InsertAddressRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request InsertAddressRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationOperationOperation

The RPC response.
Overrides

InsertAsync(InsertAddressRequest, CallSettings)

public override Task<Operation<Operation, Operation>> InsertAsync(InsertAddressRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request InsertAddressRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationOperationOperation

A Task containing the RPC response.
Overrides

List(ListAddressesRequest, CallSettings)

public override PagedEnumerable<AddressList, Address> List(ListAddressesRequest request, CallSettings callSettings = null)

Retrieves a list of addresses contained within the specified region.

Parameters
Name Description
request ListAddressesRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableAddressListAddress

A pageable sequence of Address resources.
Overrides

ListAsync(ListAddressesRequest, CallSettings)

public override PagedAsyncEnumerable<AddressList, Address> ListAsync(ListAddressesRequest request, CallSettings callSettings = null)

Retrieves a list of addresses contained within the specified region.

Parameters
Name Description
request ListAddressesRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableAddressListAddress

A pageable asynchronous sequence of Address resources.
Overrides

Move(MoveAddressRequest, CallSettings)

public override Operation<Operation, Operation> Move(MoveAddressRequest request, CallSettings callSettings = null)

Moves the specified address resource.

Parameters
Name Description
request MoveAddressRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationOperationOperation

The RPC response.
Overrides

MoveAsync(MoveAddressRequest, CallSettings)

public override Task<Operation<Operation, Operation>> MoveAsync(MoveAddressRequest request, CallSettings callSettings = null)

Moves the specified address resource.

Parameters
Name Description
request MoveAddressRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationOperationOperation

A Task containing the RPC response.
Overrides

SetLabels(SetLabelsAddressRequest, CallSettings)

public override Operation<Operation, Operation> SetLabels(SetLabelsAddressRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request SetLabelsAddressRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationOperationOperation

The RPC response.
Overrides

SetLabelsAsync(SetLabelsAddressRequest, CallSettings)

public override Task<Operation<Operation, Operation>> SetLabelsAsync(SetLabelsAddressRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request SetLabelsAddressRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationOperationOperation

A Task containing the RPC response.
Overrides