Compute Engine v1 API - Class CrossSiteNetworksClient (3.22.0) 

public abstract class CrossSiteNetworksClient

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

CrossSiteNetworks client wrapper, for convenient use.

Inheritance

object > CrossSiteNetworksClient

Namespace

Google.Cloud.Compute.V1

Assembly

Google.Cloud.Compute.V1.dll

Remarks

The CrossSiteNetworks API.

Properties

DefaultEndpoint

public static string DefaultEndpoint { get; }

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

Property Value
Type Description
IReadOnlyListstring
Remarks

The default CrossSiteNetworks scopes are:

DeleteOperationsClient

public virtual OperationsClient DeleteOperationsClient { get; }

The long-running operations client for Delete.

Property Value
Type Description
OperationsClient

GrpcClient

public virtual CrossSiteNetworks.CrossSiteNetworksClient GrpcClient { get; }

The underlying gRPC CrossSiteNetworks client

Property Value
Type Description
CrossSiteNetworksCrossSiteNetworksClient

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 CrossSiteNetworksClient Create()

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

Returns
Type Description
CrossSiteNetworksClient

The created CrossSiteNetworksClient.

CreateAsync(CancellationToken)

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

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

Parameter
Name Description
cancellationToken CancellationToken

The CancellationToken to use while creating the client.
Returns
Type Description
TaskCrossSiteNetworksClient

The task representing the created CrossSiteNetworksClient.

Delete(DeleteCrossSiteNetworkRequest, CallSettings)

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

Deletes the specified cross-site network in the given scope.

Parameters
Name Description
request DeleteCrossSiteNetworkRequest

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
CrossSiteNetworksClient crossSiteNetworksClient = CrossSiteNetworksClient.Create();
// Initialize request argument(s)
DeleteCrossSiteNetworkRequest request = new DeleteCrossSiteNetworkRequest
{
    RequestId = "",
    CrossSiteNetwork = "",
    Project = "",
};
// Make the request
lro::Operation<Operation, Operation> response = crossSiteNetworksClient.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 = crossSiteNetworksClient.PollOnceDelete(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Operation retrievedResult = retrievedResponse.Result;
}

Delete(string, string, CallSettings)

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

Deletes the specified cross-site network in the given scope.

Parameters
Name Description
project string

Project ID for this request.
crossSiteNetwork string

Name of the cross-site network to delete.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationOperationOperation

The RPC response.
Example 
// Create client
CrossSiteNetworksClient crossSiteNetworksClient = CrossSiteNetworksClient.Create();
// Initialize request argument(s)
string project = "";
string crossSiteNetwork = "";
// Make the request
lro::Operation<Operation, Operation> response = crossSiteNetworksClient.Delete(project, crossSiteNetwork);

// 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 = crossSiteNetworksClient.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(DeleteCrossSiteNetworkRequest, CallSettings)

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

Deletes the specified cross-site network in the given scope.

Parameters
Name Description
request DeleteCrossSiteNetworkRequest

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
CrossSiteNetworksClient crossSiteNetworksClient = await CrossSiteNetworksClient.CreateAsync();
// Initialize request argument(s)
DeleteCrossSiteNetworkRequest request = new DeleteCrossSiteNetworkRequest
{
    RequestId = "",
    CrossSiteNetwork = "",
    Project = "",
};
// Make the request
lro::Operation<Operation, Operation> response = await crossSiteNetworksClient.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 crossSiteNetworksClient.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(DeleteCrossSiteNetworkRequest, CancellationToken)

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

Deletes the specified cross-site network in the given scope.

Parameters
Name Description
request DeleteCrossSiteNetworkRequest

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
CrossSiteNetworksClient crossSiteNetworksClient = await CrossSiteNetworksClient.CreateAsync();
// Initialize request argument(s)
DeleteCrossSiteNetworkRequest request = new DeleteCrossSiteNetworkRequest
{
    RequestId = "",
    CrossSiteNetwork = "",
    Project = "",
};
// Make the request
lro::Operation<Operation, Operation> response = await crossSiteNetworksClient.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 crossSiteNetworksClient.PollOnceDeleteAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Operation retrievedResult = retrievedResponse.Result;
}

DeleteAsync(string, string, CallSettings)

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

Deletes the specified cross-site network in the given scope.

Parameters
Name Description
project string

Project ID for this request.
crossSiteNetwork string

Name of the cross-site network 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
CrossSiteNetworksClient crossSiteNetworksClient = await CrossSiteNetworksClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string crossSiteNetwork = "";
// Make the request
lro::Operation<Operation, Operation> response = await crossSiteNetworksClient.DeleteAsync(project, crossSiteNetwork);

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

