Compute Engine v1 API - Class RegionNetworkEndpointGroupsClient (2.10.0)

public abstract class RegionNetworkEndpointGroupsClient

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

RegionNetworkEndpointGroups client wrapper, for convenient use.

Inheritance

object > RegionNetworkEndpointGroupsClient

Namespace

Google.Cloud.Compute.V1

Assembly

Google.Cloud.Compute.V1.dll

Remarks

The RegionNetworkEndpointGroups API.

Properties

DefaultEndpoint

public static string DefaultEndpoint { get; }

The default endpoint for the RegionNetworkEndpointGroups service, which is a host of "compute.googleapis.com" and a port of 443.

Property Value
TypeDescription
string

DefaultScopes

public static IReadOnlyList<string> DefaultScopes { get; }

The default RegionNetworkEndpointGroups scopes.

Property Value
TypeDescription
IReadOnlyListstring
Remarks

DeleteOperationsClient

public virtual OperationsClient DeleteOperationsClient { get; }

The long-running operations client for Delete.

Property Value
TypeDescription
OperationsClient

GrpcClient

public virtual RegionNetworkEndpointGroups.RegionNetworkEndpointGroupsClient GrpcClient { get; }

The underlying gRPC RegionNetworkEndpointGroups client

Property Value
TypeDescription
RegionNetworkEndpointGroupsRegionNetworkEndpointGroupsClient

InsertOperationsClient

public virtual OperationsClient InsertOperationsClient { get; }

The long-running operations client for Insert.

Property Value
TypeDescription
OperationsClient

ServiceMetadata

public static ServiceMetadata ServiceMetadata { get; }

The service metadata associated with this client type.

Property Value
TypeDescription
ServiceMetadata

Methods

Create()

public static RegionNetworkEndpointGroupsClient Create()

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

Returns
TypeDescription
RegionNetworkEndpointGroupsClient

The created RegionNetworkEndpointGroupsClient.

CreateAsync(CancellationToken)

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

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

Parameter
NameDescription
cancellationTokenCancellationToken

The CancellationToken to use while creating the client.

Returns
TypeDescription
TaskRegionNetworkEndpointGroupsClient

The task representing the created RegionNetworkEndpointGroupsClient.

Delete(DeleteRegionNetworkEndpointGroupRequest, CallSettings)

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

Deletes the specified network endpoint group. Note that the NEG cannot be deleted if it is configured as a backend of a backend service.

Parameters
NameDescription
requestDeleteRegionNetworkEndpointGroupRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationOperationOperation

The RPC response.

Example
// Create client
RegionNetworkEndpointGroupsClient regionNetworkEndpointGroupsClient = RegionNetworkEndpointGroupsClient.Create();
// Initialize request argument(s)
DeleteRegionNetworkEndpointGroupRequest request = new DeleteRegionNetworkEndpointGroupRequest
{
    RequestId = "",
    Region = "",
    Project = "",
    NetworkEndpointGroup = "",
};
// Make the request
lro::Operation<Operation, Operation> response = regionNetworkEndpointGroupsClient.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 = regionNetworkEndpointGroupsClient.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 networkEndpointGroup, CallSettings callSettings = null)

Deletes the specified network endpoint group. Note that the NEG cannot be deleted if it is configured as a backend of a backend service.

Parameters
NameDescription
projectstring

Project ID for this request.

regionstring

The name of the region where the network endpoint group is located. It should comply with RFC1035.

networkEndpointGroupstring

The name of the network endpoint group to delete. It should comply with RFC1035.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationOperationOperation

The RPC response.

Example
// Create client
RegionNetworkEndpointGroupsClient regionNetworkEndpointGroupsClient = RegionNetworkEndpointGroupsClient.Create();
// Initialize request argument(s)
string project = "";
string region = "";
string networkEndpointGroup = "";
// Make the request
lro::Operation<Operation, Operation> response = regionNetworkEndpointGroupsClient.Delete(project, region, networkEndpointGroup);

// 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 = regionNetworkEndpointGroupsClient.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(DeleteRegionNetworkEndpointGroupRequest, CallSettings)

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

