Compute Engine v1 API - Class WireGroupsClient (3.22.0)

public abstract class WireGroupsClient

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

WireGroups client wrapper, for convenient use.

Inheritance

object > WireGroupsClient

Derived Types

Namespace

Google.Cloud.Compute.V1

Assembly

Google.Cloud.Compute.V1.dll

Remarks

The WireGroups API.

Properties

DefaultEndpoint

public static string DefaultEndpoint { get; }

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

Property Value
Type Description
string

DefaultScopes

public static IReadOnlyList<string> DefaultScopes { get; }

The default WireGroups scopes.

Property Value
Type Description
IReadOnlyListstring
Remarks

DeleteOperationsClient

public virtual OperationsClient DeleteOperationsClient { get; }

The long-running operations client for Delete.

Property Value
Type Description
OperationsClient

GrpcClient

public virtual WireGroups.WireGroupsClient GrpcClient { get; }

The underlying gRPC WireGroups client

Property Value
Type Description
WireGroupsWireGroupsClient

InsertOperationsClient

public virtual OperationsClient InsertOperationsClient { get; }

The long-running operations client for Insert.

Property Value
Type Description
OperationsClient

PatchOperationsClient

public virtual OperationsClient PatchOperationsClient { get; }

The long-running operations client for Patch.

Property Value
Type Description
OperationsClient

ServiceMetadata

public static ServiceMetadata ServiceMetadata { get; }

The service metadata associated with this client type.

Property Value
Type Description
ServiceMetadata

Methods

Create()

public static WireGroupsClient Create()

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

Returns
Type Description
WireGroupsClient

The created WireGroupsClient.

CreateAsync(CancellationToken)

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

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

Parameter
Name Description
cancellationToken CancellationToken

The CancellationToken to use while creating the client.

Returns
Type Description
TaskWireGroupsClient

The task representing the created WireGroupsClient.

Delete(DeleteWireGroupRequest, CallSettings)

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

Deletes the specified wire group in the given scope.

Parameters
Name Description
request DeleteWireGroupRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationOperationOperation

The RPC response.

Example
// Create client
WireGroupsClient wireGroupsClient = WireGroupsClient.Create();
// Initialize request argument(s)
DeleteWireGroupRequest request = new DeleteWireGroupRequest
{
    RequestId = "",
    CrossSiteNetwork = "",
    WireGroup = "",
    Project = "",
};
// Make the request
lro::Operation<Operation, Operation> response = wireGroupsClient.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 = wireGroupsClient.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 crossSiteNetwork, string wireGroup, CallSettings callSettings = null)

Deletes the specified wire group in the given scope.

Parameters
Name Description
project string

Project ID for this request.

crossSiteNetwork string
wireGroup string

Name of the wire group resource to delete.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationOperationOperation

The RPC response.

Example
// Create client
WireGroupsClient wireGroupsClient = WireGroupsClient.Create();
// Initialize request argument(s)
string project = "";
string crossSiteNetwork = "";
string wireGroup = "";
// Make the request
lro::Operation<Operation, Operation> response = wireGroupsClient.Delete(project, crossSiteNetwork, wireGroup);

// 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 = wireGroupsClient.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(DeleteWireGroupRequest, CallSettings)

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

Deletes the specified wire group in the given scope.

Parameters
Name Description
request DeleteWireGroupRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationOperationOperation

A Task containing the RPC response.

Example
// Create client
WireGroupsClient wireGroupsClient = await WireGroupsClient.CreateAsync();
// Initialize request argument(s)
DeleteWireGroupRequest request = new DeleteWireGroupRequest
{
    RequestId = "",
    CrossSiteNetwork = "",
    WireGroup = "",
    Project = "",
};
// Make the request
lro::Operation<Operation, Operation> response = await wireGroupsClient.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 wireGroupsClient.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(DeleteWireGroupRequest, CancellationToken)

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

Deletes the specified wire group in the given scope.

Parameters
Name Description
request DeleteWireGroupRequest

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationOperationOperation

A Task containing the RPC response.