DeleteAsync(string, string, CancellationToken)

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

Deletes the specified cross-site network in the given scope.

Parameters
Name Description
project string

Project ID for this request.
crossSiteNetwork string

Name of the cross-site network to delete.
cancellationToken CancellationToken

A CancellationToken to use for this RPC.
Returns
Type Description
TaskOperationOperationOperation

A Task containing the RPC response.
Example 
// Create client
CrossSiteNetworksClient crossSiteNetworksClient = await CrossSiteNetworksClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string crossSiteNetwork = "";
// Make the request
lro::Operation<Operation, Operation> response = await crossSiteNetworksClient.DeleteAsync(project, crossSiteNetwork);

// 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 crossSiteNetworksClient.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(GetCrossSiteNetworkRequest, CallSettings)

public virtual CrossSiteNetwork Get(GetCrossSiteNetworkRequest request, CallSettings callSettings = null)

Returns the specified cross-site network in the given scope.

Parameters
Name Description
request GetCrossSiteNetworkRequest

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
CrossSiteNetwork

The RPC response.
Example 
// Create client
CrossSiteNetworksClient crossSiteNetworksClient = CrossSiteNetworksClient.Create();
// Initialize request argument(s)
GetCrossSiteNetworkRequest request = new GetCrossSiteNetworkRequest
{
    CrossSiteNetwork = "",
    Project = "",
};
// Make the request
CrossSiteNetwork response = crossSiteNetworksClient.Get(request);

Get(string, string, CallSettings)

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

Returns the specified cross-site network in the given scope.

Parameters
Name Description
project string

Project ID for this request.
crossSiteNetwork string

Name of the cross-site network to return.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
CrossSiteNetwork

The RPC response.
Example 
// Create client
CrossSiteNetworksClient crossSiteNetworksClient = CrossSiteNetworksClient.Create();
// Initialize request argument(s)
string project = "";
string crossSiteNetwork = "";
// Make the request
CrossSiteNetwork response = crossSiteNetworksClient.Get(project, crossSiteNetwork);

GetAsync(GetCrossSiteNetworkRequest, CallSettings)

public virtual Task<CrossSiteNetwork> GetAsync(GetCrossSiteNetworkRequest request, CallSettings callSettings = null)

Returns the specified cross-site network in the given scope.

Parameters
Name Description
request GetCrossSiteNetworkRequest

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
TaskCrossSiteNetwork

A Task containing the RPC response.
Example 
// Create client
CrossSiteNetworksClient crossSiteNetworksClient = await CrossSiteNetworksClient.CreateAsync();
// Initialize request argument(s)
GetCrossSiteNetworkRequest request = new GetCrossSiteNetworkRequest
{
    CrossSiteNetwork = "",
    Project = "",
};
// Make the request
CrossSiteNetwork response = await crossSiteNetworksClient.GetAsync(request);

GetAsync(GetCrossSiteNetworkRequest, CancellationToken)

public virtual Task<CrossSiteNetwork> GetAsync(GetCrossSiteNetworkRequest request, CancellationToken cancellationToken)

Returns the specified cross-site network in the given scope.

Parameters
Name Description
request GetCrossSiteNetworkRequest

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

A CancellationToken to use for this RPC.
Returns
Type Description
TaskCrossSiteNetwork

A Task containing the RPC response.
Example 
// Create client
CrossSiteNetworksClient crossSiteNetworksClient = await CrossSiteNetworksClient.CreateAsync();
// Initialize request argument(s)
GetCrossSiteNetworkRequest request = new GetCrossSiteNetworkRequest
{
    CrossSiteNetwork = "",
    Project = "",
};
// Make the request
CrossSiteNetwork response = await crossSiteNetworksClient.GetAsync(request);

GetAsync(string, string, CallSettings)

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

Returns the specified cross-site network in the given scope.

Parameters
Name Description
project string

Project ID for this request.
crossSiteNetwork string

Name of the cross-site network to return.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskCrossSiteNetwork

A Task containing the RPC response.
Example 
// Create client
CrossSiteNetworksClient crossSiteNetworksClient = await CrossSiteNetworksClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string crossSiteNetwork = "";
// Make the request
CrossSiteNetwork response = await crossSiteNetworksClient.GetAsync(project, crossSiteNetwork);

GetAsync(string, string, CancellationToken)

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

Returns the specified cross-site network in the given scope.

Parameters
Name Description
project string