Deletes the specified network endpoint group. Note that the NEG cannot be deleted if it is configured as a backend of a backend service.

Parameters
NameDescription
requestDeleteRegionNetworkEndpointGroupRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationOperationOperation

A Task containing the RPC response.

Example
// Create client
RegionNetworkEndpointGroupsClient regionNetworkEndpointGroupsClient = await RegionNetworkEndpointGroupsClient.CreateAsync();
// Initialize request argument(s)
DeleteRegionNetworkEndpointGroupRequest request = new DeleteRegionNetworkEndpointGroupRequest
{
    RequestId = "",
    Region = "",
    Project = "",
    NetworkEndpointGroup = "",
};
// Make the request
lro::Operation<Operation, Operation> response = await regionNetworkEndpointGroupsClient.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 regionNetworkEndpointGroupsClient.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(DeleteRegionNetworkEndpointGroupRequest, CancellationToken)

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

Deletes the specified network endpoint group. Note that the NEG cannot be deleted if it is configured as a backend of a backend service.

Parameters
NameDescription
requestDeleteRegionNetworkEndpointGroupRequest

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

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskOperationOperationOperation

A Task containing the RPC response.

Example
// Create client
RegionNetworkEndpointGroupsClient regionNetworkEndpointGroupsClient = await RegionNetworkEndpointGroupsClient.CreateAsync();
// Initialize request argument(s)
DeleteRegionNetworkEndpointGroupRequest request = new DeleteRegionNetworkEndpointGroupRequest
{
    RequestId = "",
    Region = "",
    Project = "",
    NetworkEndpointGroup = "",
};
// Make the request
lro::Operation<Operation, Operation> response = await regionNetworkEndpointGroupsClient.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 regionNetworkEndpointGroupsClient.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 networkEndpointGroup, CallSettings callSettings = null)

Deletes the specified network endpoint group. Note that the NEG cannot be deleted if it is configured as a backend of a backend service.

Parameters
NameDescription
projectstring

Project ID for this request.

regionstring

The name of the region where the network endpoint group is located. It should comply with RFC1035.

networkEndpointGroupstring

The name of the network endpoint group to delete. It should comply with RFC1035.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationOperationOperation

A Task containing the RPC response.

Example
// Create client
RegionNetworkEndpointGroupsClient regionNetworkEndpointGroupsClient = await RegionNetworkEndpointGroupsClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string region = "";
string networkEndpointGroup = "";
// Make the request
lro::Operation<Operation, Operation> response = await regionNetworkEndpointGroupsClient.DeleteAsync(project, region, networkEndpointGroup);

// 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 regionNetworkEndpointGroupsClient.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 networkEndpointGroup, CancellationToken cancellationToken)

Deletes the specified network endpoint group. Note that the NEG cannot be deleted if it is configured as a backend of a backend service.

Parameters
NameDescription
projectstring

Project ID for this request.

regionstring

The name of the region where the network endpoint group is located. It should comply with RFC1035.

networkEndpointGroupstring

The name of the network endpoint group to delete. It should comply with RFC1035.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskOperationOperationOperation

A Task containing the RPC response.

Example
// Create client
RegionNetworkEndpointGroupsClient regionNetworkEndpointGroupsClient = await RegionNetworkEndpointGroupsClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string region = "";
string networkEndpointGroup = "";
// Make the request
lro::Operation<Operation, Operation> response = await regionNetworkEndpointGroupsClient.DeleteAsync(project, region, networkEndpointGroup);

// 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 regionNetworkEndpointGroupsClient.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(GetRegionNetworkEndpointGroupRequest, CallSettings)

public virtual NetworkEndpointGroup Get(GetRegionNetworkEndpointGroupRequest request, CallSettings callSettings = null)

Returns the specified network endpoint group.

Parameters
NameDescription
requestGetRegionNetworkEndpointGroupRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
NetworkEndpointGroup

The RPC response.

