Compute Engine v1 API - Class GlobalAddressesClient (2.7.0)

Version 2.7.0

• 3.0.0 (latest)
• 2.17.0
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.12.0
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.0
• 2.2.0
• 2.1.0
• 2.0.0
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.0

public abstract class GlobalAddressesClient

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

GlobalAddresses client wrapper, for convenient use.

Inheritance

object > GlobalAddressesClient

Inherited Members

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Derived Types

GlobalAddressesClientImpl

Namespace

GoogleCloudGoogle.Cloud.ComputeV1

Assembly

Google.Cloud.Compute.V1.dll

Remarks

The GlobalAddresses API.

Properties

DefaultEndpoint

public static string DefaultEndpoint { get; }

The default endpoint for the GlobalAddresses 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 GlobalAddresses scopes.

Property Value
Type	Description
IReadOnlyListstring

Remarks

The default GlobalAddresses scopes are:

• https://www.googleapis.com/auth/compute
• https://www.googleapis.com/auth/cloud-platform

DeleteOperationsClient

public virtual OperationsClient DeleteOperationsClient { get; }

The long-running operations client for Delete.

Property Value
Type	Description
OperationsClient

GrpcClient

public virtual GlobalAddresses.GlobalAddressesClient GrpcClient { get; }

The underlying gRPC GlobalAddresses client

Property Value
Type	Description
GlobalAddressesGlobalAddressesClient

InsertOperationsClient

public virtual OperationsClient InsertOperationsClient { get; }

The long-running operations client for Insert.

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

Create()

public static GlobalAddressesClient Create()

Synchronously creates a GlobalAddressesClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use GlobalAddressesClientBuilder.

Returns
Type	Description
GlobalAddressesClient	The created GlobalAddressesClient.

CreateAsync(CancellationToken)

public static Task<GlobalAddressesClient> CreateAsync(CancellationToken cancellationToken = default)

Asynchronously creates a GlobalAddressesClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use GlobalAddressesClientBuilder.

Parameter
Name	Description
cancellationToken	CancellationToken The CancellationToken to use while creating the client.

Returns
Type	Description
TaskGlobalAddressesClient	The task representing the created GlobalAddressesClient.

Delete(DeleteGlobalAddressRequest, CallSettings)

public virtual Operation<Operation, Operation> Delete(DeleteGlobalAddressRequest request, CallSettings callSettings = null)

Deletes the specified address resource.

Parameters
Name	Description
request	DeleteGlobalAddressRequest 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.

Example

// Create client
GlobalAddressesClient globalAddressesClient = GlobalAddressesClient.Create();
// Initialize request argument(s)
DeleteGlobalAddressRequest request = new DeleteGlobalAddressRequest
{
    RequestId = "",
    Project = "",
    Address = "",
};
// Make the request
lro::Operation<Operation, Operation> response = globalAddressesClient.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 = globalAddressesClient.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, CallSettings)

public virtual Operation<Operation, Operation> Delete(string project, string address, CallSettings callSettings = null)

Deletes the specified address resource.

Parameters
Name	Description
project	string Project ID for this request.
address	string Name of the address resource to delete.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
OperationOperationOperation	The RPC response.

Example

// Create client
GlobalAddressesClient globalAddressesClient = GlobalAddressesClient.Create();
// Initialize request argument(s)
string project = "";
string address = "";
// Make the request
lro::Operation<Operation, Operation> response = globalAddressesClient.Delete(project, 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 = globalAddressesClient.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(DeleteGlobalAddressRequest, CallSettings)

public virtual Task<Operation<Operation, Operation>> DeleteAsync(DeleteGlobalAddressRequest request, CallSettings callSettings = null)

Deletes the specified address resource.

Parameters
Name	Description
request	DeleteGlobalAddressRequest 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.

Example

// Create client
GlobalAddressesClient globalAddressesClient = await GlobalAddressesClient.CreateAsync();
// Initialize request argument(s)
DeleteGlobalAddressRequest request = new DeleteGlobalAddressRequest
{
    RequestId = "",
    Project = "",
    Address = "",
};
// Make the request
lro::Operation<Operation, Operation> response = await globalAddressesClient.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 globalAddressesClient.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(DeleteGlobalAddressRequest, CancellationToken)

public virtual Task<Operation<Operation, Operation>> DeleteAsync(DeleteGlobalAddressRequest request, CancellationToken cancellationToken)

Deletes the specified address resource.

Parameters
Name	Description
request	DeleteGlobalAddressRequest The request object containing all of the parameters for the API call.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskOperationOperationOperation	A Task containing the RPC response.

Example

// Create client
GlobalAddressesClient globalAddressesClient = await GlobalAddressesClient.CreateAsync();
// Initialize request argument(s)
DeleteGlobalAddressRequest request = new DeleteGlobalAddressRequest
{
    RequestId = "",
    Project = "",
    Address = "",
};
// Make the request
lro::Operation<Operation, Operation> response = await globalAddressesClient.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 globalAddressesClient.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, CallSettings)