Project ID for this request.
crossSiteNetwork string

Name of the cross-site network to return.
cancellationToken CancellationToken

A CancellationToken to use for this RPC.
Returns
Type Description
TaskCrossSiteNetwork

A Task containing the RPC response.
Example 
// Create client
CrossSiteNetworksClient crossSiteNetworksClient = await CrossSiteNetworksClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string crossSiteNetwork = "";
// Make the request
CrossSiteNetwork response = await crossSiteNetworksClient.GetAsync(project, crossSiteNetwork);

Insert(InsertCrossSiteNetworkRequest, CallSettings)

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

Creates a cross-site network in the specified project in the given scope using the parameters that are included in the request.

Parameters
Name Description
request InsertCrossSiteNetworkRequest

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
CrossSiteNetworksClient crossSiteNetworksClient = CrossSiteNetworksClient.Create();
// Initialize request argument(s)
InsertCrossSiteNetworkRequest request = new InsertCrossSiteNetworkRequest
{
    CrossSiteNetworkResource = new CrossSiteNetwork(),
    RequestId = "",
    Project = "",
    ValidateOnly = false,
};
// Make the request
lro::Operation<Operation, Operation> response = crossSiteNetworksClient.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 = crossSiteNetworksClient.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, CrossSiteNetwork, CallSettings)

public virtual Operation<Operation, Operation> Insert(string project, CrossSiteNetwork crossSiteNetworkResource, CallSettings callSettings = null)

Creates a cross-site network 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.
crossSiteNetworkResource CrossSiteNetwork

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
CrossSiteNetworksClient crossSiteNetworksClient = CrossSiteNetworksClient.Create();
// Initialize request argument(s)
string project = "";
CrossSiteNetwork crossSiteNetworkResource = new CrossSiteNetwork();
// Make the request
lro::Operation<Operation, Operation> response = crossSiteNetworksClient.Insert(project, crossSiteNetworkResource);

// 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 = crossSiteNetworksClient.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(InsertCrossSiteNetworkRequest, CallSettings)

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

Creates a cross-site network in the specified project in the given scope using the parameters that are included in the request.

Parameters
Name Description
request InsertCrossSiteNetworkRequest

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
CrossSiteNetworksClient crossSiteNetworksClient = await CrossSiteNetworksClient.CreateAsync();
// Initialize request argument(s)
InsertCrossSiteNetworkRequest request = new InsertCrossSiteNetworkRequest
{
    CrossSiteNetworkResource = new CrossSiteNetwork(),
    RequestId = "",
    Project = "",
    ValidateOnly = false,
};
// Make the request
lro::Operation<Operation, Operation> response = await crossSiteNetworksClient.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 crossSiteNetworksClient.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(InsertCrossSiteNetworkRequest, CancellationToken)

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

Creates a cross-site network in the specified project in the given scope using the parameters that are included in the request.

Parameters
Name Description
request InsertCrossSiteNetworkRequest

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
CrossSiteNetworksClient crossSiteNetworksClient = await CrossSiteNetworksClient.CreateAsync();
// Initialize request argument(s)
InsertCrossSiteNetworkRequest request = new InsertCrossSiteNetworkRequest
{
    CrossSiteNetworkResource = new CrossSiteNetwork(),
    RequestId = "",
    Project = "",
    ValidateOnly = false,
};
// Make the request
lro::Operation<Operation, Operation> response = await crossSiteNetworksClient.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 crossSiteNetworksClient.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, CrossSiteNetwork, CallSettings)

public virtual Task<Operation<Operation, Operation>> InsertAsync(string project, CrossSiteNetwork crossSiteNetworkResource, CallSettings callSettings = null)

Creates a cross-site network 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.
crossSiteNetworkResource CrossSiteNetwork

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
CrossSiteNetworksClient crossSiteNetworksClient = await CrossSiteNetworksClient.CreateAsync();
// Initialize request argument(s)
string project = "";
CrossSiteNetwork crossSiteNetworkResource = new CrossSiteNetwork();
// Make the request
lro::Operation<Operation, Operation> response = await crossSiteNetworksClient.InsertAsync(project, crossSiteNetworkResource);

// 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 crossSiteNetworksClient.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, CrossSiteNetwork, CancellationToken)

public virtual Task<Operation<Operation, Operation>> InsertAsync(string project, CrossSiteNetwork crossSiteNetworkResource, CancellationToken cancellationToken)

