Compute Engine v1 API - Class AddressesClientImpl (3.1.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

Inherited Members

AddressesClient.DefaultEndpoint

AddressesClient.DefaultScopes

AddressesClient.ServiceMetadata

AddressesClient.CreateAsync(CancellationToken)

AddressesClient.Create()

AddressesClient.ShutdownDefaultChannelsAsync()

AddressesClient.AggregatedList(string, string, int?, CallSettings)

AddressesClient.AggregatedListAsync(string, string, int?, CallSettings)

AddressesClient.DeleteAsync(DeleteAddressRequest, CancellationToken)

AddressesClient.PollOnceDelete(string, CallSettings)

AddressesClient.PollOnceDeleteAsync(string, CallSettings)

AddressesClient.Delete(string, string, string, CallSettings)

AddressesClient.DeleteAsync(string, string, string, CallSettings)

AddressesClient.DeleteAsync(string, string, string, CancellationToken)

AddressesClient.GetAsync(GetAddressRequest, CancellationToken)

AddressesClient.Get(string, string, string, CallSettings)

AddressesClient.GetAsync(string, string, string, CallSettings)

AddressesClient.GetAsync(string, string, string, CancellationToken)

AddressesClient.InsertAsync(InsertAddressRequest, CancellationToken)

AddressesClient.PollOnceInsert(string, CallSettings)

AddressesClient.PollOnceInsertAsync(string, CallSettings)

AddressesClient.Insert(string, string, Address, CallSettings)

AddressesClient.InsertAsync(string, string, Address, CallSettings)

AddressesClient.InsertAsync(string, string, Address, CancellationToken)

AddressesClient.List(string, string, string, int?, CallSettings)

AddressesClient.ListAsync(string, string, string, int?, CallSettings)

AddressesClient.MoveAsync(MoveAddressRequest, CancellationToken)

AddressesClient.PollOnceMove(string, CallSettings)

AddressesClient.PollOnceMoveAsync(string, CallSettings)

AddressesClient.Move(string, string, string, RegionAddressesMoveRequest, CallSettings)

AddressesClient.MoveAsync(string, string, string, RegionAddressesMoveRequest, CallSettings)

AddressesClient.MoveAsync(string, string, string, RegionAddressesMoveRequest, CancellationToken)

AddressesClient.SetLabelsAsync(SetLabelsAddressRequest, CancellationToken)

AddressesClient.PollOnceSetLabels(string, CallSettings)

AddressesClient.PollOnceSetLabelsAsync(string, CallSettings)

AddressesClient.SetLabels(string, string, string, RegionSetLabelsRequest, CallSettings)

AddressesClient.SetLabelsAsync(string, string, string, RegionSetLabelsRequest, CallSettings)

AddressesClient.SetLabelsAsync(string, string, string, RegionSetLabelsRequest, CancellationToken)

object.GetHashCode()

object.GetType()

object.ToString()

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

AddressesClient.DeleteOperationsClient

GrpcClient

public override Addresses.AddressesClient GrpcClient { get; }

The underlying gRPC Addresses client

Property Value
Type	Description
`AddressesAddressesClient`

Overrides

AddressesClient.GrpcClient

InsertOperationsClient

public override OperationsClient InsertOperationsClient { get; }

The long-running operations client for Insert.

Property Value
Type	Description
`OperationsClient`

Overrides

AddressesClient.InsertOperationsClient

MoveOperationsClient

public override OperationsClient MoveOperationsClient { get; }

The long-running operations client for Move.

Property Value
Type	Description
`OperationsClient`

Overrides

AddressesClient.MoveOperationsClient

SetLabelsOperationsClient

public override OperationsClient SetLabelsOperationsClient { get; }

The long-running operations client for SetLabels.

Property Value
Type	Description
`OperationsClient`

Overrides

AddressesClient.SetLabelsOperationsClient

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

AddressesClient.AggregatedList(AggregatedListAddressesRequest, CallSettings)

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

AddressesClient.AggregatedListAsync(AggregatedListAddressesRequest, CallSettings)

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

AddressesClient.Delete(DeleteAddressRequest, CallSettings)

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

AddressesClient.DeleteAsync(DeleteAddressRequest, CallSettings)

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

AddressesClient.Get(GetAddressRequest, CallSettings)

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

AddressesClient.GetAsync(GetAddressRequest, CallSettings)

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

AddressesClient.Insert(InsertAddressRequest, CallSettings)

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

AddressesClient.InsertAsync(InsertAddressRequest, CallSettings)

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

AddressesClient.List(ListAddressesRequest, CallSettings)

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

AddressesClient.ListAsync(ListAddressesRequest, CallSettings)

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

AddressesClient.Move(MoveAddressRequest, CallSettings)

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

AddressesClient.MoveAsync(MoveAddressRequest, CallSettings)

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

AddressesClient.SetLabels(SetLabelsAddressRequest, CallSettings)

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

AddressesClient.SetLabelsAsync(SetLabelsAddressRequest, CallSettings)