public virtual Task<Operation<Operation, Operation>> DeleteAsync(string project, string address, CallSettings callSettings = null)

Deletes the specified address resource.

Parameters
Name	Description
project	string Project ID for this request.
address	string Name of the address resource to delete.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskOperationOperationOperation	A Task containing the RPC response.

Example

// Create client
GlobalAddressesClient globalAddressesClient = await GlobalAddressesClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string address = "";
// Make the request
lro::Operation<Operation, Operation> response = await globalAddressesClient.DeleteAsync(project, 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 globalAddressesClient.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, CancellationToken)

public virtual Task<Operation<Operation, Operation>> DeleteAsync(string project, string address, CancellationToken cancellationToken)

Deletes the specified address resource.

Parameters
Name	Description
project	string Project ID for this request.
address	string Name of the address resource to delete.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskOperationOperationOperation	A Task containing the RPC response.

Example

// Create client
GlobalAddressesClient globalAddressesClient = await GlobalAddressesClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string address = "";
// Make the request
lro::Operation<Operation, Operation> response = await globalAddressesClient.DeleteAsync(project, 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 globalAddressesClient.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(GetGlobalAddressRequest, CallSettings)

public virtual Address Get(GetGlobalAddressRequest request, CallSettings callSettings = null)

Returns the specified address resource. Gets a list of available addresses by making a list() request.

Parameters
Name	Description
request	GetGlobalAddressRequest 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.

Example

// Create client
GlobalAddressesClient globalAddressesClient = GlobalAddressesClient.Create();
// Initialize request argument(s)
GetGlobalAddressRequest request = new GetGlobalAddressRequest
{
    Project = "",
    Address = "",
};
// Make the request
Address response = globalAddressesClient.Get(request);

Get(string, string, CallSettings)

public virtual Address Get(string project, string address, CallSettings callSettings = null)

Returns the specified address resource. Gets a list of available addresses by making a list() request.

Parameters
Name	Description
project	string Project ID for this request.
address	string Name of the address resource to return.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Address	The RPC response.

Example

// Create client
GlobalAddressesClient globalAddressesClient = GlobalAddressesClient.Create();
// Initialize request argument(s)
string project = "";
string address = "";
// Make the request
Address response = globalAddressesClient.Get(project, address);

GetAsync(GetGlobalAddressRequest, CallSettings)

public virtual Task<Address> GetAsync(GetGlobalAddressRequest request, CallSettings callSettings = null)

Returns the specified address resource. Gets a list of available addresses by making a list() request.

Parameters
Name	Description
request	GetGlobalAddressRequest 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.

Example

// Create client
GlobalAddressesClient globalAddressesClient = await GlobalAddressesClient.CreateAsync();
// Initialize request argument(s)
GetGlobalAddressRequest request = new GetGlobalAddressRequest
{
    Project = "",
    Address = "",
};
// Make the request
Address response = await globalAddressesClient.GetAsync(request);

GetAsync(GetGlobalAddressRequest, CancellationToken)

public virtual Task<Address> GetAsync(GetGlobalAddressRequest request, CancellationToken cancellationToken)

Returns the specified address resource. Gets a list of available addresses by making a list() request.

Parameters
Name	Description
request	GetGlobalAddressRequest The request object containing all of the parameters for the API call.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskAddress	A Task containing the RPC response.

Example

// Create client
GlobalAddressesClient globalAddressesClient = await GlobalAddressesClient.CreateAsync();
// Initialize request argument(s)
GetGlobalAddressRequest request = new GetGlobalAddressRequest
{
    Project = "",
    Address = "",
};
// Make the request
Address response = await globalAddressesClient.GetAsync(request);

GetAsync(string, string, CallSettings)

public virtual Task<Address> GetAsync(string project, string address, CallSettings callSettings = null)

Returns the specified address resource. Gets a list of available addresses by making a list() request.

Parameters
Name	Description
project	string Project ID for this request.
address	string Name of the address resource to return.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskAddress	A Task containing the RPC response.

Example

// Create client
GlobalAddressesClient globalAddressesClient = await GlobalAddressesClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string address = "";
// Make the request
Address response = await globalAddressesClient.GetAsync(project, address);

GetAsync(string, string, CancellationToken)

public virtual Task<Address> GetAsync(string project, string address, CancellationToken cancellationToken)

Returns the specified address resource. Gets a list of available addresses by making a list() request.

Parameters
Name	Description
project	string Project ID for this request.
address	string Name of the address resource to return.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskAddress	A Task containing the RPC response.

Example

// Create client
GlobalAddressesClient globalAddressesClient = await GlobalAddressesClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string address = "";
// Make the request
Address response = await globalAddressesClient.GetAsync(project, address);

Insert(InsertGlobalAddressRequest, CallSettings)

public virtual Operation<Operation, Operation> Insert(InsertGlobalAddressRequest request, CallSettings callSettings = null)

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

Parameters
Name	Description
request	InsertGlobalAddressRequest 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.

Example

// Create client
GlobalAddressesClient globalAddressesClient = GlobalAddressesClient.Create();
// Initialize request argument(s)
InsertGlobalAddressRequest request = new InsertGlobalAddressRequest
{
    RequestId = "",
    Project = "",
    AddressResource = new Address(),
};
// Make the request
lro::Operation<Operation, Operation> response = globalAddressesClient.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 = globalAddressesClient.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, Address, CallSettings)