Example
// Create client
RegionNetworkEndpointGroupsClient regionNetworkEndpointGroupsClient = RegionNetworkEndpointGroupsClient.Create();
// Initialize request argument(s)
GetRegionNetworkEndpointGroupRequest request = new GetRegionNetworkEndpointGroupRequest
{
    Region = "",
    Project = "",
    NetworkEndpointGroup = "",
};
// Make the request
NetworkEndpointGroup response = regionNetworkEndpointGroupsClient.Get(request);

Get(string, string, string, CallSettings)

public virtual NetworkEndpointGroup Get(string project, string region, string networkEndpointGroup, CallSettings callSettings = null)

Returns the specified network endpoint group.

Parameters
NameDescription
projectstring

Project ID for this request.

regionstring

The name of the region where the network endpoint group is located. It should comply with RFC1035.

networkEndpointGroupstring

The name of the network endpoint group. It should comply with RFC1035.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
NetworkEndpointGroup

The RPC response.

Example
// Create client
RegionNetworkEndpointGroupsClient regionNetworkEndpointGroupsClient = RegionNetworkEndpointGroupsClient.Create();
// Initialize request argument(s)
string project = "";
string region = "";
string networkEndpointGroup = "";
// Make the request
NetworkEndpointGroup response = regionNetworkEndpointGroupsClient.Get(project, region, networkEndpointGroup);

GetAsync(GetRegionNetworkEndpointGroupRequest, CallSettings)

public virtual Task<NetworkEndpointGroup> GetAsync(GetRegionNetworkEndpointGroupRequest request, CallSettings callSettings = null)

Returns the specified network endpoint group.

Parameters
NameDescription
requestGetRegionNetworkEndpointGroupRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskNetworkEndpointGroup

A Task containing the RPC response.

Example
// Create client
RegionNetworkEndpointGroupsClient regionNetworkEndpointGroupsClient = await RegionNetworkEndpointGroupsClient.CreateAsync();
// Initialize request argument(s)
GetRegionNetworkEndpointGroupRequest request = new GetRegionNetworkEndpointGroupRequest
{
    Region = "",
    Project = "",
    NetworkEndpointGroup = "",
};
// Make the request
NetworkEndpointGroup response = await regionNetworkEndpointGroupsClient.GetAsync(request);

GetAsync(GetRegionNetworkEndpointGroupRequest, CancellationToken)

public virtual Task<NetworkEndpointGroup> GetAsync(GetRegionNetworkEndpointGroupRequest request, CancellationToken cancellationToken)

Returns the specified network endpoint group.

Parameters
NameDescription
requestGetRegionNetworkEndpointGroupRequest

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

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskNetworkEndpointGroup

A Task containing the RPC response.

Example
// Create client
RegionNetworkEndpointGroupsClient regionNetworkEndpointGroupsClient = await RegionNetworkEndpointGroupsClient.CreateAsync();
// Initialize request argument(s)
GetRegionNetworkEndpointGroupRequest request = new GetRegionNetworkEndpointGroupRequest
{
    Region = "",
    Project = "",
    NetworkEndpointGroup = "",
};
// Make the request
NetworkEndpointGroup response = await regionNetworkEndpointGroupsClient.GetAsync(request);

GetAsync(string, string, string, CallSettings)

public virtual Task<NetworkEndpointGroup> GetAsync(string project, string region, string networkEndpointGroup, CallSettings callSettings = null)

Returns the specified network endpoint group.

Parameters
NameDescription
projectstring

Project ID for this request.

regionstring

The name of the region where the network endpoint group is located. It should comply with RFC1035.

networkEndpointGroupstring

The name of the network endpoint group. It should comply with RFC1035.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskNetworkEndpointGroup

A Task containing the RPC response.

Example
// Create client
RegionNetworkEndpointGroupsClient regionNetworkEndpointGroupsClient = await RegionNetworkEndpointGroupsClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string region = "";
string networkEndpointGroup = "";
// Make the request
NetworkEndpointGroup response = await regionNetworkEndpointGroupsClient.GetAsync(project, region, networkEndpointGroup);