Example
// Create client
WireGroupsClient wireGroupsClient = await WireGroupsClient.CreateAsync();
// Initialize request argument(s)
DeleteWireGroupRequest request = new DeleteWireGroupRequest
{
    RequestId = "",
    CrossSiteNetwork = "",
    WireGroup = "",
    Project = "",
};
// Make the request
lro::Operation<Operation, Operation> response = await wireGroupsClient.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 wireGroupsClient.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 crossSiteNetwork, string wireGroup, CallSettings callSettings = null)

Deletes the specified wire group in the given scope.

Parameters
Name Description
project string

Project ID for this request.

crossSiteNetwork string
wireGroup string

Name of the wire group resource to delete.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationOperationOperation

A Task containing the RPC response.

Example
// Create client
WireGroupsClient wireGroupsClient = await WireGroupsClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string crossSiteNetwork = "";
string wireGroup = "";
// Make the request
lro::Operation<Operation, Operation> response = await wireGroupsClient.DeleteAsync(project, crossSiteNetwork, wireGroup);

// 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 wireGroupsClient.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 crossSiteNetwork, string wireGroup, CancellationToken cancellationToken)

Deletes the specified wire group in the given scope.

Parameters
Name Description
project string

Project ID for this request.

crossSiteNetwork string
wireGroup string

Name of the wire group resource to delete.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationOperationOperation

A Task containing the RPC response.

Example
// Create client
WireGroupsClient wireGroupsClient = await WireGroupsClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string crossSiteNetwork = "";
string wireGroup = "";
// Make the request
lro::Operation<Operation, Operation> response = await wireGroupsClient.DeleteAsync(project, crossSiteNetwork, wireGroup);

// 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 wireGroupsClient.PollOnceDeleteAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Operation retrievedResult = retrievedResponse.Result;
}

Get(GetWireGroupRequest, CallSettings)

public virtual WireGroup Get(GetWireGroupRequest request, CallSettings callSettings = null)

Gets the specified wire group resource in the given scope.

Parameters
Name Description
request GetWireGroupRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
WireGroup

The RPC response.

Example
// Create client
WireGroupsClient wireGroupsClient = WireGroupsClient.Create();
// Initialize request argument(s)
GetWireGroupRequest request = new GetWireGroupRequest
{
    CrossSiteNetwork = "",
    WireGroup = "",
    Project = "",
};
// Make the request
WireGroup response = wireGroupsClient.Get(request);

Get(string, string, string, CallSettings)

public virtual WireGroup Get(string project, string crossSiteNetwork, string wireGroup, CallSettings callSettings = null)

Gets the specified wire group resource in the given scope.

Parameters
Name Description
project string

Project ID for this request.

crossSiteNetwork string
wireGroup string

Name of the wire group resource to return.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
WireGroup

The RPC response.

Example
// Create client
WireGroupsClient wireGroupsClient = WireGroupsClient.Create();
// Initialize request argument(s)
string project = "";
string crossSiteNetwork = "";
string wireGroup = "";
// Make the request
WireGroup response = wireGroupsClient.Get(project, crossSiteNetwork, wireGroup);

GetAsync(GetWireGroupRequest, CallSettings)

public virtual Task<WireGroup> GetAsync(GetWireGroupRequest request, CallSettings callSettings = null)

Gets the specified wire group resource in the given scope.

Parameters
Name Description
request GetWireGroupRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskWireGroup

A Task containing the RPC response.

Example
// Create client
WireGroupsClient wireGroupsClient = await WireGroupsClient.CreateAsync();
// Initialize request argument(s)
GetWireGroupRequest request = new GetWireGroupRequest
{
    CrossSiteNetwork = "",
    WireGroup = "",
    Project = "",
};
// Make the request
WireGroup response = await wireGroupsClient.GetAsync(request);

GetAsync(GetWireGroupRequest, CancellationToken)

public virtual Task<WireGroup> GetAsync(GetWireGroupRequest request, CancellationToken cancellationToken)

Gets the specified wire group resource in the given scope.

Parameters
Name Description
request GetWireGroupRequest

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskWireGroup

A Task containing the RPC response.

Example
// Create client
WireGroupsClient wireGroupsClient = await WireGroupsClient.CreateAsync();
// Initialize request argument(s)
GetWireGroupRequest request = new GetWireGroupRequest
{
    CrossSiteNetwork = "",
    WireGroup = "",
    Project = "",
};
// Make the request
WireGroup response = await wireGroupsClient.GetAsync(request);

