Class NetworkEndpointGroupsClient (1.4.0)

public abstract class NetworkEndpointGroupsClient

NetworkEndpointGroups client wrapper, for convenient use.

Inheritance

Object > NetworkEndpointGroupsClient

Namespace

Google.Cloud.Compute.V1

Assembly

Google.Cloud.Compute.V1.dll

Remarks

The NetworkEndpointGroups API.

Properties

AttachNetworkEndpointsOperationsClient

public virtual OperationsClient AttachNetworkEndpointsOperationsClient { get; }

The long-running operations client for AttachNetworkEndpoints.

Property Value
TypeDescription
OperationsClient

DefaultEndpoint

public static string DefaultEndpoint { get; }

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

Property Value
TypeDescription
IReadOnlyList<String>
Remarks

DeleteOperationsClient

public virtual OperationsClient DeleteOperationsClient { get; }

The long-running operations client for Delete.

Property Value
TypeDescription
OperationsClient

DetachNetworkEndpointsOperationsClient

public virtual OperationsClient DetachNetworkEndpointsOperationsClient { get; }

The long-running operations client for DetachNetworkEndpoints.

Property Value
TypeDescription
OperationsClient

GrpcClient

public virtual NetworkEndpointGroups.NetworkEndpointGroupsClient GrpcClient { get; }

The underlying gRPC NetworkEndpointGroups client

Property Value
TypeDescription
NetworkEndpointGroups.NetworkEndpointGroupsClient

InsertOperationsClient

public virtual OperationsClient InsertOperationsClient { get; }

The long-running operations client for Insert.

Property Value
TypeDescription
OperationsClient

Methods

AggregatedList(AggregatedListNetworkEndpointGroupsRequest, CallSettings)

public virtual PagedEnumerable<NetworkEndpointGroupAggregatedList, KeyValuePair<string, NetworkEndpointGroupsScopedList>> AggregatedList(AggregatedListNetworkEndpointGroupsRequest request, CallSettings callSettings = null)

Retrieves the list of network endpoint groups and sorts them by zone.

Parameters
NameDescription
requestAggregatedListNetworkEndpointGroupsRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerable<NetworkEndpointGroupAggregatedList, KeyValuePair<String, NetworkEndpointGroupsScopedList>>

A pageable sequence of KeyValuePair<TKey,TValue> resources.