GetAsync(string, string, string, CancellationToken)

public virtual Task<NetworkEndpointGroup> GetAsync(string project, string region, string networkEndpointGroup, CancellationToken cancellationToken)

Returns the specified network endpoint group.

Parameters
NameDescription
projectstring

Project ID for this request.

regionstring

The name of the region where the network endpoint group is located. It should comply with RFC1035.

networkEndpointGroupstring

The name of the network endpoint group. It should comply with RFC1035.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskNetworkEndpointGroup

A Task containing the RPC response.

Example
// Create client
RegionNetworkEndpointGroupsClient regionNetworkEndpointGroupsClient = await RegionNetworkEndpointGroupsClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string region = "";
string networkEndpointGroup = "";
// Make the request
NetworkEndpointGroup response = await regionNetworkEndpointGroupsClient.GetAsync(project, region, networkEndpointGroup);

Insert(InsertRegionNetworkEndpointGroupRequest, CallSettings)

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

Creates a network endpoint group in the specified project using the parameters that are included in the request.

Parameters
NameDescription
requestInsertRegionNetworkEndpointGroupRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationOperationOperation

The RPC response.

Example
// Create client
RegionNetworkEndpointGroupsClient regionNetworkEndpointGroupsClient = RegionNetworkEndpointGroupsClient.Create();
// Initialize request argument(s)
InsertRegionNetworkEndpointGroupRequest request = new InsertRegionNetworkEndpointGroupRequest
{
    RequestId = "",
    Region = "",
    Project = "",
    NetworkEndpointGroupResource = new NetworkEndpointGroup(),
};
// Make the request
lro::Operation<Operation, Operation> response = regionNetworkEndpointGroupsClient.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 = regionNetworkEndpointGroupsClient.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, NetworkEndpointGroup, CallSettings)

public virtual Operation<Operation, Operation> Insert(string project, string region, NetworkEndpointGroup networkEndpointGroupResource, CallSettings callSettings = null)

Creates a network endpoint group in the specified project using the parameters that are included in the request.

Parameters
NameDescription
projectstring

Project ID for this request.

regionstring

The name of the region where you want to create the network endpoint group. It should comply with RFC1035.

networkEndpointGroupResourceNetworkEndpointGroup

The body resource for this request

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationOperationOperation

The RPC response.

Example
// Create client
RegionNetworkEndpointGroupsClient regionNetworkEndpointGroupsClient = RegionNetworkEndpointGroupsClient.Create();
// Initialize request argument(s)
string project = "";
string region = "";
NetworkEndpointGroup networkEndpointGroupResource = new NetworkEndpointGroup();
// Make the request
lro::Operation<Operation, Operation> response = regionNetworkEndpointGroupsClient.Insert(project, region, networkEndpointGroupResource);

// 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 = regionNetworkEndpointGroupsClient.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(InsertRegionNetworkEndpointGroupRequest, CallSettings)

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

Creates a network endpoint group in the specified project using the parameters that are included in the request.

Parameters
NameDescription
requestInsertRegionNetworkEndpointGroupRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationOperationOperation

A Task containing the RPC response.

Example
// Create client
RegionNetworkEndpointGroupsClient regionNetworkEndpointGroupsClient = await RegionNetworkEndpointGroupsClient.CreateAsync();
// Initialize request argument(s)
InsertRegionNetworkEndpointGroupRequest request = new InsertRegionNetworkEndpointGroupRequest
{
    RequestId = "",
    Region = "",
    Project = "",
    NetworkEndpointGroupResource = new NetworkEndpointGroup(),
};
// Make the request
lro::Operation<Operation, Operation> response = await regionNetworkEndpointGroupsClient.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 regionNetworkEndpointGroupsClient.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(InsertRegionNetworkEndpointGroupRequest, CancellationToken)

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

Creates a network endpoint group in the specified project using the parameters that are included in the request.

Parameters
NameDescription
requestInsertRegionNetworkEndpointGroupRequest

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

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskOperationOperationOperation

A Task containing the RPC response.

