public abstract class AddressesClientReference documentation and code samples for the Compute Engine v1 API class AddressesClient.
Addresses client wrapper, for convenient use. This client implements API version 2026-09-01.
Derived Types
Namespace
Google.Cloud.Compute.V1Assembly
Google.Cloud.Compute.V1.dll
Remarks
The Addresses API.
Properties
DefaultEndpoint
public static string DefaultEndpoint { get; }The default endpoint for the Addresses service, which is a host of "compute.googleapis.com" and a port of 443.
| Property Value | |
|---|---|
| Type | Description |
string |
|
DefaultScopes
public static IReadOnlyList<string> DefaultScopes { get; }The default Addresses scopes.
| Property Value | |
|---|---|
| Type | Description |
IReadOnlyListstring |
|
The default Addresses scopes are:
DeleteOperationsClient
public virtual OperationsClient DeleteOperationsClient { get; }The long-running operations client for Delete.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient |
|
GrpcClient
public virtual Addresses.AddressesClient GrpcClient { get; }The underlying gRPC Addresses client
| Property Value | |
|---|---|
| Type | Description |
AddressesAddressesClient |
|
InsertOperationsClient
public virtual OperationsClient InsertOperationsClient { get; }The long-running operations client for Insert.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient |
|
MoveOperationsClient
public virtual OperationsClient MoveOperationsClient { get; }The long-running operations client for Move.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient |
|
ServiceMetadata
public static ServiceMetadata ServiceMetadata { get; }The service metadata associated with this client type.
| Property Value | |
|---|---|
| Type | Description |
ServiceMetadata |
|
SetLabelsOperationsClient
public virtual OperationsClient SetLabelsOperationsClient { get; }The long-running operations client for SetLabels.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient |
|
Methods
AggregatedList(AggregatedListAddressesRequest, CallSettings)
public virtual PagedEnumerable<AddressAggregatedList, KeyValuePair<string, AddressesScopedList>> AggregatedList(AggregatedListAddressesRequest request, CallSettings callSettings = null)Retrieves an aggregated list of addresses.
To prevent failure, it is recommended that you set the
returnPartialSuccess parameter to true.
| Parameters | |
|---|---|
| Name | Description |
request |
AggregatedListAddressesRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedEnumerableAddressAggregatedListKeyValuePairstringAddressesScopedList |
A pageable sequence of KeyValuePair<TKey, TValue> resources. |
// Create client
AddressesClient addressesClient = AddressesClient.Create();
// Initialize request argument(s)
AggregatedListAddressesRequest request = new AggregatedListAddressesRequest
{
OrderBy = "",
Project = "",
ServiceProjectNumber = 0L,
Filter = "",
IncludeAllScopes = false,
};
// Make the request
PagedEnumerable<AddressAggregatedList, KeyValuePair<string, AddressesScopedList>> response = addressesClient.AggregatedList(request);
// Iterate over all response items, lazily performing RPCs as required
foreach (KeyValuePair<string, AddressesScopedList> item in response)
{
// Do something with each item
Console.WriteLine(item);
}
// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (AddressAggregatedList page in response.AsRawResponses())
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (KeyValuePair<string, AddressesScopedList> item in page)
{
// Do something with each item
Console.WriteLine(item);
}
}
// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<KeyValuePair<string, AddressesScopedList>> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (KeyValuePair<string, AddressesScopedList> item in singlePage)
{
// Do something with each item
Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;
AggregatedList(string, string, int?, CallSettings)
public virtual PagedEnumerable<AddressAggregatedList, KeyValuePair<string, AddressesScopedList>> AggregatedList(string project, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)Retrieves an aggregated list of addresses.
To prevent failure, it is recommended that you set the
returnPartialSuccess parameter to true.
| Parameters | |
|---|---|
| Name | Description |
project |
stringProject ID for this request. |
pageToken |
stringThe token returned from the previous request. A value of |
pageSize |
intThe size of page to request. The response will not be larger than this, but may be smaller. A value of
|
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedEnumerableAddressAggregatedListKeyValuePairstringAddressesScopedList |
A pageable sequence of KeyValuePair<TKey, TValue> resources. |
// Create client
AddressesClient addressesClient = AddressesClient.Create();
// Initialize request argument(s)
string project = "";
// Make the request
PagedEnumerable<AddressAggregatedList, KeyValuePair<string, AddressesScopedList>> response = addressesClient.AggregatedList(project);
// Iterate over all response items, lazily performing RPCs as required
foreach (KeyValuePair<string, AddressesScopedList> item in response)
{
// Do something with each item
Console.WriteLine(item);
}
// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (AddressAggregatedList page in response.AsRawResponses())
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (KeyValuePair<string, AddressesScopedList> item in page)
{
// Do something with each item
Console.WriteLine(item);
}
}
// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<KeyValuePair<string, AddressesScopedList>> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (KeyValuePair<string, AddressesScopedList> item in singlePage)
{
// Do something with each item
Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;
AggregatedListAsync(AggregatedListAddressesRequest, CallSettings)
public virtual PagedAsyncEnumerable<AddressAggregatedList, KeyValuePair<string, AddressesScopedList>> AggregatedListAsync(AggregatedListAddressesRequest request, CallSettings callSettings = null)Retrieves an aggregated list of addresses.
To prevent failure, it is recommended that you set the
returnPartialSuccess parameter to true.
| Parameters | |
|---|---|
| Name | Description |
request |
AggregatedListAddressesRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedAsyncEnumerableAddressAggregatedListKeyValuePairstringAddressesScopedList |
A pageable asynchronous sequence of KeyValuePair<TKey, TValue> resources. |
// Create client
AddressesClient addressesClient = await AddressesClient.CreateAsync();
// Initialize request argument(s)
AggregatedListAddressesRequest request = new AggregatedListAddressesRequest
{
OrderBy = "",
Project = "",
ServiceProjectNumber = 0L,
Filter = "",
IncludeAllScopes = false,
};
// Make the request
PagedAsyncEnumerable<AddressAggregatedList, KeyValuePair<string, AddressesScopedList>> response = addressesClient.AggregatedListAsync(request);
// Iterate over all response items, lazily performing RPCs as required
await foreach (KeyValuePair<string, AddressesScopedList> item in response)
{
// Do something with each item
Console.WriteLine(item);
}
// Or iterate over pages (of server-defined size), performing one RPC per page
await foreach (AddressAggregatedList page in response.AsRawResponses())
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (KeyValuePair<string, AddressesScopedList> item in page)
{
// Do something with each item
Console.WriteLine(item);
}
}
// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<KeyValuePair<string, AddressesScopedList>> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (KeyValuePair<string, AddressesScopedList> item in singlePage)
{
// Do something with each item
Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;
AggregatedListAsync(string, string, int?, CallSettings)
public virtual PagedAsyncEnumerable<AddressAggregatedList, KeyValuePair<string, AddressesScopedList>> AggregatedListAsync(string project, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)Retrieves an aggregated list of addresses.
To prevent failure, it is recommended that you set the
returnPartialSuccess parameter to true.
| Parameters | |
|---|---|
| Name | Description |
project |
stringProject ID for this request. |
pageToken |
stringThe token returned from the previous request. A value of |
pageSize |
intThe size of page to request. The response will not be larger than this, but may be smaller. A value of
|
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedAsyncEnumerableAddressAggregatedListKeyValuePairstringAddressesScopedList |
A pageable asynchronous sequence of KeyValuePair<TKey, TValue> resources. |
// Create client
AddressesClient addressesClient = await AddressesClient.CreateAsync();
// Initialize request argument(s)
string project = "";
// Make the request
PagedAsyncEnumerable<AddressAggregatedList, KeyValuePair<string, AddressesScopedList>> response = addressesClient.AggregatedListAsync(project);
// Iterate over all response items, lazily performing RPCs as required
await foreach (KeyValuePair<string, AddressesScopedList> item in response)
{
// Do something with each item
Console.WriteLine(item);
}
// Or iterate over pages (of server-defined size), performing one RPC per page
await foreach (AddressAggregatedList page in response.AsRawResponses())
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (KeyValuePair<string, AddressesScopedList> item in page)
{
// Do something with each item
Console.WriteLine(item);
}
}
// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<KeyValuePair<string, AddressesScopedList>> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (KeyValuePair<string, AddressesScopedList> item in singlePage)
{
// Do something with each item
Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;
Create()
public static AddressesClient Create()Synchronously creates a AddressesClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use AddressesClientBuilder.
| Returns | |
|---|---|
| Type | Description |
AddressesClient |
The created AddressesClient. |
CreateAsync(CancellationToken)
public static Task<AddressesClient> CreateAsync(CancellationToken cancellationToken = default)Asynchronously creates a AddressesClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use AddressesClientBuilder.
| Parameter | |
|---|---|
| Name | Description |
cancellationToken |
CancellationTokenThe CancellationToken to use while creating the client. |
| Returns | |
|---|---|
| Type | Description |
TaskAddressesClient |
The task representing the created AddressesClient. |
Delete(DeleteAddressRequest, CallSettings)
public virtual Operation<Operation, Operation> Delete(DeleteAddressRequest request, CallSettings callSettings = null)Deletes the specified address resource.
| Parameters | |
|---|---|
| Name | Description |
request |
DeleteAddressRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationOperationOperation |
The RPC response. |
// Create client
AddressesClient addressesClient = AddressesClient.Create();
// Initialize request argument(s)
DeleteAddressRequest request = new DeleteAddressRequest
{
RequestId = "",
Region = "",
Project = "",
Address = "",
};
// Make the request
lro::Operation<Operation, Operation> response = addressesClient.Delete(request);
// Poll until the returned long-running operation is complete
lro::Operation<Operation, Operation> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Operation result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
lro::Operation<Operation, Operation> retrievedResponse = addressesClient.PollOnceDelete(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Operation retrievedResult = retrievedResponse.Result;
}
Delete(string, string, string, CallSettings)
public virtual Operation<Operation, Operation> Delete(string project, string region, string address, CallSettings callSettings = null)Deletes the specified address resource.
| Parameters | |
|---|---|
| Name | Description |
project |
stringProject ID for this request. |
region |
stringName of the region for this request. |
address |
stringName of the address resource to delete. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationOperationOperation |
The RPC response. |
// Create client
AddressesClient addressesClient = AddressesClient.Create();
// Initialize request argument(s)
string project = "";
string region = "";
string address = "";
// Make the request
lro::Operation<Operation, Operation> response = addressesClient.Delete(project, region, address);
// Poll until the returned long-running operation is complete
lro::Operation<Operation, Operation> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Operation result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
lro::Operation<Operation, Operation> retrievedResponse = addressesClient.PollOnceDelete(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Operation retrievedResult = retrievedResponse.Result;
}
DeleteAsync(DeleteAddressRequest, CallSettings)
public virtual Task<Operation<Operation, Operation>> DeleteAsync(DeleteAddressRequest request, CallSettings callSettings = null)Deletes the specified address resource.
| Parameters | |
|---|---|
| Name | Description |
request |
DeleteAddressRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationOperationOperation |
A Task containing the RPC response. |
// Create client
AddressesClient addressesClient = await AddressesClient.CreateAsync();
// Initialize request argument(s)
DeleteAddressRequest request = new DeleteAddressRequest
{
RequestId = "",
Region = "",
Project = "",
Address = "",
};
// Make the request
lro::Operation<Operation, Operation> response = await addressesClient.DeleteAsync(request);
// Poll until the returned long-running operation is complete
lro::Operation<Operation, Operation> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Operation result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
lro::Operation<Operation, Operation> retrievedResponse = await addressesClient.PollOnceDeleteAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Operation retrievedResult = retrievedResponse.Result;
}
DeleteAsync(DeleteAddressRequest, CancellationToken)
public virtual Task<Operation<Operation, Operation>> DeleteAsync(DeleteAddressRequest request, CancellationToken cancellationToken)Deletes the specified address resource.
| Parameters | |
|---|---|
| Name | Description |
request |
DeleteAddressRequestThe request object containing all of the parameters for the API call. |
cancellationToken |
CancellationTokenA CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationOperationOperation |
A Task containing the RPC response. |
// Create client
AddressesClient addressesClient = await AddressesClient.CreateAsync();
// Initialize request argument(s)
DeleteAddressRequest request = new DeleteAddressRequest
{
RequestId = "",
Region = "",
Project = "",
Address = "",
};
// Make the request
lro::Operation<Operation, Operation> response = await addressesClient.DeleteAsync(request);
// Poll until the returned long-running operation is complete
lro::Operation<Operation, Operation> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Operation result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
lro::Operation<Operation, Operation> retrievedResponse = await addressesClient.PollOnceDeleteAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Operation retrievedResult = retrievedResponse.Result;
}
DeleteAsync(string, string, string, CallSettings)
public virtual Task<Operation<Operation, Operation>> DeleteAsync(string project, string region, string address, CallSettings callSettings = null)Deletes the specified address resource.
| Parameters | |
|---|---|
| Name | Description |
project |
stringProject ID for this request. |
region |
stringName of the region for this request. |
address |
stringName of the address resource to delete. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationOperationOperation |
A Task containing the RPC response. |
// Create client
AddressesClient addressesClient = await AddressesClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string region = "";
string address = "";
// Make the request
lro::Operation<Operation, Operation> response = await addressesClient.DeleteAsync(project, region, address);
// Poll until the returned long-running operation is complete
lro::Operation<Operation, Operation> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Operation result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
lro::Operation<Operation, Operation> retrievedResponse = await addressesClient.PollOnceDeleteAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Operation retrievedResult = retrievedResponse.Result;
}
DeleteAsync(string, string, string, CancellationToken)
public virtual Task<Operation<Operation, Operation>> DeleteAsync(string project, string region, string address, CancellationToken cancellationToken)Deletes the specified address resource.
| Parameters | |
|---|---|
| Name | Description |
project |
stringProject ID for this request. |
region |
stringName of the region for this request. |
address |
stringName of the address resource to delete. |
cancellationToken |
CancellationTokenA CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationOperationOperation |
A Task containing the RPC response. |
// Create client
AddressesClient addressesClient = await AddressesClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string region = "";
string address = "";
// Make the request
lro::Operation<Operation, Operation> response = await addressesClient.DeleteAsync(project, region, address);
// Poll until the returned long-running operation is complete
lro::Operation<Operation, Operation> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Operation result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
lro::Operation<Operation, Operation> retrievedResponse = await addressesClient.PollOnceDeleteAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Operation retrievedResult = retrievedResponse.Result;
}
Get(GetAddressRequest, CallSettings)
public virtual Address Get(GetAddressRequest request, CallSettings callSettings = null)Returns the specified address resource.
| Parameters | |
|---|---|
| Name | Description |
request |
GetAddressRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Address |
The RPC response. |
// Create client
AddressesClient addressesClient = AddressesClient.Create();
// Initialize request argument(s)
GetAddressRequest request = new GetAddressRequest
{
Region = "",
Project = "",
Address = "",
};
// Make the request
Address response = addressesClient.Get(request);
Get(string, string, string, CallSettings)
public virtual Address Get(string project, string region, string address, CallSettings callSettings = null)Returns the specified address resource.
| Parameters | |
|---|---|
| Name | Description |
project |
stringProject ID for this request. |
region |
stringName of the region for this request. |
address |
stringName of the address resource to return. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Address |
The RPC response. |
// Create client
AddressesClient addressesClient = AddressesClient.Create();
// Initialize request argument(s)
string project = "";
string region = "";
string address = "";
// Make the request
Address response = addressesClient.Get(project, region, address);
GetAsync(GetAddressRequest, CallSettings)
public virtual Task<Address> GetAsync(GetAddressRequest request, CallSettings callSettings = null)Returns the specified address resource.
| Parameters | |
|---|---|
| Name | Description |
request |
GetAddressRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskAddress |
A Task containing the RPC response. |
// Create client
AddressesClient addressesClient = await AddressesClient.CreateAsync();
// Initialize request argument(s)
GetAddressRequest request = new GetAddressRequest
{
Region = "",
Project = "",
Address = "",
};
// Make the request
Address response = await addressesClient.GetAsync(request);
GetAsync(GetAddressRequest, CancellationToken)
public virtual Task<Address> GetAsync(GetAddressRequest request, CancellationToken cancellationToken)Returns the specified address resource.
| Parameters | |
|---|---|
| Name | Description |
request |
GetAddressRequestThe request object containing all of the parameters for the API call. |
cancellationToken |
CancellationTokenA CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
TaskAddress |
A Task containing the RPC response. |
// Create client
AddressesClient addressesClient = await AddressesClient.CreateAsync();
// Initialize request argument(s)
GetAddressRequest request = new GetAddressRequest
{
Region = "",
Project = "",
Address = "",
};
// Make the request
Address response = await addressesClient.GetAsync(request);
GetAsync(string, string, string, CallSettings)
public virtual Task<Address> GetAsync(string project, string region, string address, CallSettings callSettings = null)Returns the specified address resource.
| Parameters | |
|---|---|
| Name | Description |
project |
stringProject ID for this request. |
region |
stringName of the region for this request. |
address |
stringName of the address resource to return. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskAddress |
A Task containing the RPC response. |
// Create client
AddressesClient addressesClient = await AddressesClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string region = "";
string address = "";
// Make the request
Address response = await addressesClient.GetAsync(project, region, address);
GetAsync(string, string, string, CancellationToken)
public virtual Task<Address> GetAsync(string project, string region, string address, CancellationToken cancellationToken)Returns the specified address resource.
| Parameters | |
|---|---|
| Name | Description |
project |
stringProject ID for this request. |
region |
stringName of the region for this request. |
address |
stringName of the address resource to return. |
cancellationToken |
CancellationTokenA CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
TaskAddress |
A Task containing the RPC response. |
// Create client
AddressesClient addressesClient = await AddressesClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string region = "";
string address = "";
// Make the request
Address response = await addressesClient.GetAsync(project, region, address);
Insert(InsertAddressRequest, CallSettings)
public virtual 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 |
InsertAddressRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationOperationOperation |
The RPC response. |
// Create client
AddressesClient addressesClient = AddressesClient.Create();
// Initialize request argument(s)
InsertAddressRequest request = new InsertAddressRequest
{
RequestId = "",
Region = "",
Project = "",
AddressResource = new Address(),
};
// Make the request
lro::Operation<Operation, Operation> response = addressesClient.Insert(request);
// Poll until the returned long-running operation is complete
lro::Operation<Operation, Operation> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Operation result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
lro::Operation<Operation, Operation> retrievedResponse = addressesClient.PollOnceInsert(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Operation retrievedResult = retrievedResponse.Result;
}
Insert(string, string, Address, CallSettings)
public virtual Operation<Operation, Operation> Insert(string project, string region, Address addressResource, CallSettings callSettings = null)Creates an address resource in the specified project by using the data included in the request.
| Parameters | |
|---|---|
| Name | Description |
project |
stringProject ID for this request. |
region |
stringName of the region for this request. |
addressResource |
AddressThe body resource for this request |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationOperationOperation |
The RPC response. |
// Create client
AddressesClient addressesClient = AddressesClient.Create();
// Initialize request argument(s)
string project = "";
string region = "";
Address addressResource = new Address();
// Make the request
lro::Operation<Operation, Operation> response = addressesClient.Insert(project, region, addressResource);
// Poll until the returned long-running operation is complete
lro::Operation<Operation, Operation> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Operation result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
lro::Operation<Operation, Operation> retrievedResponse = addressesClient.PollOnceInsert(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Operation retrievedResult = retrievedResponse.Result;
}
InsertAsync(InsertAddressRequest, CallSettings)
public virtual 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 |
InsertAddressRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationOperationOperation |
A Task containing the RPC response. |
// Create client
AddressesClient addressesClient = await AddressesClient.CreateAsync();
// Initialize request argument(s)
InsertAddressRequest request = new InsertAddressRequest
{
RequestId = "",
Region = "",
Project = "",
AddressResource = new Address(),
};
// Make the request
lro::Operation<Operation, Operation> response = await addressesClient.InsertAsync(request);
// Poll until the returned long-running operation is complete
lro::Operation<Operation, Operation> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Operation result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
lro::Operation<Operation, Operation> retrievedResponse = await addressesClient.PollOnceInsertAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Operation retrievedResult = retrievedResponse.Result;
}
InsertAsync(InsertAddressRequest, CancellationToken)
public virtual Task<Operation<Operation, Operation>> InsertAsync(InsertAddressRequest request, CancellationToken cancellationToken)Creates an address resource in the specified project by using the data included in the request.
| Parameters | |
|---|---|
| Name | Description |
request |
InsertAddressRequestThe request object containing all of the parameters for the API call. |
cancellationToken |
CancellationTokenA CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationOperationOperation |
A Task containing the RPC response. |
// Create client
AddressesClient addressesClient = await AddressesClient.CreateAsync();
// Initialize request argument(s)
InsertAddressRequest request = new InsertAddressRequest
{
RequestId = "",
Region = "",
Project = "",
AddressResource = new Address(),
};
// Make the request
lro::Operation<Operation, Operation> response = await addressesClient.InsertAsync(request);
// Poll until the returned long-running operation is complete
lro::Operation<Operation, Operation> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Operation result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
lro::Operation<Operation, Operation> retrievedResponse = await addressesClient.PollOnceInsertAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Operation retrievedResult = retrievedResponse.Result;
}
InsertAsync(string, string, Address, CallSettings)
public virtual Task<Operation<Operation, Operation>> InsertAsync(string project, string region, Address addressResource, CallSettings callSettings = null)Creates an address resource in the specified project by using the data included in the request.
| Parameters | |
|---|---|
| Name | Description |
project |
stringProject ID for this request. |
region |
stringName of the region for this request. |
addressResource |
AddressThe body resource for this request |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationOperationOperation |
A Task containing the RPC response. |
// Create client
AddressesClient addressesClient = await AddressesClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string region = "";
Address addressResource = new Address();
// Make the request
lro::Operation<Operation, Operation> response = await addressesClient.InsertAsync(project, region, addressResource);
// Poll until the returned long-running operation is complete
lro::Operation<Operation, Operation> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Operation result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
lro::Operation<Operation, Operation> retrievedResponse = await addressesClient.PollOnceInsertAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Operation retrievedResult = retrievedResponse.Result;
}
InsertAsync(string, string, Address, CancellationToken)
public virtual Task<Operation<Operation, Operation>> InsertAsync(string project, string region, Address addressResource, CancellationToken cancellationToken)Creates an address resource in the specified project by using the data included in the request.
| Parameters | |
|---|---|
| Name | Description |
project |
stringProject ID for this request. |
region |
stringName of the region for this request. |
addressResource |
AddressThe body resource for this request |
cancellationToken |
CancellationTokenA CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationOperationOperation |
A Task containing the RPC response. |
// Create client
AddressesClient addressesClient = await AddressesClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string region = "";
Address addressResource = new Address();
// Make the request
lro::Operation<Operation, Operation> response = await addressesClient.InsertAsync(project, region, addressResource);
// Poll until the returned long-running operation is complete
lro::Operation<Operation, Operation> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Operation result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
lro::Operation<Operation, Operation> retrievedResponse = await addressesClient.PollOnceInsertAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Operation retrievedResult = retrievedResponse.Result;
}
List(ListAddressesRequest, CallSettings)
public virtual PagedEnumerable<AddressList, Address> List(ListAddressesRequest request, CallSettings callSettings = null)Retrieves a list of addresses contained within the specified region.
| Parameters | |
|---|---|
| Name | Description |
request |
ListAddressesRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedEnumerableAddressListAddress |
A pageable sequence of Address resources. |
// Create client
AddressesClient addressesClient = AddressesClient.Create();
// Initialize request argument(s)
ListAddressesRequest request = new ListAddressesRequest
{
Region = "",
OrderBy = "",
Project = "",
Filter = "",
};
// Make the request
PagedEnumerable<AddressList, Address> response = addressesClient.List(request);
// Iterate over all response items, lazily performing RPCs as required
foreach (Address item in response)
{
// Do something with each item
Console.WriteLine(item);
}
// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (AddressList page in response.AsRawResponses())
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (Address item in page)
{
// Do something with each item
Console.WriteLine(item);
}
}
// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Address> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Address item in singlePage)
{
// Do something with each item
Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;
List(string, string, string, int?, CallSettings)
public virtual PagedEnumerable<AddressList, Address> List(string project, string region, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)Retrieves a list of addresses contained within the specified region.
| Parameters | |
|---|---|
| Name | Description |
project |
stringProject ID for this request. |
region |
stringName of the region for this request. |
pageToken |
stringThe token returned from the previous request. A value of |
pageSize |
intThe size of page to request. The response will not be larger than this, but may be smaller. A value of
|
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedEnumerableAddressListAddress |
A pageable sequence of Address resources. |
// Create client
AddressesClient addressesClient = AddressesClient.Create();
// Initialize request argument(s)
string project = "";
string region = "";
// Make the request
PagedEnumerable<AddressList, Address> response = addressesClient.List(project, region);
// Iterate over all response items, lazily performing RPCs as required
foreach (Address item in response)
{
// Do something with each item
Console.WriteLine(item);
}
// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (AddressList page in response.AsRawResponses())
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (Address item in page)
{
// Do something with each item
Console.WriteLine(item);
}
}
// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Address> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Address item in singlePage)
{
// Do something with each item
Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;
ListAsync(ListAddressesRequest, CallSettings)
public virtual PagedAsyncEnumerable<AddressList, Address> ListAsync(ListAddressesRequest request, CallSettings callSettings = null)Retrieves a list of addresses contained within the specified region.
| Parameters | |
|---|---|
| Name | Description |
request |
ListAddressesRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedAsyncEnumerableAddressListAddress |
A pageable asynchronous sequence of Address resources. |
// Create client
AddressesClient addressesClient = await AddressesClient.CreateAsync();
// Initialize request argument(s)
ListAddressesRequest request = new ListAddressesRequest
{
Region = "",
OrderBy = "",
Project = "",
Filter = "",
};
// Make the request
PagedAsyncEnumerable<AddressList, Address> response = addressesClient.ListAsync(request);
// Iterate over all response items, lazily performing RPCs as required
await foreach (Address item in response)
{
// Do something with each item
Console.WriteLine(item);
}
// Or iterate over pages (of server-defined size), performing one RPC per page
await foreach (AddressList page in response.AsRawResponses())
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (Address item in page)
{
// Do something with each item
Console.WriteLine(item);
}
}
// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Address> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Address item in singlePage)
{
// Do something with each item
Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;
ListAsync(string, string, string, int?, CallSettings)
public virtual PagedAsyncEnumerable<AddressList, Address> ListAsync(string project, string region, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)Retrieves a list of addresses contained within the specified region.
| Parameters | |
|---|---|
| Name | Description |
project |
stringProject ID for this request. |
region |
stringName of the region for this request. |
pageToken |
stringThe token returned from the previous request. A value of |
pageSize |
intThe size of page to request. The response will not be larger than this, but may be smaller. A value of
|
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedAsyncEnumerableAddressListAddress |
A pageable asynchronous sequence of Address resources. |
// Create client
AddressesClient addressesClient = await AddressesClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string region = "";
// Make the request
PagedAsyncEnumerable<AddressList, Address> response = addressesClient.ListAsync(project, region);
// Iterate over all response items, lazily performing RPCs as required
await foreach (Address item in response)
{
// Do something with each item
Console.WriteLine(item);
}
// Or iterate over pages (of server-defined size), performing one RPC per page
await foreach (AddressList page in response.AsRawResponses())
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (Address item in page)
{
// Do something with each item
Console.WriteLine(item);
}
}
// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Address> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Address item in singlePage)
{
// Do something with each item
Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;
Move(MoveAddressRequest, CallSettings)
public virtual Operation<Operation, Operation> Move(MoveAddressRequest request, CallSettings callSettings = null)Moves the specified address resource.
| Parameters | |
|---|---|
| Name | Description |
request |
MoveAddressRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationOperationOperation |
The RPC response. |
// Create client
AddressesClient addressesClient = AddressesClient.Create();
// Initialize request argument(s)
MoveAddressRequest request = new MoveAddressRequest
{
RequestId = "",
Region = "",
Project = "",
RegionAddressesMoveRequestResource = new RegionAddressesMoveRequest(),
Address = "",
};
// Make the request
lro::Operation<Operation, Operation> response = addressesClient.Move(request);
// Poll until the returned long-running operation is complete
lro::Operation<Operation, Operation> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Operation result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
lro::Operation<Operation, Operation> retrievedResponse = addressesClient.PollOnceMove(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Operation retrievedResult = retrievedResponse.Result;
}
Move(string, string, string, RegionAddressesMoveRequest, CallSettings)
public virtual Operation<Operation, Operation> Move(string project, string region, string address, RegionAddressesMoveRequest regionAddressesMoveRequestResource, CallSettings callSettings = null)Moves the specified address resource.
| Parameters | |
|---|---|
| Name | Description |
project |
stringSource project ID which the Address is moved from. |
region |
stringName of the region for this request. |
address |
stringName of the address resource to move. |
regionAddressesMoveRequestResource |
RegionAddressesMoveRequestThe body resource for this request |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationOperationOperation |
The RPC response. |
// Create client
AddressesClient addressesClient = AddressesClient.Create();
// Initialize request argument(s)
string project = "";
string region = "";
string address = "";
RegionAddressesMoveRequest regionAddressesMoveRequestResource = new RegionAddressesMoveRequest();
// Make the request
lro::Operation<Operation, Operation> response = addressesClient.Move(project, region, address, regionAddressesMoveRequestResource);
// Poll until the returned long-running operation is complete
lro::Operation<Operation, Operation> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Operation result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
lro::Operation<Operation, Operation> retrievedResponse = addressesClient.PollOnceMove(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Operation retrievedResult = retrievedResponse.Result;
}
MoveAsync(MoveAddressRequest, CallSettings)
public virtual Task<Operation<Operation, Operation>> MoveAsync(MoveAddressRequest request, CallSettings callSettings = null)Moves the specified address resource.
| Parameters | |
|---|---|
| Name | Description |
request |
MoveAddressRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationOperationOperation |
A Task containing the RPC response. |
// Create client
AddressesClient addressesClient = await AddressesClient.CreateAsync();
// Initialize request argument(s)
MoveAddressRequest request = new MoveAddressRequest
{
RequestId = "",
Region = "",
Project = "",
RegionAddressesMoveRequestResource = new RegionAddressesMoveRequest(),
Address = "",
};
// Make the request
lro::Operation<Operation, Operation> response = await addressesClient.MoveAsync(request);
// Poll until the returned long-running operation is complete
lro::Operation<Operation, Operation> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Operation result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
lro::Operation<Operation, Operation> retrievedResponse = await addressesClient.PollOnceMoveAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Operation retrievedResult = retrievedResponse.Result;
}
MoveAsync(MoveAddressRequest, CancellationToken)
public virtual Task<Operation<Operation, Operation>> MoveAsync(MoveAddressRequest request, CancellationToken cancellationToken)Moves the specified address resource.
| Parameters | |
|---|---|
| Name | Description |
request |
MoveAddressRequestThe request object containing all of the parameters for the API call. |
cancellationToken |
CancellationTokenA CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationOperationOperation |
A Task containing the RPC response. |
// Create client
AddressesClient addressesClient = await AddressesClient.CreateAsync();
// Initialize request argument(s)
MoveAddressRequest request = new MoveAddressRequest
{
RequestId = "",
Region = "",
Project = "",
RegionAddressesMoveRequestResource = new RegionAddressesMoveRequest(),
Address = "",
};
// Make the request
lro::Operation<Operation, Operation> response = await addressesClient.MoveAsync(request);
// Poll until the returned long-running operation is complete
lro::Operation<Operation, Operation> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Operation result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
lro::Operation<Operation, Operation> retrievedResponse = await addressesClient.PollOnceMoveAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Operation retrievedResult = retrievedResponse.Result;
}
MoveAsync(string, string, string, RegionAddressesMoveRequest, CallSettings)
public virtual Task<Operation<Operation, Operation>> MoveAsync(string project, string region, string address, RegionAddressesMoveRequest regionAddressesMoveRequestResource, CallSettings callSettings = null)Moves the specified address resource.
| Parameters | |
|---|---|
| Name | Description |
project |
stringSource project ID which the Address is moved from. |
region |
stringName of the region for this request. |
address |
stringName of the address resource to move. |
regionAddressesMoveRequestResource |
RegionAddressesMoveRequestThe body resource for this request |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationOperationOperation |
A Task containing the RPC response. |
// Create client
AddressesClient addressesClient = await AddressesClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string region = "";
string address = "";
RegionAddressesMoveRequest regionAddressesMoveRequestResource = new RegionAddressesMoveRequest();
// Make the request
lro::Operation<Operation, Operation> response = await addressesClient.MoveAsync(project, region, address, regionAddressesMoveRequestResource);
// Poll until the returned long-running operation is complete
lro::Operation<Operation, Operation> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Operation result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
lro::Operation<Operation, Operation> retrievedResponse = await addressesClient.PollOnceMoveAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Operation retrievedResult = retrievedResponse.Result;
}
MoveAsync(string, string, string, RegionAddressesMoveRequest, CancellationToken)
public virtual Task<Operation<Operation, Operation>> MoveAsync(string project, string region, string address, RegionAddressesMoveRequest regionAddressesMoveRequestResource, CancellationToken cancellationToken)Moves the specified address resource.
| Parameters | |
|---|---|
| Name | Description |
project |
stringSource project ID which the Address is moved from. |
region |
stringName of the region for this request. |
address |
stringName of the address resource to move. |
regionAddressesMoveRequestResource |
RegionAddressesMoveRequestThe body resource for this request |
cancellationToken |
CancellationTokenA CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationOperationOperation |
A Task containing the RPC response. |
// Create client
AddressesClient addressesClient = await AddressesClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string region = "";
string address = "";
RegionAddressesMoveRequest regionAddressesMoveRequestResource = new RegionAddressesMoveRequest();
// Make the request
lro::Operation<Operation, Operation> response = await addressesClient.MoveAsync(project, region, address, regionAddressesMoveRequestResource);
// Poll until the returned long-running operation is complete
lro::Operation<Operation, Operation> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Operation result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
lro::Operation<Operation, Operation> retrievedResponse = await addressesClient.PollOnceMoveAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Operation retrievedResult = retrievedResponse.Result;
}
PollOnceDelete(string, CallSettings)
public virtual Operation<Operation, Operation> PollOnceDelete(string operationName, CallSettings callSettings = null)Poll an operation once, using an operationName from a previous invocation of Delete.
| Parameters | |
|---|---|
| Name | Description |
operationName |
stringThe name of a previously invoked operation. Must not be |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationOperationOperation |
The result of polling the operation. |
PollOnceDeleteAsync(string, CallSettings)
public virtual Task<Operation<Operation, Operation>> PollOnceDeleteAsync(string operationName, CallSettings callSettings = null)Asynchronously poll an operation once, using an operationName from a previous invocation of Delete
.
| Parameters | |
|---|---|
| Name | Description |
operationName |
stringThe name of a previously invoked operation. Must not be |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationOperationOperation |
A task representing the result of polling the operation. |
PollOnceInsert(string, CallSettings)
public virtual Operation<Operation, Operation> PollOnceInsert(string operationName, CallSettings callSettings = null)Poll an operation once, using an operationName from a previous invocation of Insert.
| Parameters | |
|---|---|
| Name | Description |
operationName |
stringThe name of a previously invoked operation. Must not be |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationOperationOperation |
The result of polling the operation. |
PollOnceInsertAsync(string, CallSettings)
public virtual Task<Operation<Operation, Operation>> PollOnceInsertAsync(string operationName, CallSettings callSettings = null)Asynchronously poll an operation once, using an operationName from a previous invocation of Insert
.
| Parameters | |
|---|---|
| Name | Description |
operationName |
stringThe name of a previously invoked operation. Must not be |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationOperationOperation |
A task representing the result of polling the operation. |
PollOnceMove(string, CallSettings)
public virtual Operation<Operation, Operation> PollOnceMove(string operationName, CallSettings callSettings = null)Poll an operation once, using an operationName from a previous invocation of Move.
| Parameters | |
|---|---|
| Name | Description |
operationName |
stringThe name of a previously invoked operation. Must not be |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationOperationOperation |
The result of polling the operation. |
PollOnceMoveAsync(string, CallSettings)
public virtual Task<Operation<Operation, Operation>> PollOnceMoveAsync(string operationName, CallSettings callSettings = null)Asynchronously poll an operation once, using an operationName from a previous invocation of Move
.
| Parameters | |
|---|---|
| Name | Description |
operationName |
stringThe name of a previously invoked operation. Must not be |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationOperationOperation |
A task representing the result of polling the operation. |
PollOnceSetLabels(string, CallSettings)
public virtual Operation<Operation, Operation> PollOnceSetLabels(string operationName, CallSettings callSettings = null)Poll an operation once, using an operationName from a previous invocation of SetLabels.
| Parameters | |
|---|---|
| Name | Description |
operationName |
stringThe name of a previously invoked operation. Must not be |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationOperationOperation |
The result of polling the operation. |
PollOnceSetLabelsAsync(string, CallSettings)
public virtual Task<Operation<Operation, Operation>> PollOnceSetLabelsAsync(string operationName, CallSettings callSettings = null)Asynchronously poll an operation once, using an operationName from a previous invocation of
SetLabels.
| Parameters | |
|---|---|
| Name | Description |
operationName |
stringThe name of a previously invoked operation. Must not be |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationOperationOperation |
A task representing the result of polling the operation. |
SetLabels(SetLabelsAddressRequest, CallSettings)
public virtual Operation<Operation, Operation> SetLabels(SetLabelsAddressRequest request, CallSettings callSettings = null)Sets the labels on an Address. To learn more about labels, read theLabeling Resources documentation.
| Parameters | |
|---|---|
| Name | Description |
request |
SetLabelsAddressRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationOperationOperation |
The RPC response. |
// Create client
AddressesClient addressesClient = AddressesClient.Create();
// Initialize request argument(s)
SetLabelsAddressRequest request = new SetLabelsAddressRequest
{
RequestId = "",
Region = "",
Resource = "",
Project = "",
RegionSetLabelsRequestResource = new RegionSetLabelsRequest(),
};
// Make the request
lro::Operation<Operation, Operation> response = addressesClient.SetLabels(request);
// Poll until the returned long-running operation is complete
lro::Operation<Operation, Operation> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Operation result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
lro::Operation<Operation, Operation> retrievedResponse = addressesClient.PollOnceSetLabels(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Operation retrievedResult = retrievedResponse.Result;
}
SetLabels(string, string, string, RegionSetLabelsRequest, CallSettings)
public virtual Operation<Operation, Operation> SetLabels(string project, string region, string resource, RegionSetLabelsRequest regionSetLabelsRequestResource, CallSettings callSettings = null)Sets the labels on an Address. To learn more about labels, read theLabeling Resources documentation.
| Parameters | |
|---|---|
| Name | Description |
project |
stringProject ID for this request. |
region |
stringThe region for this request. |
resource |
stringName or id of the resource for this request. |
regionSetLabelsRequestResource |
RegionSetLabelsRequestThe body resource for this request |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationOperationOperation |
The RPC response. |
// Create client
AddressesClient addressesClient = AddressesClient.Create();
// Initialize request argument(s)
string project = "";
string region = "";
string resource = "";
RegionSetLabelsRequest regionSetLabelsRequestResource = new RegionSetLabelsRequest();
// Make the request
lro::Operation<Operation, Operation> response = addressesClient.SetLabels(project, region, resource, regionSetLabelsRequestResource);
// Poll until the returned long-running operation is complete
lro::Operation<Operation, Operation> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Operation result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
lro::Operation<Operation, Operation> retrievedResponse = addressesClient.PollOnceSetLabels(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Operation retrievedResult = retrievedResponse.Result;
}
SetLabelsAsync(SetLabelsAddressRequest, CallSettings)
public virtual Task<Operation<Operation, Operation>> SetLabelsAsync(SetLabelsAddressRequest request, CallSettings callSettings = null)Sets the labels on an Address. To learn more about labels, read theLabeling Resources documentation.
| Parameters | |
|---|---|
| Name | Description |
request |
SetLabelsAddressRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationOperationOperation |
A Task containing the RPC response. |
// Create client
AddressesClient addressesClient = await AddressesClient.CreateAsync();
// Initialize request argument(s)
SetLabelsAddressRequest request = new SetLabelsAddressRequest
{
RequestId = "",
Region = "",
Resource = "",
Project = "",
RegionSetLabelsRequestResource = new RegionSetLabelsRequest(),
};
// Make the request
lro::Operation<Operation, Operation> response = await addressesClient.SetLabelsAsync(request);
// Poll until the returned long-running operation is complete
lro::Operation<Operation, Operation> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Operation result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
lro::Operation<Operation, Operation> retrievedResponse = await addressesClient.PollOnceSetLabelsAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Operation retrievedResult = retrievedResponse.Result;
}
SetLabelsAsync(SetLabelsAddressRequest, CancellationToken)
public virtual Task<Operation<Operation, Operation>> SetLabelsAsync(SetLabelsAddressRequest request, CancellationToken cancellationToken)Sets the labels on an Address. To learn more about labels, read theLabeling Resources documentation.
| Parameters | |
|---|---|
| Name | Description |
request |
SetLabelsAddressRequestThe request object containing all of the parameters for the API call. |
cancellationToken |
CancellationTokenA CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationOperationOperation |
A Task containing the RPC response. |
// Create client
AddressesClient addressesClient = await AddressesClient.CreateAsync();
// Initialize request argument(s)
SetLabelsAddressRequest request = new SetLabelsAddressRequest
{
RequestId = "",
Region = "",
Resource = "",
Project = "",
RegionSetLabelsRequestResource = new RegionSetLabelsRequest(),
};
// Make the request
lro::Operation<Operation, Operation> response = await addressesClient.SetLabelsAsync(request);
// Poll until the returned long-running operation is complete
lro::Operation<Operation, Operation> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Operation result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
lro::Operation<Operation, Operation> retrievedResponse = await addressesClient.PollOnceSetLabelsAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Operation retrievedResult = retrievedResponse.Result;
}
SetLabelsAsync(string, string, string, RegionSetLabelsRequest, CallSettings)
public virtual Task<Operation<Operation, Operation>> SetLabelsAsync(string project, string region, string resource, RegionSetLabelsRequest regionSetLabelsRequestResource, CallSettings callSettings = null)Sets the labels on an Address. To learn more about labels, read theLabeling Resources documentation.
| Parameters | |
|---|---|
| Name | Description |
project |
stringProject ID for this request. |
region |
stringThe region for this request. |
resource |
stringName or id of the resource for this request. |
regionSetLabelsRequestResource |
RegionSetLabelsRequestThe body resource for this request |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationOperationOperation |
A Task containing the RPC response. |
// Create client
AddressesClient addressesClient = await AddressesClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string region = "";
string resource = "";
RegionSetLabelsRequest regionSetLabelsRequestResource = new RegionSetLabelsRequest();
// Make the request
lro::Operation<Operation, Operation> response = await addressesClient.SetLabelsAsync(project, region, resource, regionSetLabelsRequestResource);
// Poll until the returned long-running operation is complete
lro::Operation<Operation, Operation> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Operation result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
lro::Operation<Operation, Operation> retrievedResponse = await addressesClient.PollOnceSetLabelsAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Operation retrievedResult = retrievedResponse.Result;
}
SetLabelsAsync(string, string, string, RegionSetLabelsRequest, CancellationToken)
public virtual Task<Operation<Operation, Operation>> SetLabelsAsync(string project, string region, string resource, RegionSetLabelsRequest regionSetLabelsRequestResource, CancellationToken cancellationToken)Sets the labels on an Address. To learn more about labels, read theLabeling Resources documentation.
| Parameters | |
|---|---|
| Name | Description |
project |
stringProject ID for this request. |
region |
stringThe region for this request. |
resource |
stringName or id of the resource for this request. |
regionSetLabelsRequestResource |
RegionSetLabelsRequestThe body resource for this request |
cancellationToken |
CancellationTokenA CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationOperationOperation |
A Task containing the RPC response. |
// Create client
AddressesClient addressesClient = await AddressesClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string region = "";
string resource = "";
RegionSetLabelsRequest regionSetLabelsRequestResource = new RegionSetLabelsRequest();
// Make the request
lro::Operation<Operation, Operation> response = await addressesClient.SetLabelsAsync(project, region, resource, regionSetLabelsRequestResource);
// Poll until the returned long-running operation is complete
lro::Operation<Operation, Operation> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Operation result = completedResponse.Result;
// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
lro::Operation<Operation, Operation> retrievedResponse = await addressesClient.PollOnceSetLabelsAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
// If it has completed, then access the result
Operation retrievedResult = retrievedResponse.Result;
}
ShutdownDefaultChannelsAsync()
public static Task ShutdownDefaultChannelsAsync()Shuts down any channels automatically created by Create() and CreateAsync(CancellationToken). Channels which weren't automatically created are not affected.
| Returns | |
|---|---|
| Type | Description |
Task |
A task representing the asynchronous shutdown operation. |
After calling this method, further calls to Create() and CreateAsync(CancellationToken) will create new channels, which could in turn be shut down by another call to this method.
TestIamPermissions(TestIamPermissionsAddressRequest, CallSettings)
public virtual TestPermissionsResponse TestIamPermissions(TestIamPermissionsAddressRequest request, CallSettings callSettings = null)Returns permissions that a caller has on the specified resource.
| Parameters | |
|---|---|
| Name | Description |
request |
TestIamPermissionsAddressRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TestPermissionsResponse |
The RPC response. |
// Create client
AddressesClient addressesClient = AddressesClient.Create();
// Initialize request argument(s)
TestIamPermissionsAddressRequest request = new TestIamPermissionsAddressRequest
{
Region = "",
Resource = "",
Project = "",
TestPermissionsRequestResource = new TestPermissionsRequest(),
};
// Make the request
TestPermissionsResponse response = addressesClient.TestIamPermissions(request);
TestIamPermissions(string, string, string, TestPermissionsRequest, CallSettings)
public virtual TestPermissionsResponse TestIamPermissions(string project, string region, string resource, TestPermissionsRequest testPermissionsRequestResource, CallSettings callSettings = null)Returns permissions that a caller has on the specified resource.
| Parameters | |
|---|---|
| Name | Description |
project |
stringProject ID for this request. |
region |
stringThe name of the region for this request. |
resource |
stringName or id of the resource for this request. |
testPermissionsRequestResource |
TestPermissionsRequestThe body resource for this request |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TestPermissionsResponse |
The RPC response. |
// Create client
AddressesClient addressesClient = AddressesClient.Create();
// Initialize request argument(s)
string project = "";
string region = "";
string resource = "";
TestPermissionsRequest testPermissionsRequestResource = new TestPermissionsRequest();
// Make the request
TestPermissionsResponse response = addressesClient.TestIamPermissions(project, region, resource, testPermissionsRequestResource);
TestIamPermissionsAsync(TestIamPermissionsAddressRequest, CallSettings)
public virtual Task<TestPermissionsResponse> TestIamPermissionsAsync(TestIamPermissionsAddressRequest request, CallSettings callSettings = null)Returns permissions that a caller has on the specified resource.
| Parameters | |
|---|---|
| Name | Description |
request |
TestIamPermissionsAddressRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskTestPermissionsResponse |
A Task containing the RPC response. |
// Create client
AddressesClient addressesClient = await AddressesClient.CreateAsync();
// Initialize request argument(s)
TestIamPermissionsAddressRequest request = new TestIamPermissionsAddressRequest
{
Region = "",
Resource = "",
Project = "",
TestPermissionsRequestResource = new TestPermissionsRequest(),
};
// Make the request
TestPermissionsResponse response = await addressesClient.TestIamPermissionsAsync(request);
TestIamPermissionsAsync(TestIamPermissionsAddressRequest, CancellationToken)
public virtual Task<TestPermissionsResponse> TestIamPermissionsAsync(TestIamPermissionsAddressRequest request, CancellationToken cancellationToken)Returns permissions that a caller has on the specified resource.
| Parameters | |
|---|---|
| Name | Description |
request |
TestIamPermissionsAddressRequestThe request object containing all of the parameters for the API call. |
cancellationToken |
CancellationTokenA CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
TaskTestPermissionsResponse |
A Task containing the RPC response. |
// Create client
AddressesClient addressesClient = await AddressesClient.CreateAsync();
// Initialize request argument(s)
TestIamPermissionsAddressRequest request = new TestIamPermissionsAddressRequest
{
Region = "",
Resource = "",
Project = "",
TestPermissionsRequestResource = new TestPermissionsRequest(),
};
// Make the request
TestPermissionsResponse response = await addressesClient.TestIamPermissionsAsync(request);
TestIamPermissionsAsync(string, string, string, TestPermissionsRequest, CallSettings)
public virtual Task<TestPermissionsResponse> TestIamPermissionsAsync(string project, string region, string resource, TestPermissionsRequest testPermissionsRequestResource, CallSettings callSettings = null)Returns permissions that a caller has on the specified resource.
| Parameters | |
|---|---|
| Name | Description |
project |
stringProject ID for this request. |
region |
stringThe name of the region for this request. |
resource |
stringName or id of the resource for this request. |
testPermissionsRequestResource |
TestPermissionsRequestThe body resource for this request |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskTestPermissionsResponse |
A Task containing the RPC response. |
// Create client
AddressesClient addressesClient = await AddressesClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string region = "";
string resource = "";
TestPermissionsRequest testPermissionsRequestResource = new TestPermissionsRequest();
// Make the request
TestPermissionsResponse response = await addressesClient.TestIamPermissionsAsync(project, region, resource, testPermissionsRequestResource);
TestIamPermissionsAsync(string, string, string, TestPermissionsRequest, CancellationToken)
public virtual Task<TestPermissionsResponse> TestIamPermissionsAsync(string project, string region, string resource, TestPermissionsRequest testPermissionsRequestResource, CancellationToken cancellationToken)Returns permissions that a caller has on the specified resource.
| Parameters | |
|---|---|
| Name | Description |
project |
stringProject ID for this request. |
region |
stringThe name of the region for this request. |
resource |
stringName or id of the resource for this request. |
testPermissionsRequestResource |
TestPermissionsRequestThe body resource for this request |
cancellationToken |
CancellationTokenA CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
TaskTestPermissionsResponse |
A Task containing the RPC response. |
// Create client
AddressesClient addressesClient = await AddressesClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string region = "";
string resource = "";
TestPermissionsRequest testPermissionsRequestResource = new TestPermissionsRequest();
// Make the request
TestPermissionsResponse response = await addressesClient.TestIamPermissionsAsync(project, region, resource, testPermissionsRequestResource);