Example
// Create client
NetworkEndpointGroupsClient networkEndpointGroupsClient = NetworkEndpointGroupsClient.Create();
// Initialize request argument(s)
AggregatedListNetworkEndpointGroupsRequest request = new AggregatedListNetworkEndpointGroupsRequest
{
    OrderBy = "",
    Project = "",
    Filter = "",
    IncludeAllScopes = false,
    ReturnPartialSuccess = false,
};
// Make the request
PagedEnumerable<NetworkEndpointGroupAggregatedList, KeyValuePair<string, NetworkEndpointGroupsScopedList>> response = networkEndpointGroupsClient.AggregatedList(request);

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

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<KeyValuePair<string, NetworkEndpointGroupsScopedList>> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (KeyValuePair<string, NetworkEndpointGroupsScopedList> item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

AggregatedList(String, String, Nullable<Int32>, CallSettings)

public virtual PagedEnumerable<NetworkEndpointGroupAggregatedList, KeyValuePair<string, NetworkEndpointGroupsScopedList>> AggregatedList(string project, string pageToken = null, int? pageSize = default(int? ), CallSettings callSettings = null)

Retrieves the list of network endpoint groups and sorts them by zone.

Parameters
NameDescription
projectString

Project ID for this request.

pageTokenString

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

pageSizeNullable<Int32>

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
PagedEnumerable<NetworkEndpointGroupAggregatedList, KeyValuePair<String, NetworkEndpointGroupsScopedList>>

A pageable sequence of KeyValuePair<TKey,TValue> resources.

Example
// Create client
NetworkEndpointGroupsClient networkEndpointGroupsClient = NetworkEndpointGroupsClient.Create();
// Initialize request argument(s)
string project = "";
// Make the request
PagedEnumerable<NetworkEndpointGroupAggregatedList, KeyValuePair<string, NetworkEndpointGroupsScopedList>> response = networkEndpointGroupsClient.AggregatedList(project);

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

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<KeyValuePair<string, NetworkEndpointGroupsScopedList>> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (KeyValuePair<string, NetworkEndpointGroupsScopedList> item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

AggregatedListAsync(AggregatedListNetworkEndpointGroupsRequest, CallSettings)

public virtual PagedAsyncEnumerable<NetworkEndpointGroupAggregatedList, KeyValuePair<string, NetworkEndpointGroupsScopedList>> AggregatedListAsync(AggregatedListNetworkEndpointGroupsRequest request, CallSettings callSettings = null)

Retrieves the list of network endpoint groups and sorts them by zone.

Parameters
NameDescription
requestAggregatedListNetworkEndpointGroupsRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerable<NetworkEndpointGroupAggregatedList, KeyValuePair<String, NetworkEndpointGroupsScopedList>>

A pageable asynchronous sequence of KeyValuePair<TKey,TValue> resources.

Example
// Create client
NetworkEndpointGroupsClient networkEndpointGroupsClient = await NetworkEndpointGroupsClient.CreateAsync();
// Initialize request argument(s)
AggregatedListNetworkEndpointGroupsRequest request = new AggregatedListNetworkEndpointGroupsRequest
{
    OrderBy = "",
    Project = "",
    Filter = "",
    IncludeAllScopes = false,
    ReturnPartialSuccess = false,
};
// Make the request
PagedAsyncEnumerable<NetworkEndpointGroupAggregatedList, KeyValuePair<string, NetworkEndpointGroupsScopedList>> response = networkEndpointGroupsClient.AggregatedListAsync(request);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((KeyValuePair<string, NetworkEndpointGroupsScopedList> 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((NetworkEndpointGroupAggregatedList page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (KeyValuePair<string, NetworkEndpointGroupsScopedList> item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<KeyValuePair<string, NetworkEndpointGroupsScopedList>> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (KeyValuePair<string, NetworkEndpointGroupsScopedList> item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

AggregatedListAsync(String, String, Nullable<Int32>, CallSettings)

public virtual PagedAsyncEnumerable<NetworkEndpointGroupAggregatedList, KeyValuePair<string, NetworkEndpointGroupsScopedList>> AggregatedListAsync(string project, string pageToken = null, int? pageSize = default(int? ), CallSettings callSettings = null)

Retrieves the list of network endpoint groups and sorts them by zone.

Parameters
NameDescription
projectString

Project ID for this request.

pageTokenString

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

pageSizeNullable<Int32>

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
PagedAsyncEnumerable<NetworkEndpointGroupAggregatedList, KeyValuePair<String, NetworkEndpointGroupsScopedList>>

A pageable asynchronous sequence of KeyValuePair<TKey,TValue> resources.

Example
// Create client
NetworkEndpointGroupsClient networkEndpointGroupsClient = await NetworkEndpointGroupsClient.CreateAsync();
// Initialize request argument(s)
string project = "";
// Make the request
PagedAsyncEnumerable<NetworkEndpointGroupAggregatedList, KeyValuePair<string, NetworkEndpointGroupsScopedList>> response = networkEndpointGroupsClient.AggregatedListAsync(project);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((KeyValuePair<string, NetworkEndpointGroupsScopedList> 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((NetworkEndpointGroupAggregatedList page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (KeyValuePair<string, NetworkEndpointGroupsScopedList> item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<KeyValuePair<string, NetworkEndpointGroupsScopedList>> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (KeyValuePair<string, NetworkEndpointGroupsScopedList> 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;

AttachNetworkEndpoints(AttachNetworkEndpointsNetworkEndpointGroupRequest, CallSettings)

public virtual Operation<Operation, Operation> AttachNetworkEndpoints(AttachNetworkEndpointsNetworkEndpointGroupRequest request, CallSettings callSettings = null)

Attach a list of network endpoints to the specified network endpoint group.

Parameters
NameDescription
requestAttachNetworkEndpointsNetworkEndpointGroupRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Operation<Operation, Operation>

The RPC response.

Example
// Create client
NetworkEndpointGroupsClient networkEndpointGroupsClient = NetworkEndpointGroupsClient.Create();
// Initialize request argument(s)
AttachNetworkEndpointsNetworkEndpointGroupRequest request = new AttachNetworkEndpointsNetworkEndpointGroupRequest
{
    NetworkEndpointGroupsAttachEndpointsRequestResource = new NetworkEndpointGroupsAttachEndpointsRequest(),
    Zone = "",
    RequestId = "",
    Project = "",
    NetworkEndpointGroup = "",
};
// Make the request
lro::Operation<Operation, Operation> response = networkEndpointGroupsClient.AttachNetworkEndpoints(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 = networkEndpointGroupsClient.PollOnceAttachNetworkEndpoints(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;
}

AttachNetworkEndpoints(String, String, String, NetworkEndpointGroupsAttachEndpointsRequest, CallSettings)

public virtual Operation<Operation, Operation> AttachNetworkEndpoints(string project, string zone, string networkEndpointGroup, NetworkEndpointGroupsAttachEndpointsRequest networkEndpointGroupsAttachEndpointsRequestResource, CallSettings callSettings = null)

Attach a list of network endpoints to the specified network endpoint group.

Parameters
NameDescription
projectString

Project ID for this request.

zoneString

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

networkEndpointGroupString

The name of the network endpoint group where you are attaching network endpoints to. It should comply with RFC1035.

networkEndpointGroupsAttachEndpointsRequestResourceNetworkEndpointGroupsAttachEndpointsRequest

The body resource for this request

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Operation<Operation, Operation>

The RPC response.

Example
// Create client
NetworkEndpointGroupsClient networkEndpointGroupsClient = NetworkEndpointGroupsClient.Create();
// Initialize request argument(s)
string project = "";
string zone = "";
string networkEndpointGroup = "";
NetworkEndpointGroupsAttachEndpointsRequest networkEndpointGroupsAttachEndpointsRequestResource = new NetworkEndpointGroupsAttachEndpointsRequest();
// Make the request
lro::Operation<Operation, Operation> response = networkEndpointGroupsClient.AttachNetworkEndpoints(project, zone, networkEndpointGroup, networkEndpointGroupsAttachEndpointsRequestResource);

// 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 = networkEndpointGroupsClient.PollOnceAttachNetworkEndpoints(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;
}

AttachNetworkEndpointsAsync(AttachNetworkEndpointsNetworkEndpointGroupRequest, CallSettings)

public virtual Task<Operation<Operation, Operation>> AttachNetworkEndpointsAsync(AttachNetworkEndpointsNetworkEndpointGroupRequest request, CallSettings callSettings = null)

Attach a list of network endpoints to the specified network endpoint group.

Parameters
NameDescription
requestAttachNetworkEndpointsNetworkEndpointGroupRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Operation<Operation, Operation>>

A Task containing the RPC response.

Example
// Create client
NetworkEndpointGroupsClient networkEndpointGroupsClient = await NetworkEndpointGroupsClient.CreateAsync();
// Initialize request argument(s)
AttachNetworkEndpointsNetworkEndpointGroupRequest request = new AttachNetworkEndpointsNetworkEndpointGroupRequest
{
    NetworkEndpointGroupsAttachEndpointsRequestResource = new NetworkEndpointGroupsAttachEndpointsRequest(),
    Zone = "",
    RequestId = "",
    Project = "",
    NetworkEndpointGroup = "",
};
// Make the request
lro::Operation<Operation, Operation> response = await networkEndpointGroupsClient.AttachNetworkEndpointsAsync(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 networkEndpointGroupsClient.PollOnceAttachNetworkEndpointsAsync(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;
}

AttachNetworkEndpointsAsync(AttachNetworkEndpointsNetworkEndpointGroupRequest, CancellationToken)

public virtual Task<Operation<Operation, Operation>> AttachNetworkEndpointsAsync(AttachNetworkEndpointsNetworkEndpointGroupRequest request, CancellationToken cancellationToken)

Attach a list of network endpoints to the specified network endpoint group.

Parameters
NameDescription
requestAttachNetworkEndpointsNetworkEndpointGroupRequest

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

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task<Operation<Operation, Operation>>

A Task containing the RPC response.

Example
// Create client
NetworkEndpointGroupsClient networkEndpointGroupsClient = await NetworkEndpointGroupsClient.CreateAsync();
// Initialize request argument(s)
AttachNetworkEndpointsNetworkEndpointGroupRequest request = new AttachNetworkEndpointsNetworkEndpointGroupRequest
{
    NetworkEndpointGroupsAttachEndpointsRequestResource = new NetworkEndpointGroupsAttachEndpointsRequest(),
    Zone = "",
    RequestId = "",
    Project = "",
    NetworkEndpointGroup = "",
};
// Make the request
lro::Operation<Operation, Operation> response = await networkEndpointGroupsClient.AttachNetworkEndpointsAsync(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 networkEndpointGroupsClient.PollOnceAttachNetworkEndpointsAsync(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;
}

AttachNetworkEndpointsAsync(String, String, String, NetworkEndpointGroupsAttachEndpointsRequest, CallSettings)

public virtual Task<Operation<Operation, Operation>> AttachNetworkEndpointsAsync(string project, string zone, string networkEndpointGroup, NetworkEndpointGroupsAttachEndpointsRequest networkEndpointGroupsAttachEndpointsRequestResource, CallSettings callSettings = null)

Attach a list of network endpoints to the specified network endpoint group.

Parameters
NameDescription
projectString

Project ID for this request.

zoneString

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

networkEndpointGroupString

The name of the network endpoint group where you are attaching network endpoints to. It should comply with RFC1035.

networkEndpointGroupsAttachEndpointsRequestResourceNetworkEndpointGroupsAttachEndpointsRequest

The body resource for this request

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Operation<Operation, Operation>>

A Task containing the RPC response.

Example
// Create client
NetworkEndpointGroupsClient networkEndpointGroupsClient = await NetworkEndpointGroupsClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string zone = "";
string networkEndpointGroup = "";
NetworkEndpointGroupsAttachEndpointsRequest networkEndpointGroupsAttachEndpointsRequestResource = new NetworkEndpointGroupsAttachEndpointsRequest();
// Make the request
lro::Operation<Operation, Operation> response = await networkEndpointGroupsClient.AttachNetworkEndpointsAsync(project, zone, networkEndpointGroup, networkEndpointGroupsAttachEndpointsRequestResource);

// 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 networkEndpointGroupsClient.PollOnceAttachNetworkEndpointsAsync(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;
}

AttachNetworkEndpointsAsync(String, String, String, NetworkEndpointGroupsAttachEndpointsRequest, CancellationToken)

public virtual Task<Operation<Operation, Operation>> AttachNetworkEndpointsAsync(string project, string zone, string networkEndpointGroup, NetworkEndpointGroupsAttachEndpointsRequest networkEndpointGroupsAttachEndpointsRequestResource, CancellationToken cancellationToken)

Attach a list of network endpoints to the specified network endpoint group.

Parameters
NameDescription
projectString

Project ID for this request.

zoneString

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

networkEndpointGroupString

The name of the network endpoint group where you are attaching network endpoints to. It should comply with RFC1035.

networkEndpointGroupsAttachEndpointsRequestResourceNetworkEndpointGroupsAttachEndpointsRequest

The body resource for this request

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task<Operation<Operation, Operation>>

A Task containing the RPC response.

Example
// Create client
NetworkEndpointGroupsClient networkEndpointGroupsClient = await NetworkEndpointGroupsClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string zone = "";
string networkEndpointGroup = "";
NetworkEndpointGroupsAttachEndpointsRequest networkEndpointGroupsAttachEndpointsRequestResource = new NetworkEndpointGroupsAttachEndpointsRequest();
// Make the request
lro::Operation<Operation, Operation> response = await networkEndpointGroupsClient.AttachNetworkEndpointsAsync(project, zone, networkEndpointGroup, networkEndpointGroupsAttachEndpointsRequestResource);

// 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 networkEndpointGroupsClient.PollOnceAttachNetworkEndpointsAsync(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;
}

Create()

public static NetworkEndpointGroupsClient Create()

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

Returns
TypeDescription
NetworkEndpointGroupsClient

The created NetworkEndpointGroupsClient.

CreateAsync(CancellationToken)

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

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

Parameter
NameDescription
cancellationTokenCancellationToken

The CancellationToken to use while creating the client.

Returns
TypeDescription
Task<NetworkEndpointGroupsClient>

The task representing the created NetworkEndpointGroupsClient.

Delete(DeleteNetworkEndpointGroupRequest, CallSettings)

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

Deletes the specified network endpoint group. The network endpoints in the NEG and the VM instances they belong to are not terminated when the NEG is deleted. Note that the NEG cannot be deleted if there are backend services referencing it.

Parameters
NameDescription
requestDeleteNetworkEndpointGroupRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Operation<Operation, Operation>

The RPC response.

Example
// Create client
NetworkEndpointGroupsClient networkEndpointGroupsClient = NetworkEndpointGroupsClient.Create();
// Initialize request argument(s)
DeleteNetworkEndpointGroupRequest request = new DeleteNetworkEndpointGroupRequest
{
    Zone = "",
    RequestId = "",
    Project = "",
    NetworkEndpointGroup = "",
};
// Make the request
lro::Operation<Operation, Operation> response = networkEndpointGroupsClient.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 = networkEndpointGroupsClient.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 zone, string networkEndpointGroup, CallSettings callSettings = null)

Deletes the specified network endpoint group. The network endpoints in the NEG and the VM instances they belong to are not terminated when the NEG is deleted. Note that the NEG cannot be deleted if there are backend services referencing it.

Parameters
NameDescription
projectString

Project ID for this request.

zoneString

The name of the zone 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
Operation<Operation, Operation>

The RPC response.

Example
// Create client
NetworkEndpointGroupsClient networkEndpointGroupsClient = NetworkEndpointGroupsClient.Create();
// Initialize request argument(s)
string project = "";
string zone = "";
string networkEndpointGroup = "";
// Make the request
lro::Operation<Operation, Operation> response = networkEndpointGroupsClient.Delete(project, zone, 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 = networkEndpointGroupsClient.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(DeleteNetworkEndpointGroupRequest, CallSettings)

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

Deletes the specified network endpoint group. The network endpoints in the NEG and the VM instances they belong to are not terminated when the NEG is deleted. Note that the NEG cannot be deleted if there are backend services referencing it.

Parameters
NameDescription
requestDeleteNetworkEndpointGroupRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Operation<Operation, Operation>>

A Task containing the RPC response.

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

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

Deletes the specified network endpoint group. The network endpoints in the NEG and the VM instances they belong to are not terminated when the NEG is deleted. Note that the NEG cannot be deleted if there are backend services referencing it.

Parameters
NameDescription
requestDeleteNetworkEndpointGroupRequest

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

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task<Operation<Operation, Operation>>

A Task containing the RPC response.

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

Deletes the specified network endpoint group. The network endpoints in the NEG and the VM instances they belong to are not terminated when the NEG is deleted. Note that the NEG cannot be deleted if there are backend services referencing it.

Parameters
NameDescription
projectString

Project ID for this request.

zoneString

The name of the zone 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
Task<Operation<Operation, Operation>>

A Task containing the RPC response.

Example
// Create client
NetworkEndpointGroupsClient networkEndpointGroupsClient = await NetworkEndpointGroupsClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string zone = "";
string networkEndpointGroup = "";
// Make the request
lro::Operation<Operation, Operation> response = await networkEndpointGroupsClient.DeleteAsync(project, zone, 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 networkEndpointGroupsClient.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 zone, string networkEndpointGroup, CancellationToken cancellationToken)

Deletes the specified network endpoint group. The network endpoints in the NEG and the VM instances they belong to are not terminated when the NEG is deleted. Note that the NEG cannot be deleted if there are backend services referencing it.

Parameters
NameDescription
projectString

Project ID for this request.

zoneString

The name of the zone 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
Task<Operation<Operation, Operation>>

A Task containing the RPC response.

Example
// Create client
NetworkEndpointGroupsClient networkEndpointGroupsClient = await NetworkEndpointGroupsClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string zone = "";
string networkEndpointGroup = "";
// Make the request
lro::Operation<Operation, Operation> response = await networkEndpointGroupsClient.DeleteAsync(project, zone, 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 networkEndpointGroupsClient.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;
}

DetachNetworkEndpoints(DetachNetworkEndpointsNetworkEndpointGroupRequest, CallSettings)

public virtual Operation<Operation, Operation> DetachNetworkEndpoints(DetachNetworkEndpointsNetworkEndpointGroupRequest request, CallSettings callSettings = null)

Detach a list of network endpoints from the specified network endpoint group.

Parameters
NameDescription
requestDetachNetworkEndpointsNetworkEndpointGroupRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Operation<Operation, Operation>

The RPC response.

Example
// Create client
NetworkEndpointGroupsClient networkEndpointGroupsClient = NetworkEndpointGroupsClient.Create();
// Initialize request argument(s)
DetachNetworkEndpointsNetworkEndpointGroupRequest request = new DetachNetworkEndpointsNetworkEndpointGroupRequest
{
    Zone = "",
    RequestId = "",
    Project = "",
    NetworkEndpointGroup = "",
    NetworkEndpointGroupsDetachEndpointsRequestResource = new NetworkEndpointGroupsDetachEndpointsRequest(),
};
// Make the request
lro::Operation<Operation, Operation> response = networkEndpointGroupsClient.DetachNetworkEndpoints(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 = networkEndpointGroupsClient.PollOnceDetachNetworkEndpoints(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;
}

DetachNetworkEndpoints(String, String, String, NetworkEndpointGroupsDetachEndpointsRequest, CallSettings)

public virtual Operation<Operation, Operation> DetachNetworkEndpoints(string project, string zone, string networkEndpointGroup, NetworkEndpointGroupsDetachEndpointsRequest networkEndpointGroupsDetachEndpointsRequestResource, CallSettings callSettings = null)

Detach a list of network endpoints from the specified network endpoint group.

Parameters
NameDescription
projectString

Project ID for this request.

zoneString

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

networkEndpointGroupString

The name of the network endpoint group where you are removing network endpoints. It should comply with RFC1035.

networkEndpointGroupsDetachEndpointsRequestResourceNetworkEndpointGroupsDetachEndpointsRequest

The body resource for this request

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Operation<Operation, Operation>

The RPC response.

Example
// Create client
NetworkEndpointGroupsClient networkEndpointGroupsClient = NetworkEndpointGroupsClient.Create();
// Initialize request argument(s)
string project = "";
string zone = "";
string networkEndpointGroup = "";
NetworkEndpointGroupsDetachEndpointsRequest networkEndpointGroupsDetachEndpointsRequestResource = new NetworkEndpointGroupsDetachEndpointsRequest();
// Make the request
lro::Operation<Operation, Operation> response = networkEndpointGroupsClient.DetachNetworkEndpoints(project, zone, networkEndpointGroup, networkEndpointGroupsDetachEndpointsRequestResource);

// 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 = networkEndpointGroupsClient.PollOnceDetachNetworkEndpoints(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;
}

DetachNetworkEndpointsAsync(DetachNetworkEndpointsNetworkEndpointGroupRequest, CallSettings)

public virtual Task<Operation<Operation, Operation>> DetachNetworkEndpointsAsync(DetachNetworkEndpointsNetworkEndpointGroupRequest request, CallSettings callSettings = null)

Detach a list of network endpoints from the specified network endpoint group.

Parameters
NameDescription
requestDetachNetworkEndpointsNetworkEndpointGroupRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Operation<Operation, Operation>>

A Task containing the RPC response.

Example
// Create client
NetworkEndpointGroupsClient networkEndpointGroupsClient = await NetworkEndpointGroupsClient.CreateAsync();
// Initialize request argument(s)
DetachNetworkEndpointsNetworkEndpointGroupRequest request = new DetachNetworkEndpointsNetworkEndpointGroupRequest
{
    Zone = "",
    RequestId = "",
    Project = "",
    NetworkEndpointGroup = "",
    NetworkEndpointGroupsDetachEndpointsRequestResource = new NetworkEndpointGroupsDetachEndpointsRequest(),
};
// Make the request
lro::Operation<Operation, Operation> response = await networkEndpointGroupsClient.DetachNetworkEndpointsAsync(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 networkEndpointGroupsClient.PollOnceDetachNetworkEndpointsAsync(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;
}

DetachNetworkEndpointsAsync(DetachNetworkEndpointsNetworkEndpointGroupRequest, CancellationToken)

public virtual Task<Operation<Operation, Operation>> DetachNetworkEndpointsAsync(DetachNetworkEndpointsNetworkEndpointGroupRequest request, CancellationToken cancellationToken)

Detach a list of network endpoints from the specified network endpoint group.

Parameters
NameDescription
requestDetachNetworkEndpointsNetworkEndpointGroupRequest

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

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task<Operation<Operation, Operation>>

A Task containing the RPC response.

Example
// Create client
NetworkEndpointGroupsClient networkEndpointGroupsClient = await NetworkEndpointGroupsClient.CreateAsync();
// Initialize request argument(s)
DetachNetworkEndpointsNetworkEndpointGroupRequest request = new DetachNetworkEndpointsNetworkEndpointGroupRequest
{
    Zone = "",
    RequestId = "",
    Project = "",
    NetworkEndpointGroup = "",
    NetworkEndpointGroupsDetachEndpointsRequestResource = new NetworkEndpointGroupsDetachEndpointsRequest(),
};
// Make the request
lro::Operation<Operation, Operation> response = await networkEndpointGroupsClient.DetachNetworkEndpointsAsync(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 networkEndpointGroupsClient.PollOnceDetachNetworkEndpointsAsync(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;
}

DetachNetworkEndpointsAsync(String, String, String, NetworkEndpointGroupsDetachEndpointsRequest, CallSettings)

public virtual Task<Operation<Operation, Operation>> DetachNetworkEndpointsAsync(string project, string zone, string networkEndpointGroup, NetworkEndpointGroupsDetachEndpointsRequest networkEndpointGroupsDetachEndpointsRequestResource, CallSettings callSettings = null)

Detach a list of network endpoints from the specified network endpoint group.

Parameters
NameDescription
projectString

Project ID for this request.

zoneString

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

networkEndpointGroupString

The name of the network endpoint group where you are removing network endpoints. It should comply with RFC1035.

networkEndpointGroupsDetachEndpointsRequestResourceNetworkEndpointGroupsDetachEndpointsRequest

The body resource for this request

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Operation<Operation, Operation>>

A Task containing the RPC response.

Example
// Create client
NetworkEndpointGroupsClient networkEndpointGroupsClient = await NetworkEndpointGroupsClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string zone = "";
string networkEndpointGroup = "";
NetworkEndpointGroupsDetachEndpointsRequest networkEndpointGroupsDetachEndpointsRequestResource = new NetworkEndpointGroupsDetachEndpointsRequest();
// Make the request
lro::Operation<Operation, Operation> response = await networkEndpointGroupsClient.DetachNetworkEndpointsAsync(project, zone, networkEndpointGroup, networkEndpointGroupsDetachEndpointsRequestResource);

// 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 networkEndpointGroupsClient.PollOnceDetachNetworkEndpointsAsync(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;
}

DetachNetworkEndpointsAsync(String, String, String, NetworkEndpointGroupsDetachEndpointsRequest, CancellationToken)

public virtual Task<Operation<Operation, Operation>> DetachNetworkEndpointsAsync(string project, string zone, string networkEndpointGroup, NetworkEndpointGroupsDetachEndpointsRequest networkEndpointGroupsDetachEndpointsRequestResource, CancellationToken cancellationToken)

Detach a list of network endpoints from the specified network endpoint group.

Parameters
NameDescription
projectString

Project ID for this request.

zoneString

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

networkEndpointGroupString

The name of the network endpoint group where you are removing network endpoints. It should comply with RFC1035.

networkEndpointGroupsDetachEndpointsRequestResourceNetworkEndpointGroupsDetachEndpointsRequest

The body resource for this request

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task<Operation<Operation, Operation>>

A Task containing the RPC response.

Example
// Create client
NetworkEndpointGroupsClient networkEndpointGroupsClient = await NetworkEndpointGroupsClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string zone = "";
string networkEndpointGroup = "";
NetworkEndpointGroupsDetachEndpointsRequest networkEndpointGroupsDetachEndpointsRequestResource = new NetworkEndpointGroupsDetachEndpointsRequest();
// Make the request
lro::Operation<Operation, Operation> response = await networkEndpointGroupsClient.DetachNetworkEndpointsAsync(project, zone, networkEndpointGroup, networkEndpointGroupsDetachEndpointsRequestResource);

// 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 networkEndpointGroupsClient.PollOnceDetachNetworkEndpointsAsync(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(GetNetworkEndpointGroupRequest, CallSettings)

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

Returns the specified network endpoint group. Gets a list of available network endpoint groups by making a list() request.

Parameters
NameDescription
requestGetNetworkEndpointGroupRequest

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
NetworkEndpointGroupsClient networkEndpointGroupsClient = NetworkEndpointGroupsClient.Create();
// Initialize request argument(s)
GetNetworkEndpointGroupRequest request = new GetNetworkEndpointGroupRequest
{
    Zone = "",
    Project = "",
    NetworkEndpointGroup = "",
};
// Make the request
NetworkEndpointGroup response = networkEndpointGroupsClient.Get(request);

Get(String, String, String, CallSettings)

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

Returns the specified network endpoint group. Gets a list of available network endpoint groups by making a list() request.

Parameters
NameDescription
projectString

Project ID for this request.

zoneString

The name of the zone 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
NetworkEndpointGroupsClient networkEndpointGroupsClient = NetworkEndpointGroupsClient.Create();
// Initialize request argument(s)
string project = "";
string zone = "";
string networkEndpointGroup = "";
// Make the request
NetworkEndpointGroup response = networkEndpointGroupsClient.Get(project, zone, networkEndpointGroup);

GetAsync(GetNetworkEndpointGroupRequest, CallSettings)

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

Returns the specified network endpoint group. Gets a list of available network endpoint groups by making a list() request.

Parameters
NameDescription
requestGetNetworkEndpointGroupRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<NetworkEndpointGroup>

A Task containing the RPC response.

Example
// Create client
NetworkEndpointGroupsClient networkEndpointGroupsClient = await NetworkEndpointGroupsClient.CreateAsync();
// Initialize request argument(s)
GetNetworkEndpointGroupRequest request = new GetNetworkEndpointGroupRequest
{
    Zone = "",
    Project = "",
    NetworkEndpointGroup = "",
};
// Make the request
NetworkEndpointGroup response = await networkEndpointGroupsClient.GetAsync(request);

GetAsync(GetNetworkEndpointGroupRequest, CancellationToken)

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

Returns the specified network endpoint group. Gets a list of available network endpoint groups by making a list() request.

Parameters
NameDescription
requestGetNetworkEndpointGroupRequest

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

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task<NetworkEndpointGroup>

A Task containing the RPC response.

Example
// Create client
NetworkEndpointGroupsClient networkEndpointGroupsClient = await NetworkEndpointGroupsClient.CreateAsync();
// Initialize request argument(s)
GetNetworkEndpointGroupRequest request = new GetNetworkEndpointGroupRequest
{
    Zone = "",
    Project = "",
    NetworkEndpointGroup = "",
};
// Make the request
NetworkEndpointGroup response = await networkEndpointGroupsClient.GetAsync(request);

GetAsync(String, String, String, CallSettings)

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

Returns the specified network endpoint group. Gets a list of available network endpoint groups by making a list() request.

Parameters
NameDescription
projectString

Project ID for this request.

zoneString

The name of the zone 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
Task<NetworkEndpointGroup>

A Task containing the RPC response.

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

GetAsync(String, String, String, CancellationToken)

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

Returns the specified network endpoint group. Gets a list of available network endpoint groups by making a list() request.

Parameters
NameDescription
projectString

Project ID for this request.

zoneString

The name of the zone 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
Task<NetworkEndpointGroup>

A Task containing the RPC response.

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

Insert(InsertNetworkEndpointGroupRequest, CallSettings)

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

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

Parameters
NameDescription
requestInsertNetworkEndpointGroupRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Operation<Operation, Operation>

The RPC response.

Example
// Create client
NetworkEndpointGroupsClient networkEndpointGroupsClient = NetworkEndpointGroupsClient.Create();
// Initialize request argument(s)
InsertNetworkEndpointGroupRequest request = new InsertNetworkEndpointGroupRequest
{
    Zone = "",
    RequestId = "",
    Project = "",
    NetworkEndpointGroupResource = new NetworkEndpointGroup(),
};
// Make the request
lro::Operation<Operation, Operation> response = networkEndpointGroupsClient.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 = networkEndpointGroupsClient.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 zone, 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.

zoneString

The name of the zone 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
Operation<Operation, Operation>

The RPC response.

Example
// Create client
NetworkEndpointGroupsClient networkEndpointGroupsClient = NetworkEndpointGroupsClient.Create();
// Initialize request argument(s)
string project = "";
string zone = "";
NetworkEndpointGroup networkEndpointGroupResource = new NetworkEndpointGroup();
// Make the request
lro::Operation<Operation, Operation> response = networkEndpointGroupsClient.Insert(project, zone, 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 = networkEndpointGroupsClient.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(InsertNetworkEndpointGroupRequest, CallSettings)

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

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

Parameters
NameDescription
requestInsertNetworkEndpointGroupRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Operation<Operation, Operation>>

A Task containing the RPC response.

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

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

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

Parameters
NameDescription
requestInsertNetworkEndpointGroupRequest

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

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task<Operation<Operation, Operation>>

A Task containing the RPC response.

Example
// Create client
NetworkEndpointGroupsClient networkEndpointGroupsClient = await NetworkEndpointGroupsClient.CreateAsync();
// Initialize request argument(s)
InsertNetworkEndpointGroupRequest request = new InsertNetworkEndpointGroupRequest
{
    Zone = "",
    RequestId = "",
    Project = "",
    NetworkEndpointGroupResource = new NetworkEndpointGroup(),
};
// Make the request
lro::Operation<Operation, Operation> response = await networkEndpointGroupsClient.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 networkEndpointGroupsClient.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 zone, 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.

zoneString

The name of the zone 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
Task<Operation<Operation, Operation>>

A Task containing the RPC response.

Example
// Create client
NetworkEndpointGroupsClient networkEndpointGroupsClient = await NetworkEndpointGroupsClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string zone = "";
NetworkEndpointGroup networkEndpointGroupResource = new NetworkEndpointGroup();
// Make the request
lro::Operation<Operation, Operation> response = await networkEndpointGroupsClient.InsertAsync(project, zone, 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 networkEndpointGroupsClient.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 zone, 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.

zoneString

The name of the zone 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
Task<Operation<Operation, Operation>>

A Task containing the RPC response.

Example
// Create client
NetworkEndpointGroupsClient networkEndpointGroupsClient = await NetworkEndpointGroupsClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string zone = "";
NetworkEndpointGroup networkEndpointGroupResource = new NetworkEndpointGroup();
// Make the request
lro::Operation<Operation, Operation> response = await networkEndpointGroupsClient.InsertAsync(project, zone, 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 networkEndpointGroupsClient.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(ListNetworkEndpointGroupsRequest, CallSettings)

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

Retrieves the list of network endpoint groups that are located in the specified project and zone.

Parameters
NameDescription
requestListNetworkEndpointGroupsRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerable<NetworkEndpointGroupList, NetworkEndpointGroup>

A pageable sequence of NetworkEndpointGroup resources.

Example
// Create client
NetworkEndpointGroupsClient networkEndpointGroupsClient = NetworkEndpointGroupsClient.Create();
// Initialize request argument(s)
ListNetworkEndpointGroupsRequest request = new ListNetworkEndpointGroupsRequest
{
    Zone = "",
    OrderBy = "",
    Project = "",
    Filter = "",
    ReturnPartialSuccess = false,
};
// Make the request
PagedEnumerable<NetworkEndpointGroupList, NetworkEndpointGroup> response = networkEndpointGroupsClient.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, Nullable<Int32>, CallSettings)

public virtual PagedEnumerable<NetworkEndpointGroupList, NetworkEndpointGroup> List(string project, string zone, string pageToken = null, int? pageSize = default(int? ), CallSettings callSettings = null)

Retrieves the list of network endpoint groups that are located in the specified project and zone.

Parameters
NameDescription
projectString

Project ID for this request.

zoneString

The name of the zone 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.

pageSizeNullable<Int32>

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
PagedEnumerable<NetworkEndpointGroupList, NetworkEndpointGroup>

A pageable sequence of NetworkEndpointGroup resources.

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

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

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

Retrieves the list of network endpoint groups that are located in the specified project and zone.

Parameters
NameDescription
requestListNetworkEndpointGroupsRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerable<NetworkEndpointGroupList, NetworkEndpointGroup>

A pageable asynchronous sequence of NetworkEndpointGroup resources.

Example
// Create client
NetworkEndpointGroupsClient networkEndpointGroupsClient = await NetworkEndpointGroupsClient.CreateAsync();
// Initialize request argument(s)
ListNetworkEndpointGroupsRequest request = new ListNetworkEndpointGroupsRequest
{
    Zone = "",
    OrderBy = "",
    Project = "",
    Filter = "",
    ReturnPartialSuccess = false,
};
// Make the request
PagedAsyncEnumerable<NetworkEndpointGroupList, NetworkEndpointGroup> response = networkEndpointGroupsClient.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, Nullable<Int32>, CallSettings)

public virtual PagedAsyncEnumerable<NetworkEndpointGroupList, NetworkEndpointGroup> ListAsync(string project, string zone, string pageToken = null, int? pageSize = default(int? ), CallSettings callSettings = null)

Retrieves the list of network endpoint groups that are located in the specified project and zone.

Parameters
NameDescription
projectString

Project ID for this request.

zoneString

The name of the zone 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.

pageSizeNullable<Int32>

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
PagedAsyncEnumerable<NetworkEndpointGroupList, NetworkEndpointGroup>

A pageable asynchronous sequence of NetworkEndpointGroup resources.

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

// 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;

ListNetworkEndpoints(ListNetworkEndpointsNetworkEndpointGroupsRequest, CallSettings)

public virtual PagedEnumerable<NetworkEndpointGroupsListNetworkEndpoints, NetworkEndpointWithHealthStatus> ListNetworkEndpoints(ListNetworkEndpointsNetworkEndpointGroupsRequest request, CallSettings callSettings = null)

Lists the network endpoints in the specified network endpoint group.

Parameters
NameDescription
requestListNetworkEndpointsNetworkEndpointGroupsRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerable<NetworkEndpointGroupsListNetworkEndpoints, NetworkEndpointWithHealthStatus>

A pageable sequence of NetworkEndpointWithHealthStatus resources.

Example
// Create client
NetworkEndpointGroupsClient networkEndpointGroupsClient = NetworkEndpointGroupsClient.Create();
// Initialize request argument(s)
ListNetworkEndpointsNetworkEndpointGroupsRequest request = new ListNetworkEndpointsNetworkEndpointGroupsRequest
{
    Zone = "",
    NetworkEndpointGroupsListEndpointsRequestResource = new NetworkEndpointGroupsListEndpointsRequest(),
    OrderBy = "",
    Project = "",
    Filter = "",
    NetworkEndpointGroup = "",
    ReturnPartialSuccess = false,
};
// Make the request
PagedEnumerable<NetworkEndpointGroupsListNetworkEndpoints, NetworkEndpointWithHealthStatus> response = networkEndpointGroupsClient.ListNetworkEndpoints(request);

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

ListNetworkEndpoints(String, String, String, NetworkEndpointGroupsListEndpointsRequest, String, Nullable<Int32>, CallSettings)

public virtual PagedEnumerable<NetworkEndpointGroupsListNetworkEndpoints, NetworkEndpointWithHealthStatus> ListNetworkEndpoints(string project, string zone, string networkEndpointGroup, NetworkEndpointGroupsListEndpointsRequest networkEndpointGroupsListEndpointsRequestResource, string pageToken = null, int? pageSize = default(int? ), CallSettings callSettings = null)

Lists the network endpoints in the specified network endpoint group.

Parameters
NameDescription
projectString

Project ID for this request.

zoneString

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

networkEndpointGroupString

The name of the network endpoint group from which you want to generate a list of included network endpoints. It should comply with RFC1035.

networkEndpointGroupsListEndpointsRequestResourceNetworkEndpointGroupsListEndpointsRequest

The body resource for this request

pageTokenString

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

pageSizeNullable<Int32>

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
PagedEnumerable<NetworkEndpointGroupsListNetworkEndpoints, NetworkEndpointWithHealthStatus>

A pageable sequence of NetworkEndpointWithHealthStatus resources.

Example
// Create client
NetworkEndpointGroupsClient networkEndpointGroupsClient = NetworkEndpointGroupsClient.Create();
// Initialize request argument(s)
string project = "";
string zone = "";
string networkEndpointGroup = "";
NetworkEndpointGroupsListEndpointsRequest networkEndpointGroupsListEndpointsRequestResource = new NetworkEndpointGroupsListEndpointsRequest();
// Make the request
PagedEnumerable<NetworkEndpointGroupsListNetworkEndpoints, NetworkEndpointWithHealthStatus> response = networkEndpointGroupsClient.ListNetworkEndpoints(project, zone, networkEndpointGroup, networkEndpointGroupsListEndpointsRequestResource);

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

ListNetworkEndpointsAsync(ListNetworkEndpointsNetworkEndpointGroupsRequest, CallSettings)

public virtual PagedAsyncEnumerable<NetworkEndpointGroupsListNetworkEndpoints, NetworkEndpointWithHealthStatus> ListNetworkEndpointsAsync(ListNetworkEndpointsNetworkEndpointGroupsRequest request, CallSettings callSettings = null)

Lists the network endpoints in the specified network endpoint group.

Parameters
NameDescription
requestListNetworkEndpointsNetworkEndpointGroupsRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerable<NetworkEndpointGroupsListNetworkEndpoints, NetworkEndpointWithHealthStatus>

A pageable asynchronous sequence of NetworkEndpointWithHealthStatus resources.

Example
// Create client
NetworkEndpointGroupsClient networkEndpointGroupsClient = await NetworkEndpointGroupsClient.CreateAsync();
// Initialize request argument(s)
ListNetworkEndpointsNetworkEndpointGroupsRequest request = new ListNetworkEndpointsNetworkEndpointGroupsRequest
{
    Zone = "",
    NetworkEndpointGroupsListEndpointsRequestResource = new NetworkEndpointGroupsListEndpointsRequest(),
    OrderBy = "",
    Project = "",
    Filter = "",
    NetworkEndpointGroup = "",
    ReturnPartialSuccess = false,
};
// Make the request
PagedAsyncEnumerable<NetworkEndpointGroupsListNetworkEndpoints, NetworkEndpointWithHealthStatus> response = networkEndpointGroupsClient.ListNetworkEndpointsAsync(request);

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

ListNetworkEndpointsAsync(String, String, String, NetworkEndpointGroupsListEndpointsRequest, String, Nullable<Int32>, CallSettings)

public virtual PagedAsyncEnumerable<NetworkEndpointGroupsListNetworkEndpoints, NetworkEndpointWithHealthStatus> ListNetworkEndpointsAsync(string project, string zone, string networkEndpointGroup, NetworkEndpointGroupsListEndpointsRequest networkEndpointGroupsListEndpointsRequestResource, string pageToken = null, int? pageSize = default(int? ), CallSettings callSettings = null)

Lists the network endpoints in the specified network endpoint group.

Parameters
NameDescription
projectString

Project ID for this request.

zoneString

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

networkEndpointGroupString

The name of the network endpoint group from which you want to generate a list of included network endpoints. It should comply with RFC1035.

networkEndpointGroupsListEndpointsRequestResourceNetworkEndpointGroupsListEndpointsRequest

The body resource for this request

pageTokenString

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

pageSizeNullable<Int32>

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
PagedAsyncEnumerable<NetworkEndpointGroupsListNetworkEndpoints, NetworkEndpointWithHealthStatus>

A pageable asynchronous sequence of NetworkEndpointWithHealthStatus resources.

Example
// Create client
NetworkEndpointGroupsClient networkEndpointGroupsClient = await NetworkEndpointGroupsClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string zone = "";
string networkEndpointGroup = "";
NetworkEndpointGroupsListEndpointsRequest networkEndpointGroupsListEndpointsRequestResource = new NetworkEndpointGroupsListEndpointsRequest();
// Make the request
PagedAsyncEnumerable<NetworkEndpointGroupsListNetworkEndpoints, NetworkEndpointWithHealthStatus> response = networkEndpointGroupsClient.ListNetworkEndpointsAsync(project, zone, networkEndpointGroup, networkEndpointGroupsListEndpointsRequestResource);

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

PollOnceAttachNetworkEndpoints(String, CallSettings)

public virtual Operation<Operation, Operation> PollOnceAttachNetworkEndpoints(string operationName, CallSettings callSettings = null)

Poll an operation once, using an operationName from a previous invocation of AttachNetworkEndpoints.

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
Operation<Operation, Operation>

The result of polling the operation.

PollOnceAttachNetworkEndpointsAsync(String, CallSettings)

public virtual Task<Operation<Operation, Operation>> PollOnceAttachNetworkEndpointsAsync(string operationName, CallSettings callSettings = null)

Asynchronously poll an operation once, using an operationName from a previous invocation of AttachNetworkEndpoints.

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
Task<Operation<Operation, Operation>>

A task representing the result of polling the operation.

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
Operation<Operation, Operation>

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
Task<Operation<Operation, Operation>>

A task representing the result of polling the operation.

PollOnceDetachNetworkEndpoints(String, CallSettings)

public virtual Operation<Operation, Operation> PollOnceDetachNetworkEndpoints(string operationName, CallSettings callSettings = null)

Poll an operation once, using an operationName from a previous invocation of DetachNetworkEndpoints.

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
Operation<Operation, Operation>

The result of polling the operation.

PollOnceDetachNetworkEndpointsAsync(String, CallSettings)

public virtual Task<Operation<Operation, Operation>> PollOnceDetachNetworkEndpointsAsync(string operationName, CallSettings callSettings = null)

Asynchronously poll an operation once, using an operationName from a previous invocation of DetachNetworkEndpoints.

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
Task<Operation<Operation, Operation>>

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
Operation<Operation, Operation>

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
Task<Operation<Operation, Operation>>

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.

TestIamPermissions(TestIamPermissionsNetworkEndpointGroupRequest, CallSettings)

public virtual TestPermissionsResponse TestIamPermissions(TestIamPermissionsNetworkEndpointGroupRequest request, CallSettings callSettings = null)

Returns permissions that a caller has on the specified resource.

Parameters
NameDescription
requestTestIamPermissionsNetworkEndpointGroupRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TestPermissionsResponse

The RPC response.

Example
// Create client
NetworkEndpointGroupsClient networkEndpointGroupsClient = NetworkEndpointGroupsClient.Create();
// Initialize request argument(s)
TestIamPermissionsNetworkEndpointGroupRequest request = new TestIamPermissionsNetworkEndpointGroupRequest
{
    Zone = "",
    Resource = "",
    Project = "",
    TestPermissionsRequestResource = new TestPermissionsRequest(),
};
// Make the request
TestPermissionsResponse response = networkEndpointGroupsClient.TestIamPermissions(request);

TestIamPermissions(String, String, String, TestPermissionsRequest, CallSettings)

public virtual TestPermissionsResponse TestIamPermissions(string project, string zone, string resource, TestPermissionsRequest testPermissionsRequestResource, CallSettings callSettings = null)

Returns permissions that a caller has on the specified resource.

Parameters
NameDescription
projectString

Project ID for this request.

zoneString

The name of the zone for this request.

resourceString

Name or id of the resource for this request.

testPermissionsRequestResourceTestPermissionsRequest

The body resource for this request

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TestPermissionsResponse

The RPC response.

Example
// Create client
NetworkEndpointGroupsClient networkEndpointGroupsClient = NetworkEndpointGroupsClient.Create();
// Initialize request argument(s)
string project = "";
string zone = "";
string resource = "";
TestPermissionsRequest testPermissionsRequestResource = new TestPermissionsRequest();
// Make the request
TestPermissionsResponse response = networkEndpointGroupsClient.TestIamPermissions(project, zone, resource, testPermissionsRequestResource);

TestIamPermissionsAsync(TestIamPermissionsNetworkEndpointGroupRequest, CallSettings)

public virtual Task<TestPermissionsResponse> TestIamPermissionsAsync(TestIamPermissionsNetworkEndpointGroupRequest request, CallSettings callSettings = null)

Returns permissions that a caller has on the specified resource.

Parameters
NameDescription
requestTestIamPermissionsNetworkEndpointGroupRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<TestPermissionsResponse>

A Task containing the RPC response.

Example
// Create client
NetworkEndpointGroupsClient networkEndpointGroupsClient = await NetworkEndpointGroupsClient.CreateAsync();
// Initialize request argument(s)
TestIamPermissionsNetworkEndpointGroupRequest request = new TestIamPermissionsNetworkEndpointGroupRequest
{
    Zone = "",
    Resource = "",
    Project = "",
    TestPermissionsRequestResource = new TestPermissionsRequest(),
};
// Make the request
TestPermissionsResponse response = await networkEndpointGroupsClient.TestIamPermissionsAsync(request);

TestIamPermissionsAsync(TestIamPermissionsNetworkEndpointGroupRequest, CancellationToken)

public virtual Task<TestPermissionsResponse> TestIamPermissionsAsync(TestIamPermissionsNetworkEndpointGroupRequest request, CancellationToken cancellationToken)

Returns permissions that a caller has on the specified resource.

Parameters
NameDescription
requestTestIamPermissionsNetworkEndpointGroupRequest

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

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task<TestPermissionsResponse>

A Task containing the RPC response.

Example
// Create client
NetworkEndpointGroupsClient networkEndpointGroupsClient = await NetworkEndpointGroupsClient.CreateAsync();
// Initialize request argument(s)
TestIamPermissionsNetworkEndpointGroupRequest request = new TestIamPermissionsNetworkEndpointGroupRequest
{
    Zone = "",
    Resource = "",
    Project = "",
    TestPermissionsRequestResource = new TestPermissionsRequest(),
};
// Make the request
TestPermissionsResponse response = await networkEndpointGroupsClient.TestIamPermissionsAsync(request);

TestIamPermissionsAsync(String, String, String, TestPermissionsRequest, CallSettings)

public virtual Task<TestPermissionsResponse> TestIamPermissionsAsync(string project, string zone, string resource, TestPermissionsRequest testPermissionsRequestResource, CallSettings callSettings = null)

Returns permissions that a caller has on the specified resource.

Parameters
NameDescription
projectString

Project ID for this request.

zoneString

The name of the zone for this request.

resourceString

Name or id of the resource for this request.

testPermissionsRequestResourceTestPermissionsRequest

The body resource for this request

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<TestPermissionsResponse>

A Task containing the RPC response.

Example
// Create client
NetworkEndpointGroupsClient networkEndpointGroupsClient = await NetworkEndpointGroupsClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string zone = "";
string resource = "";
TestPermissionsRequest testPermissionsRequestResource = new TestPermissionsRequest();
// Make the request
TestPermissionsResponse response = await networkEndpointGroupsClient.TestIamPermissionsAsync(project, zone, resource, testPermissionsRequestResource);

TestIamPermissionsAsync(String, String, String, TestPermissionsRequest, CancellationToken)

public virtual Task<TestPermissionsResponse> TestIamPermissionsAsync(string project, string zone, string resource, TestPermissionsRequest testPermissionsRequestResource, CancellationToken cancellationToken)

Returns permissions that a caller has on the specified resource.

Parameters
NameDescription
projectString

Project ID for this request.

zoneString

The name of the zone for this request.

resourceString

Name or id of the resource for this request.

testPermissionsRequestResourceTestPermissionsRequest

The body resource for this request

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task<TestPermissionsResponse>

A Task containing the RPC response.

Example
// Create client
NetworkEndpointGroupsClient networkEndpointGroupsClient = await NetworkEndpointGroupsClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string zone = "";
string resource = "";
TestPermissionsRequest testPermissionsRequestResource = new TestPermissionsRequest();
// Make the request
TestPermissionsResponse response = await networkEndpointGroupsClient.TestIamPermissionsAsync(project, zone, resource, testPermissionsRequestResource);