Example
// Create client
RegionNetworkEndpointGroupsClient regionNetworkEndpointGroupsClient = await RegionNetworkEndpointGroupsClient.CreateAsync();
// Initialize request argument(s)
InsertRegionNetworkEndpointGroupRequest request = new InsertRegionNetworkEndpointGroupRequest
{
    RequestId = "",
    Region = "",
    Project = "",
    NetworkEndpointGroupResource = new NetworkEndpointGroup(),
};
// Make the request
lro::Operation<Operation, Operation> response = await regionNetworkEndpointGroupsClient.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 regionNetworkEndpointGroupsClient.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, NetworkEndpointGroup, CallSettings)

public virtual Task<Operation<Operation, Operation>> InsertAsync(string project, string region, NetworkEndpointGroup networkEndpointGroupResource, CallSettings callSettings = null)

Creates a network endpoint group in the specified project using the parameters that are included in the request.

Parameters
NameDescription
projectstring

Project ID for this request.

regionstring

The name of the region where you want to create the network endpoint group. It should comply with RFC1035.

networkEndpointGroupResourceNetworkEndpointGroup

The body resource for this request

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationOperationOperation

A Task containing the RPC response.

Example
// Create client
RegionNetworkEndpointGroupsClient regionNetworkEndpointGroupsClient = await RegionNetworkEndpointGroupsClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string region = "";
NetworkEndpointGroup networkEndpointGroupResource = new NetworkEndpointGroup();
// Make the request
lro::Operation<Operation, Operation> response = await regionNetworkEndpointGroupsClient.InsertAsync(project, region, networkEndpointGroupResource);

// 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 regionNetworkEndpointGroupsClient.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, NetworkEndpointGroup, CancellationToken)

public virtual Task<Operation<Operation, Operation>> InsertAsync(string project, string region, NetworkEndpointGroup networkEndpointGroupResource, CancellationToken cancellationToken)

Creates a network endpoint group in the specified project using the parameters that are included in the request.

Parameters
NameDescription
projectstring

Project ID for this request.

regionstring

The name of the region where you want to create the network endpoint group. It should comply with RFC1035.

networkEndpointGroupResourceNetworkEndpointGroup

The body resource for this request

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskOperationOperationOperation

A Task containing the RPC response.

Example
// Create client
RegionNetworkEndpointGroupsClient regionNetworkEndpointGroupsClient = await RegionNetworkEndpointGroupsClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string region = "";
NetworkEndpointGroup networkEndpointGroupResource = new NetworkEndpointGroup();
// Make the request
lro::Operation<Operation, Operation> response = await regionNetworkEndpointGroupsClient.InsertAsync(project, region, networkEndpointGroupResource);

// 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 regionNetworkEndpointGroupsClient.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(ListRegionNetworkEndpointGroupsRequest, CallSettings)

public virtual PagedEnumerable<NetworkEndpointGroupList, NetworkEndpointGroup> List(ListRegionNetworkEndpointGroupsRequest request, CallSettings callSettings = null)

Retrieves the list of regional network endpoint groups available to the specified project in the given region.

Parameters
NameDescription
requestListRegionNetworkEndpointGroupsRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerableNetworkEndpointGroupListNetworkEndpointGroup

A pageable sequence of NetworkEndpointGroup resources.

Example
// Create client
RegionNetworkEndpointGroupsClient regionNetworkEndpointGroupsClient = RegionNetworkEndpointGroupsClient.Create();
// Initialize request argument(s)
ListRegionNetworkEndpointGroupsRequest request = new ListRegionNetworkEndpointGroupsRequest
{
    Region = "",
    OrderBy = "",
    Project = "",
    Filter = "",
    ReturnPartialSuccess = false,
};
// Make the request
PagedEnumerable<NetworkEndpointGroupList, NetworkEndpointGroup> response = regionNetworkEndpointGroupsClient.List(request);