GetAsync(string, string, string, CallSettings)

public virtual Task<WireGroup> GetAsync(string project, string crossSiteNetwork, string wireGroup, CallSettings callSettings = null)

Gets the specified wire group resource in the given scope.

Parameters
Name Description
project string

Project ID for this request.

crossSiteNetwork string
wireGroup string

Name of the wire group resource to return.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskWireGroup

A Task containing the RPC response.

Example
// Create client
WireGroupsClient wireGroupsClient = await WireGroupsClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string crossSiteNetwork = "";
string wireGroup = "";
// Make the request
WireGroup response = await wireGroupsClient.GetAsync(project, crossSiteNetwork, wireGroup);

GetAsync(string, string, string, CancellationToken)

public virtual Task<WireGroup> GetAsync(string project, string crossSiteNetwork, string wireGroup, CancellationToken cancellationToken)

Gets the specified wire group resource in the given scope.

Parameters
Name Description
project string

Project ID for this request.

crossSiteNetwork string
wireGroup string

Name of the wire group resource to return.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskWireGroup

A Task containing the RPC response.

Example
// Create client
WireGroupsClient wireGroupsClient = await WireGroupsClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string crossSiteNetwork = "";
string wireGroup = "";
// Make the request
WireGroup response = await wireGroupsClient.GetAsync(project, crossSiteNetwork, wireGroup);

Insert(InsertWireGroupRequest, CallSettings)

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

Creates a wire group in the specified project in the given scope using the parameters that are included in the request.

Parameters
Name Description
request InsertWireGroupRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationOperationOperation

The RPC response.

Example
// Create client
WireGroupsClient wireGroupsClient = WireGroupsClient.Create();
// Initialize request argument(s)
InsertWireGroupRequest request = new InsertWireGroupRequest
{
    RequestId = "",
    CrossSiteNetwork = "",
    WireGroupResource = new WireGroup(),
    Project = "",
    ValidateOnly = false,
};
// Make the request
lro::Operation<Operation, Operation> response = wireGroupsClient.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 = wireGroupsClient.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, WireGroup, CallSettings)

public virtual Operation<Operation, Operation> Insert(string project, string crossSiteNetwork, WireGroup wireGroupResource, CallSettings callSettings = null)

Creates a wire group in the specified project in the given scope using the parameters that are included in the request.

Parameters
Name Description
project string

Project ID for this request.

crossSiteNetwork string
wireGroupResource WireGroup

The body resource for this request

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationOperationOperation

The RPC response.

Example
// Create client
WireGroupsClient wireGroupsClient = WireGroupsClient.Create();
// Initialize request argument(s)
string project = "";
string crossSiteNetwork = "";
WireGroup wireGroupResource = new WireGroup();
// Make the request
lro::Operation<Operation, Operation> response = wireGroupsClient.Insert(project, crossSiteNetwork, wireGroupResource);

// 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 = wireGroupsClient.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(InsertWireGroupRequest, CallSettings)

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

Creates a wire group in the specified project in the given scope using the parameters that are included in the request.

Parameters
Name Description
request InsertWireGroupRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationOperationOperation

A Task containing the RPC response.

Example
// Create client
WireGroupsClient wireGroupsClient = await WireGroupsClient.CreateAsync();
// Initialize request argument(s)
InsertWireGroupRequest request = new InsertWireGroupRequest
{
    RequestId = "",
    CrossSiteNetwork = "",
    WireGroupResource = new WireGroup(),
    Project = "",
    ValidateOnly = false,
};
// Make the request
lro::Operation<Operation, Operation> response = await wireGroupsClient.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 wireGroupsClient.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(InsertWireGroupRequest, CancellationToken)

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

Creates a wire group in the specified project in the given scope using the parameters that are included in the request.

Parameters
Name Description
request InsertWireGroupRequest

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationOperationOperation

A Task containing the RPC response.

Example
// Create client
WireGroupsClient wireGroupsClient = await WireGroupsClient.CreateAsync();
// Initialize request argument(s)
InsertWireGroupRequest request = new InsertWireGroupRequest
{
    RequestId = "",
    CrossSiteNetwork = "",
    WireGroupResource = new WireGroup(),
    Project = "",
    ValidateOnly = false,
};
// Make the request
lro::Operation<Operation, Operation> response = await wireGroupsClient.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 wireGroupsClient.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, WireGroup, CallSettings)