Creates a cross-site network 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.
crossSiteNetworkResource CrossSiteNetwork

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
CrossSiteNetworksClient crossSiteNetworksClient = await CrossSiteNetworksClient.CreateAsync();
// Initialize request argument(s)
string project = "";
CrossSiteNetwork crossSiteNetworkResource = new CrossSiteNetwork();
// Make the request
lro::Operation<Operation, Operation> response = await crossSiteNetworksClient.InsertAsync(project, crossSiteNetworkResource);

// 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 crossSiteNetworksClient.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(ListCrossSiteNetworksRequest, CallSettings)

public virtual PagedEnumerable<CrossSiteNetworkList, CrossSiteNetwork> List(ListCrossSiteNetworksRequest request, CallSettings callSettings = null)

Lists the cross-site networks for a project in the given scope.

Parameters
Name Description
request ListCrossSiteNetworksRequest

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
PagedEnumerableCrossSiteNetworkListCrossSiteNetwork

A pageable sequence of CrossSiteNetwork resources.
Example 
// Create client
CrossSiteNetworksClient crossSiteNetworksClient = CrossSiteNetworksClient.Create();
// Initialize request argument(s)
ListCrossSiteNetworksRequest request = new ListCrossSiteNetworksRequest
{
    OrderBy = "",
    Project = "",
    Filter = "",
    ReturnPartialSuccess = false,
};
// Make the request
PagedEnumerable<CrossSiteNetworkList, CrossSiteNetwork> response = crossSiteNetworksClient.List(request);

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

List(string, string, int?, CallSettings)

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

Lists the cross-site networks for a project in the given scope.

Parameters
Name Description
project string

Project ID for this request.
pageToken string

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

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

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableCrossSiteNetworkListCrossSiteNetwork

A pageable sequence of CrossSiteNetwork resources.
Example 
// Create client
CrossSiteNetworksClient crossSiteNetworksClient = CrossSiteNetworksClient.Create();
// Initialize request argument(s)
string project = "";
// Make the request
PagedEnumerable<CrossSiteNetworkList, CrossSiteNetwork> response = crossSiteNetworksClient.List(project);

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

public virtual PagedAsyncEnumerable<CrossSiteNetworkList, CrossSiteNetwork> ListAsync(ListCrossSiteNetworksRequest request, CallSettings callSettings = null)

Lists the cross-site networks for a project in the given scope.

Parameters
Name Description
request ListCrossSiteNetworksRequest

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
PagedAsyncEnumerableCrossSiteNetworkListCrossSiteNetwork

A pageable asynchronous sequence of CrossSiteNetwork resources.
Example 
// Create client
CrossSiteNetworksClient crossSiteNetworksClient = await CrossSiteNetworksClient.CreateAsync();
// Initialize request argument(s)
ListCrossSiteNetworksRequest request = new ListCrossSiteNetworksRequest
{
    OrderBy = "",
    Project = "",
    Filter = "",
    ReturnPartialSuccess = false,
};
// Make the request
PagedAsyncEnumerable<CrossSiteNetworkList, CrossSiteNetwork> response = crossSiteNetworksClient.ListAsync(request);

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

ListAsync(string, string, int?, CallSettings)

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

Lists the cross-site networks for a project in the given scope.

Parameters
Name Description
project string

Project ID for this request.
pageToken string

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

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

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableCrossSiteNetworkListCrossSiteNetwork

A pageable asynchronous sequence of CrossSiteNetwork resources.
Example 
// Create client
CrossSiteNetworksClient crossSiteNetworksClient = await CrossSiteNetworksClient.CreateAsync();
// Initialize request argument(s)
string project = "";
// Make the request
PagedAsyncEnumerable<CrossSiteNetworkList, CrossSiteNetwork> response = crossSiteNetworksClient.ListAsync(project);

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

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

Updates the specified cross-site network with the data included in the request. This method supportsPATCH semantics and uses theJSON merge patch format and processing rules.

Parameters
Name Description
request PatchCrossSiteNetworkRequest

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
CrossSiteNetworksClient crossSiteNetworksClient = CrossSiteNetworksClient.Create();
// Initialize request argument(s)
PatchCrossSiteNetworkRequest request = new PatchCrossSiteNetworkRequest
{
    CrossSiteNetworkResource = new CrossSiteNetwork(),
    RequestId = "",
    CrossSiteNetwork = "",
    Project = "",
    ValidateOnly = false,
    UpdateMask = "",
};
// Make the request
lro::Operation<Operation, Operation> response = crossSiteNetworksClient.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 = crossSiteNetworksClient.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, CrossSiteNetwork, CallSettings)

