Compute Engine v1 API - Class AddressesClientImpl (2.6.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, Nullable<Int32>, CallSettings)

AddressesClient.AggregatedListAsync(String, String, Nullable<Int32>, 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, Nullable<Int32>, CallSettings)

AddressesClient.ListAsync(String, String, String, Nullable<Int32>, CallSettings)

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.MemberwiseClone()

Object.ToString()

Namespace

Google.Cloud.Compute.V1

Assembly

Google.Cloud.Compute.V1.dll

Remarks

The Addresses API.

Constructors

AddressesClientImpl(Addresses.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`	`Addresses.AddressesClient` 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
`Addresses.AddressesClient`

Overrides

AddressesClient.GrpcClient

InsertOperationsClient

public override OperationsClient InsertOperationsClient { get; }

The long-running operations client for Insert.

Property Value
Type	Description
`OperationsClient`

Overrides

AddressesClient.InsertOperationsClient

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.

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
`PagedEnumerable<AddressAggregatedList, KeyValuePair<String, AddressesScopedList>>`	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.

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
`PagedAsyncEnumerable<AddressAggregatedList, KeyValuePair<String, AddressesScopedList>>`	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
`Operation<Operation, Operation>`	The RPC response.

Overrides

AddressesClient.Delete(DeleteAddressRequest, CallSettings)

DeleteAsync(DeleteAddressRequest, CallSettings)

public override async 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
`Task<Operation<Operation, Operation>>`	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
`Task<Address>`	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
`Operation<Operation, Operation>`	The RPC response.

Overrides

AddressesClient.Insert(InsertAddressRequest, CallSettings)

InsertAsync(InsertAddressRequest, CallSettings)

public override async 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
`Task<Operation<Operation, Operation>>`	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
`PagedEnumerable<AddressList, Address>`	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
`PagedAsyncEnumerable<AddressList, Address>`	A pageable asynchronous sequence of Address resources.

Overrides

AddressesClient.ListAsync(ListAddressesRequest, 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
`Operation<Operation, Operation>`	The RPC response.

Overrides

AddressesClient.SetLabels(SetLabelsAddressRequest, CallSettings)

SetLabelsAsync(SetLabelsAddressRequest, CallSettings)

public override async 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
`Task<Operation<Operation, Operation>>`	A Task containing the RPC response.

Overrides

AddressesClient.SetLabelsAsync(SetLabelsAddressRequest, CallSettings)