public virtual Task<Operation<Operation, Operation>> InsertAsync(string project, string crossSiteNetwork, WireGroup wireGroupResource, CallSettings callSettings = null)

Creates a wire group in the specified project in the given scope using the parameters that are included in the request.

Parameters
Name Description
project string

Project ID for this request.

crossSiteNetwork string
wireGroupResource WireGroup

The body resource for this request

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationOperationOperation

A Task containing the RPC response.

Example
// Create client
WireGroupsClient wireGroupsClient = await WireGroupsClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string crossSiteNetwork = "";
WireGroup wireGroupResource = new WireGroup();
// Make the request
lro::Operation<Operation, Operation> response = await wireGroupsClient.InsertAsync(project, crossSiteNetwork, wireGroupResource);

// 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 wireGroupsClient.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, WireGroup, CancellationToken)

public virtual Task<Operation<Operation, Operation>> InsertAsync(string project, string crossSiteNetwork, WireGroup wireGroupResource, CancellationToken cancellationToken)

Creates a wire group in the specified project in the given scope using the parameters that are included in the request.

Parameters
Name Description
project string

Project ID for this request.

crossSiteNetwork string
wireGroupResource WireGroup

The body resource for this request

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationOperationOperation

A Task containing the RPC response.

Example
// Create client
WireGroupsClient wireGroupsClient = await WireGroupsClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string crossSiteNetwork = "";
WireGroup wireGroupResource = new WireGroup();
// Make the request
lro::Operation<Operation, Operation> response = await wireGroupsClient.InsertAsync(project, crossSiteNetwork, wireGroupResource);

// 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 wireGroupsClient.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(ListWireGroupsRequest, CallSettings)

public virtual PagedEnumerable<WireGroupList, WireGroup> List(ListWireGroupsRequest request, CallSettings callSettings = null)

Lists the wire groups for a project in the given scope.

Parameters
Name Description
request ListWireGroupsRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerableWireGroupListWireGroup

A pageable sequence of WireGroup resources.

Example
// Create client
WireGroupsClient wireGroupsClient = WireGroupsClient.Create();
// Initialize request argument(s)
ListWireGroupsRequest request = new ListWireGroupsRequest
{
    CrossSiteNetwork = "",
    OrderBy = "",
    Project = "",
    Filter = "",
    ReturnPartialSuccess = false,
};
// Make the request
PagedEnumerable<WireGroupList, WireGroup> response = wireGroupsClient.List(request);