public virtual Operation<Operation, Operation> Patch(string project, string crossSiteNetwork, CrossSiteNetwork crossSiteNetworkResource, CallSettings callSettings = null)

Updates the specified cross-site network with the data included in the request. This method supportsPATCH semantics and uses theJSON merge patch format and processing rules.

Parameters
Name Description
project string

Project ID for this request.
crossSiteNetwork string

Name of the cross-site network to update.
crossSiteNetworkResource CrossSiteNetwork

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
CrossSiteNetworksClient crossSiteNetworksClient = CrossSiteNetworksClient.Create();
// Initialize request argument(s)
string project = "";
string crossSiteNetwork = "";
CrossSiteNetwork crossSiteNetworkResource = new CrossSiteNetwork();
// Make the request
lro::Operation<Operation, Operation> response = crossSiteNetworksClient.Patch(project, crossSiteNetwork, crossSiteNetworkResource);

// 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 = crossSiteNetworksClient.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(PatchCrossSiteNetworkRequest, CallSettings)

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

Updates the specified cross-site network with the data included in the request. This method supportsPATCH semantics and uses theJSON merge patch format and processing rules.

Parameters
Name Description
request PatchCrossSiteNetworkRequest

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
CrossSiteNetworksClient crossSiteNetworksClient = await CrossSiteNetworksClient.CreateAsync();
// Initialize request argument(s)
PatchCrossSiteNetworkRequest request = new PatchCrossSiteNetworkRequest
{
    CrossSiteNetworkResource = new CrossSiteNetwork(),
    RequestId = "",
    CrossSiteNetwork = "",
    Project = "",
    ValidateOnly = false,
    UpdateMask = "",
};
// Make the request
lro::Operation<Operation, Operation> response = await crossSiteNetworksClient.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 crossSiteNetworksClient.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(PatchCrossSiteNetworkRequest, CancellationToken)

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

Updates the specified cross-site network with the data included in the request. This method supportsPATCH semantics and uses theJSON merge patch format and processing rules.

Parameters
Name Description
request PatchCrossSiteNetworkRequest

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
CrossSiteNetworksClient crossSiteNetworksClient = await CrossSiteNetworksClient.CreateAsync();
// Initialize request argument(s)
PatchCrossSiteNetworkRequest request = new PatchCrossSiteNetworkRequest
{
    CrossSiteNetworkResource = new CrossSiteNetwork(),
    RequestId = "",
    CrossSiteNetwork = "",
    Project = "",
    ValidateOnly = false,
    UpdateMask = "",
};
// Make the request
lro::Operation<Operation, Operation> response = await crossSiteNetworksClient.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 crossSiteNetworksClient.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, CrossSiteNetwork, CallSettings)

public virtual Task<Operation<Operation, Operation>> PatchAsync(string project, string crossSiteNetwork, CrossSiteNetwork crossSiteNetworkResource, CallSettings callSettings = null)

Updates the specified cross-site network with the data included in the request. This method supportsPATCH semantics and uses theJSON merge patch format and processing rules.

Parameters
Name Description
project string

Project ID for this request.
crossSiteNetwork string

Name of the cross-site network to update.
crossSiteNetworkResource CrossSiteNetwork

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
CrossSiteNetworksClient crossSiteNetworksClient = await CrossSiteNetworksClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string crossSiteNetwork = "";
CrossSiteNetwork crossSiteNetworkResource = new CrossSiteNetwork();
// Make the request
lro::Operation<Operation, Operation> response = await crossSiteNetworksClient.PatchAsync(project, crossSiteNetwork, crossSiteNetworkResource);

// 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 crossSiteNetworksClient.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, CrossSiteNetwork, CancellationToken)

public virtual Task<Operation<Operation, Operation>> PatchAsync(string project, string crossSiteNetwork, CrossSiteNetwork crossSiteNetworkResource, CancellationToken cancellationToken)

Updates the specified cross-site network with the data included in the request. This method supportsPATCH semantics and uses theJSON merge patch format and processing rules.

Parameters
Name Description
project string

Project ID for this request.
crossSiteNetwork string

Name of the cross-site network to update.
crossSiteNetworkResource CrossSiteNetwork

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
CrossSiteNetworksClient crossSiteNetworksClient = await CrossSiteNetworksClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string crossSiteNetwork = "";
CrossSiteNetwork crossSiteNetworkResource = new CrossSiteNetwork();
// Make the request
lro::Operation<Operation, Operation> response = await crossSiteNetworksClient.PatchAsync(project, crossSiteNetwork, crossSiteNetworkResource);

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