// Iterate over all response items, lazily performing RPCs as required
foreach (NetworkEndpointGroup 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 (NetworkEndpointGroupList page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (NetworkEndpointGroup 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<NetworkEndpointGroup> 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 (NetworkEndpointGroup 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<NetworkEndpointGroupList, NetworkEndpointGroup> List(string project, string region, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Retrieves the list of regional network endpoint groups available to the specified project in the given region.

Parameters
NameDescription
projectstring

Project ID for this request.

regionstring

The name of the region where the network endpoint group is located. It should comply with RFC1035.

pageTokenstring

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSizeint

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.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerableNetworkEndpointGroupListNetworkEndpointGroup

A pageable sequence of NetworkEndpointGroup resources.

Example
// Create client
RegionNetworkEndpointGroupsClient regionNetworkEndpointGroupsClient = RegionNetworkEndpointGroupsClient.Create();
// Initialize request argument(s)
string project = "";
string region = "";
// Make the request
PagedEnumerable<NetworkEndpointGroupList, NetworkEndpointGroup> response = regionNetworkEndpointGroupsClient.List(project, region);

// Iterate over all response items, lazily performing RPCs as required
foreach (NetworkEndpointGroup 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 (NetworkEndpointGroupList page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (NetworkEndpointGroup 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<NetworkEndpointGroup> 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 (NetworkEndpointGroup 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(ListRegionNetworkEndpointGroupsRequest, CallSettings)

public virtual PagedAsyncEnumerable<NetworkEndpointGroupList, NetworkEndpointGroup> ListAsync(ListRegionNetworkEndpointGroupsRequest request, CallSettings callSettings = null)

Retrieves the list of regional network endpoint groups available to the specified project in the given region.

Parameters
NameDescription
requestListRegionNetworkEndpointGroupsRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerableNetworkEndpointGroupListNetworkEndpointGroup

A pageable asynchronous sequence of NetworkEndpointGroup resources.

Example
// Create client
RegionNetworkEndpointGroupsClient regionNetworkEndpointGroupsClient = await RegionNetworkEndpointGroupsClient.CreateAsync();
// Initialize request argument(s)
ListRegionNetworkEndpointGroupsRequest request = new ListRegionNetworkEndpointGroupsRequest
{
    Region = "",
    OrderBy = "",
    Project = "",
    Filter = "",
    ReturnPartialSuccess = false,
};
// Make the request
PagedAsyncEnumerable<NetworkEndpointGroupList, NetworkEndpointGroup> response = regionNetworkEndpointGroupsClient.ListAsync(request);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((NetworkEndpointGroup 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((NetworkEndpointGroupList page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (NetworkEndpointGroup 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<NetworkEndpointGroup> 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 (NetworkEndpointGroup 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<NetworkEndpointGroupList, NetworkEndpointGroup> ListAsync(string project, string region, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Retrieves the list of regional network endpoint groups available to the specified project in the given region.

Parameters
NameDescription
projectstring

Project ID for this request.

regionstring

The name of the region where the network endpoint group is located. It should comply with RFC1035.

pageTokenstring

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSizeint

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.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerableNetworkEndpointGroupListNetworkEndpointGroup

A pageable asynchronous sequence of NetworkEndpointGroup resources.

Example
// Create client
RegionNetworkEndpointGroupsClient regionNetworkEndpointGroupsClient = await RegionNetworkEndpointGroupsClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string region = "";
// Make the request
PagedAsyncEnumerable<NetworkEndpointGroupList, NetworkEndpointGroup> response = regionNetworkEndpointGroupsClient.ListAsync(project, region);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((NetworkEndpointGroup 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((NetworkEndpointGroupList page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (NetworkEndpointGroup 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<NetworkEndpointGroup> 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 (NetworkEndpointGroup 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
NameDescription
operationNamestring

The name of a previously invoked operation. Must not be null or empty.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
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
NameDescription
operationNamestring

The name of a previously invoked operation. Must not be null or empty.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
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
NameDescription
operationNamestring

The name of a previously invoked operation. Must not be null or empty.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
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
NameDescription
operationNamestring

The name of a previously invoked operation. Must not be null or empty.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationOperationOperation

A task representing the result of polling the operation.

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
TypeDescription
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.