public virtual Operation<Operation, Operation> Insert(string project, 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	string Project ID for this request.
addressResource	Address The body resource for this request
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
OperationOperationOperation	The RPC response.

Example

// Create client
GlobalAddressesClient globalAddressesClient = GlobalAddressesClient.Create();
// Initialize request argument(s)
string project = "";
Address addressResource = new Address();
// Make the request
lro::Operation<Operation, Operation> response = globalAddressesClient.Insert(project, 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 = globalAddressesClient.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(InsertGlobalAddressRequest, CallSettings)

public virtual Task<Operation<Operation, Operation>> InsertAsync(InsertGlobalAddressRequest request, CallSettings callSettings = null)

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

Parameters
Name	Description
request	InsertGlobalAddressRequest 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.

Example

// Create client
GlobalAddressesClient globalAddressesClient = await GlobalAddressesClient.CreateAsync();
// Initialize request argument(s)
InsertGlobalAddressRequest request = new InsertGlobalAddressRequest
{
    RequestId = "",
    Project = "",
    AddressResource = new Address(),
};
// Make the request
lro::Operation<Operation, Operation> response = await globalAddressesClient.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 globalAddressesClient.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(InsertGlobalAddressRequest, CancellationToken)

public virtual Task<Operation<Operation, Operation>> InsertAsync(InsertGlobalAddressRequest request, CancellationToken cancellationToken)

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

Parameters
Name	Description
request	InsertGlobalAddressRequest The request object containing all of the parameters for the API call.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskOperationOperationOperation	A Task containing the RPC response.

Example

// Create client
GlobalAddressesClient globalAddressesClient = await GlobalAddressesClient.CreateAsync();
// Initialize request argument(s)
InsertGlobalAddressRequest request = new InsertGlobalAddressRequest
{
    RequestId = "",
    Project = "",
    AddressResource = new Address(),
};
// Make the request
lro::Operation<Operation, Operation> response = await globalAddressesClient.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 globalAddressesClient.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, Address, CallSettings)

public virtual Task<Operation<Operation, Operation>> InsertAsync(string project, 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	string Project ID for this request.
addressResource	Address The body resource for this request
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskOperationOperationOperation	A Task containing the RPC response.

Example

// Create client
GlobalAddressesClient globalAddressesClient = await GlobalAddressesClient.CreateAsync();
// Initialize request argument(s)
string project = "";
Address addressResource = new Address();
// Make the request
lro::Operation<Operation, Operation> response = await globalAddressesClient.InsertAsync(project, 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 globalAddressesClient.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, Address, CancellationToken)

public virtual Task<Operation<Operation, Operation>> InsertAsync(string project, Address addressResource, CancellationToken cancellationToken)

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

Parameters
Name	Description
project	string Project ID for this request.
addressResource	Address The body resource for this request
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskOperationOperationOperation	A Task containing the RPC response.

Example

// Create client
GlobalAddressesClient globalAddressesClient = await GlobalAddressesClient.CreateAsync();
// Initialize request argument(s)
string project = "";
Address addressResource = new Address();
// Make the request
lro::Operation<Operation, Operation> response = await globalAddressesClient.InsertAsync(project, 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 globalAddressesClient.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(ListGlobalAddressesRequest, CallSettings)

public virtual PagedEnumerable<AddressList, Address> List(ListGlobalAddressesRequest request, CallSettings callSettings = null)

Retrieves a list of global addresses.

Parameters
Name	Description
request	ListGlobalAddressesRequest 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.

Example

// Create client
GlobalAddressesClient globalAddressesClient = GlobalAddressesClient.Create();
// Initialize request argument(s)
ListGlobalAddressesRequest request = new ListGlobalAddressesRequest
{
    OrderBy = "",
    Project = "",
    Filter = "",
    ReturnPartialSuccess = false,
};
// Make the request
PagedEnumerable<AddressList, Address> response = globalAddressesClient.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, int?, CallSettings)

public virtual PagedEnumerable<AddressList, Address> List(string project, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Retrieves a list of global addresses.

Parameters
Name	Description
project	string Project ID for this request.
pageToken	string The token returned from the previous request. A value of null or an empty string retrieves the first page.
pageSize	int The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
PagedEnumerableAddressListAddress	A pageable sequence of Address resources.

Example

// Create client
GlobalAddressesClient globalAddressesClient = GlobalAddressesClient.Create();
// Initialize request argument(s)
string project = "";
// Make the request
PagedEnumerable<AddressList, Address> response = globalAddressesClient.List(project);

// 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(ListGlobalAddressesRequest, CallSettings)

public virtual PagedAsyncEnumerable<AddressList, Address> ListAsync(ListGlobalAddressesRequest request, CallSettings callSettings = null)

Retrieves a list of global addresses.

Parameters
Name	Description
request	ListGlobalAddressesRequest 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.

Example

// Create client
GlobalAddressesClient globalAddressesClient = await GlobalAddressesClient.CreateAsync();
// Initialize request argument(s)
ListGlobalAddressesRequest request = new ListGlobalAddressesRequest
{
    OrderBy = "",
    Project = "",
    Filter = "",
    ReturnPartialSuccess = false,
};
// Make the request
PagedAsyncEnumerable<AddressList, Address> response = globalAddressesClient.ListAsync(request);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((Address item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((AddressList page) =>
{
    // 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, int?, CallSettings)

public virtual PagedAsyncEnumerable<AddressList, Address> ListAsync(string project, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Retrieves a list of global addresses.

Parameters
Name	Description
project	string Project ID for this request.
pageToken	string The token returned from the previous request. A value of null or an empty string retrieves the first page.
pageSize	int The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
PagedAsyncEnumerableAddressListAddress	A pageable asynchronous sequence of Address resources.

Example

// Create client
GlobalAddressesClient globalAddressesClient = await GlobalAddressesClient.CreateAsync();
// Initialize request argument(s)
string project = "";
// Make the request
PagedAsyncEnumerable<AddressList, Address> response = globalAddressesClient.ListAsync(project);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((Address item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((AddressList page) =>
{
    // 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;

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	string The name of a previously invoked operation. Must not be null or empty.
callSettings	CallSettings If 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	string The name of a previously invoked operation. Must not be null or empty.
callSettings	CallSettings If 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	string The name of a previously invoked operation. Must not be null or empty.
callSettings	CallSettings If 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	string The name of a previously invoked operation. Must not be null or empty.
callSettings	CallSettings If 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	string The name of a previously invoked operation. Must not be null or empty.
callSettings	CallSettings If 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	string The name of a previously invoked operation. Must not be null or empty.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskOperationOperationOperation	A task representing the result of polling the operation.

SetLabels(SetLabelsGlobalAddressRequest, CallSettings)

public virtual Operation<Operation, Operation> SetLabels(SetLabelsGlobalAddressRequest request, CallSettings callSettings = null)

Sets the labels on a GlobalAddress. To learn more about labels, read the Labeling Resources documentation.

Parameters
Name	Description
request	SetLabelsGlobalAddressRequest 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.

Example

// Create client
GlobalAddressesClient globalAddressesClient = GlobalAddressesClient.Create();
// Initialize request argument(s)
SetLabelsGlobalAddressRequest request = new SetLabelsGlobalAddressRequest
{
    Resource = "",
    Project = "",
    GlobalSetLabelsRequestResource = new GlobalSetLabelsRequest(),
};
// Make the request
lro::Operation<Operation, Operation> response = globalAddressesClient.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 = globalAddressesClient.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, GlobalSetLabelsRequest, CallSettings)

public virtual Operation<Operation, Operation> SetLabels(string project, string resource, GlobalSetLabelsRequest globalSetLabelsRequestResource, CallSettings callSettings = null)

Sets the labels on a GlobalAddress. To learn more about labels, read the Labeling Resources documentation.

Parameters
Name	Description
project	string Project ID for this request.
resource	string Name or id of the resource for this request.
globalSetLabelsRequestResource	GlobalSetLabelsRequest The body resource for this request
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
OperationOperationOperation	The RPC response.

Example

// Create client
GlobalAddressesClient globalAddressesClient = GlobalAddressesClient.Create();
// Initialize request argument(s)
string project = "";
string resource = "";
GlobalSetLabelsRequest globalSetLabelsRequestResource = new GlobalSetLabelsRequest();
// Make the request
lro::Operation<Operation, Operation> response = globalAddressesClient.SetLabels(project, resource, globalSetLabelsRequestResource);

// 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 = globalAddressesClient.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(SetLabelsGlobalAddressRequest, CallSettings)

public virtual Task<Operation<Operation, Operation>> SetLabelsAsync(SetLabelsGlobalAddressRequest request, CallSettings callSettings = null)

Sets the labels on a GlobalAddress. To learn more about labels, read the Labeling Resources documentation.

Parameters
Name	Description
request	SetLabelsGlobalAddressRequest 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.

Example

// Create client
GlobalAddressesClient globalAddressesClient = await GlobalAddressesClient.CreateAsync();
// Initialize request argument(s)
SetLabelsGlobalAddressRequest request = new SetLabelsGlobalAddressRequest
{
    Resource = "",
    Project = "",
    GlobalSetLabelsRequestResource = new GlobalSetLabelsRequest(),
};
// Make the request
lro::Operation<Operation, Operation> response = await globalAddressesClient.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 globalAddressesClient.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(SetLabelsGlobalAddressRequest, CancellationToken)

public virtual Task<Operation<Operation, Operation>> SetLabelsAsync(SetLabelsGlobalAddressRequest request, CancellationToken cancellationToken)

Sets the labels on a GlobalAddress. To learn more about labels, read the Labeling Resources documentation.

Parameters
Name	Description
request	SetLabelsGlobalAddressRequest The request object containing all of the parameters for the API call.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskOperationOperationOperation	A Task containing the RPC response.

Example

// Create client
GlobalAddressesClient globalAddressesClient = await GlobalAddressesClient.CreateAsync();
// Initialize request argument(s)
SetLabelsGlobalAddressRequest request = new SetLabelsGlobalAddressRequest
{
    Resource = "",
    Project = "",
    GlobalSetLabelsRequestResource = new GlobalSetLabelsRequest(),
};
// Make the request
lro::Operation<Operation, Operation> response = await globalAddressesClient.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 globalAddressesClient.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, GlobalSetLabelsRequest, CallSettings)

public virtual Task<Operation<Operation, Operation>> SetLabelsAsync(string project, string resource, GlobalSetLabelsRequest globalSetLabelsRequestResource, CallSettings callSettings = null)

Sets the labels on a GlobalAddress. To learn more about labels, read the Labeling Resources documentation.

Parameters
Name	Description
project	string Project ID for this request.
resource	string Name or id of the resource for this request.
globalSetLabelsRequestResource	GlobalSetLabelsRequest The body resource for this request
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskOperationOperationOperation	A Task containing the RPC response.

Example

// Create client
GlobalAddressesClient globalAddressesClient = await GlobalAddressesClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string resource = "";
GlobalSetLabelsRequest globalSetLabelsRequestResource = new GlobalSetLabelsRequest();
// Make the request
lro::Operation<Operation, Operation> response = await globalAddressesClient.SetLabelsAsync(project, resource, globalSetLabelsRequestResource);

// 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 globalAddressesClient.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, GlobalSetLabelsRequest, CancellationToken)

public virtual Task<Operation<Operation, Operation>> SetLabelsAsync(string project, string resource, GlobalSetLabelsRequest globalSetLabelsRequestResource, CancellationToken cancellationToken)

Sets the labels on a GlobalAddress. To learn more about labels, read the Labeling Resources documentation.

Parameters
Name	Description
project	string Project ID for this request.
resource	string Name or id of the resource for this request.
globalSetLabelsRequestResource	GlobalSetLabelsRequest The body resource for this request
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskOperationOperationOperation	A Task containing the RPC response.

Example

// Create client
GlobalAddressesClient globalAddressesClient = await GlobalAddressesClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string resource = "";
GlobalSetLabelsRequest globalSetLabelsRequestResource = new GlobalSetLabelsRequest();
// Make the request
lro::Operation<Operation, Operation> response = await globalAddressesClient.SetLabelsAsync(project, resource, globalSetLabelsRequestResource);

// 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 globalAddressesClient.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.

Remarks

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.