// Iterate over all response items, lazily performing RPCs as required
foreach (WireGroup 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 (WireGroupList page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (WireGroup 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<WireGroup> 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 (WireGroup item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

List(string, string, string, int?, CallSettings)

public virtual PagedEnumerable<WireGroupList, WireGroup> List(string project, string crossSiteNetwork, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists the wire groups for a project in the given scope.

Parameters
Name Description
project string

Project ID for this request.

crossSiteNetwork string
pageToken string

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

pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerableWireGroupListWireGroup

A pageable sequence of WireGroup resources.

Example
// Create client
WireGroupsClient wireGroupsClient = WireGroupsClient.Create();
// Initialize request argument(s)
string project = "";
string crossSiteNetwork = "";
// Make the request
PagedEnumerable<WireGroupList, WireGroup> response = wireGroupsClient.List(project, crossSiteNetwork);

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

public virtual PagedAsyncEnumerable<WireGroupList, WireGroup> ListAsync(ListWireGroupsRequest request, CallSettings callSettings = null)

Lists the wire groups for a project in the given scope.

Parameters
Name Description
request ListWireGroupsRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerableWireGroupListWireGroup

A pageable asynchronous sequence of WireGroup resources.

Example
// Create client
WireGroupsClient wireGroupsClient = await WireGroupsClient.CreateAsync();
// Initialize request argument(s)
ListWireGroupsRequest request = new ListWireGroupsRequest
{
    CrossSiteNetwork = "",
    OrderBy = "",
    Project = "",
    Filter = "",
    ReturnPartialSuccess = false,
};
// Make the request
PagedAsyncEnumerable<WireGroupList, WireGroup> response = wireGroupsClient.ListAsync(request);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((WireGroup 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((WireGroupList page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (WireGroup 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<WireGroup> 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 (WireGroup item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListAsync(string, string, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<WireGroupList, WireGroup> ListAsync(string project, string crossSiteNetwork, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists the wire groups for a project in the given scope.

Parameters
Name Description
project string

Project ID for this request.

crossSiteNetwork string
pageToken string

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

pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerableWireGroupListWireGroup

A pageable asynchronous sequence of WireGroup resources.

Example
// Create client
WireGroupsClient wireGroupsClient = await WireGroupsClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string crossSiteNetwork = "";
// Make the request
PagedAsyncEnumerable<WireGroupList, WireGroup> response = wireGroupsClient.ListAsync(project, crossSiteNetwork);

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

Patch(PatchWireGroupRequest, CallSettings)

public virtual Operation<Operation, Operation> Patch(PatchWireGroupRequest request, CallSettings callSettings = null)

Updates the specified wire group resource with the data included in the request. This method supportsPATCH semantics and usesJSON merge patch format and processing rules.

Parameters
Name Description
request PatchWireGroupRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationOperationOperation

The RPC response.

Example
// Create client
WireGroupsClient wireGroupsClient = WireGroupsClient.Create();
// Initialize request argument(s)
PatchWireGroupRequest request = new PatchWireGroupRequest
{
    RequestId = "",
    CrossSiteNetwork = "",
    WireGroupResource = new WireGroup(),
    WireGroup = "",
    Project = "",
    ValidateOnly = false,
    UpdateMask = "",
};
// Make the request
lro::Operation<Operation, Operation> response = wireGroupsClient.Patch(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 = wireGroupsClient.PollOncePatch(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;
}

Patch(string, string, string, WireGroup, CallSettings)

public virtual Operation<Operation, Operation> Patch(string project, string crossSiteNetwork, string wireGroup, WireGroup wireGroupResource, CallSettings callSettings = null)

Updates the specified wire group resource with the data included in the request. This method supportsPATCH semantics and usesJSON merge patch format and processing rules.

Parameters
Name Description
project string

Project ID for this request.

crossSiteNetwork string
wireGroup string

Name of the WireGroups resource to patch.

wireGroupResource WireGroup

The body resource for this request

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationOperationOperation

The RPC response.

Example
// Create client
WireGroupsClient wireGroupsClient = WireGroupsClient.Create();
// Initialize request argument(s)
string project = "";
string crossSiteNetwork = "";
string wireGroup = "";
WireGroup wireGroupResource = new WireGroup();
// Make the request
lro::Operation<Operation, Operation> response = wireGroupsClient.Patch(project, crossSiteNetwork, wireGroup, wireGroupResource);

// 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 = wireGroupsClient.PollOncePatch(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;
}

PatchAsync(PatchWireGroupRequest, CallSettings)

public virtual Task<Operation<Operation, Operation>> PatchAsync(PatchWireGroupRequest request, CallSettings callSettings = null)

Updates the specified wire group resource with the data included in the request. This method supportsPATCH semantics and usesJSON merge patch format and processing rules.

Parameters
Name Description
request PatchWireGroupRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationOperationOperation

A Task containing the RPC response.

Example
// Create client
WireGroupsClient wireGroupsClient = await WireGroupsClient.CreateAsync();
// Initialize request argument(s)
PatchWireGroupRequest request = new PatchWireGroupRequest
{
    RequestId = "",
    CrossSiteNetwork = "",
    WireGroupResource = new WireGroup(),
    WireGroup = "",
    Project = "",
    ValidateOnly = false,
    UpdateMask = "",
};
// Make the request
lro::Operation<Operation, Operation> response = await wireGroupsClient.PatchAsync(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 wireGroupsClient.PollOncePatchAsync(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;
}

PatchAsync(PatchWireGroupRequest, CancellationToken)

public virtual Task<Operation<Operation, Operation>> PatchAsync(PatchWireGroupRequest request, CancellationToken cancellationToken)

Updates the specified wire group resource with the data included in the request. This method supportsPATCH semantics and usesJSON merge patch format and processing rules.

Parameters
Name Description
request PatchWireGroupRequest

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationOperationOperation

A Task containing the RPC response.

Example
// Create client
WireGroupsClient wireGroupsClient = await WireGroupsClient.CreateAsync();
// Initialize request argument(s)
PatchWireGroupRequest request = new PatchWireGroupRequest
{
    RequestId = "",
    CrossSiteNetwork = "",
    WireGroupResource = new WireGroup(),
    WireGroup = "",
    Project = "",
    ValidateOnly = false,
    UpdateMask = "",
};
// Make the request
lro::Operation<Operation, Operation> response = await wireGroupsClient.PatchAsync(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 wireGroupsClient.PollOncePatchAsync(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;
}

PatchAsync(string, string, string, WireGroup, CallSettings)

public virtual Task<Operation<Operation, Operation>> PatchAsync(string project, string crossSiteNetwork, string wireGroup, WireGroup wireGroupResource, CallSettings callSettings = null)

Updates the specified wire group resource with the data included in the request. This method supportsPATCH semantics and usesJSON merge patch format and processing rules.

Parameters
Name Description
project string

Project ID for this request.

crossSiteNetwork string
wireGroup string

Name of the WireGroups resource to patch.

wireGroupResource WireGroup

The body resource for this request

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationOperationOperation

A Task containing the RPC response.

Example
// Create client
WireGroupsClient wireGroupsClient = await WireGroupsClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string crossSiteNetwork = "";
string wireGroup = "";
WireGroup wireGroupResource = new WireGroup();
// Make the request
lro::Operation<Operation, Operation> response = await wireGroupsClient.PatchAsync(project, crossSiteNetwork, wireGroup, wireGroupResource);

// 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 wireGroupsClient.PollOncePatchAsync(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;
}

PatchAsync(string, string, string, WireGroup, CancellationToken)

public virtual Task<Operation<Operation, Operation>> PatchAsync(string project, string crossSiteNetwork, string wireGroup, WireGroup wireGroupResource, CancellationToken cancellationToken)

Updates the specified wire group resource with the data included in the request. This method supportsPATCH semantics and usesJSON merge patch format and processing rules.

Parameters
Name Description
project string

Project ID for this request.

crossSiteNetwork string
wireGroup string

Name of the WireGroups resource to patch.

wireGroupResource WireGroup

The body resource for this request

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationOperationOperation

A Task containing the RPC response.

Example
// Create client
WireGroupsClient wireGroupsClient = await WireGroupsClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string crossSiteNetwork = "";
string wireGroup = "";
WireGroup wireGroupResource = new WireGroup();
// Make the request
lro::Operation<Operation, Operation> response = await wireGroupsClient.PatchAsync(project, crossSiteNetwork, wireGroup, wireGroupResource);

// 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 wireGroupsClient.PollOncePatchAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Operation retrievedResult = retrievedResponse.Result;
}

PollOnceDelete(string, CallSettings)

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

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

Parameters
Name Description
operationName string

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationOperationOperation

The result of polling the operation.

PollOnceDeleteAsync(string, CallSettings)

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

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

Parameters
Name Description
operationName string

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationOperationOperation

A task representing the result of polling the operation.

PollOnceInsert(string, CallSettings)

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

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

Parameters
Name Description
operationName string

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationOperationOperation

The result of polling the operation.

PollOnceInsertAsync(string, CallSettings)

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

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

Parameters
Name Description
operationName string

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationOperationOperation

A task representing the result of polling the operation.

PollOncePatch(string, CallSettings)

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

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

Parameters
Name Description
operationName string

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationOperationOperation

The result of polling the operation.

PollOncePatchAsync(string, CallSettings)

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

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

Parameters
Name Description
operationName string

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationOperationOperation

A task representing the result of polling the operation.

ShutdownDefaultChannelsAsync()

public static Task ShutdownDefaultChannelsAsync()

Shuts down any channels automatically created by Create() and CreateAsync(CancellationToken). Channels which weren't automatically created are not affected.

Returns
Type Description
Task

A task representing the asynchronous shutdown operation.

Remarks

After calling this method, further calls to Create() and CreateAsync(CancellationToken) will create new channels, which could in turn be shut down by another call to this method.