Compute Engine v1 API - Class InterconnectsClient (2.17.0)

public abstract class InterconnectsClient

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

Interconnects client wrapper, for convenient use.

Inheritance

object > InterconnectsClient

Derived Types

Namespace

Google.Cloud.Compute.V1

Assembly

Google.Cloud.Compute.V1.dll

Remarks

The Interconnects API.

Properties

DefaultEndpoint

public static string DefaultEndpoint { get; }

The default endpoint for the Interconnects 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 Interconnects 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 Interconnects.InterconnectsClient GrpcClient { get; }

The underlying gRPC Interconnects client

Property Value
Type Description
InterconnectsInterconnectsClient

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

SetLabelsOperationsClient

public virtual OperationsClient SetLabelsOperationsClient { get; }

The long-running operations client for SetLabels.

Property Value
Type Description
OperationsClient

Methods

Create()

public static InterconnectsClient Create()

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

Returns
Type Description
InterconnectsClient

The created InterconnectsClient.

CreateAsync(CancellationToken)

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

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

Parameter
Name Description
cancellationToken CancellationToken

The CancellationToken to use while creating the client.

Returns
Type Description
TaskInterconnectsClient

The task representing the created InterconnectsClient.

Delete(DeleteInterconnectRequest, CallSettings)

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

Deletes the specified Interconnect.

Parameters
Name Description
request DeleteInterconnectRequest

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
InterconnectsClient interconnectsClient = InterconnectsClient.Create();
// Initialize request argument(s)
DeleteInterconnectRequest request = new DeleteInterconnectRequest
{
    RequestId = "",
    Interconnect = "",
    Project = "",
};
// Make the request
lro::Operation<Operation, Operation> response = interconnectsClient.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 = interconnectsClient.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 interconnect, CallSettings callSettings = null)

Deletes the specified Interconnect.

Parameters
Name Description
project string

Project ID for this request.

interconnect string

Name of the interconnect to delete.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationOperationOperation

The RPC response.

Example
// Create client
InterconnectsClient interconnectsClient = InterconnectsClient.Create();
// Initialize request argument(s)
string project = "";
string interconnect = "";
// Make the request
lro::Operation<Operation, Operation> response = interconnectsClient.Delete(project, interconnect);

// 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 = interconnectsClient.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(DeleteInterconnectRequest, CallSettings)

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

Deletes the specified Interconnect.

Parameters
Name Description
request DeleteInterconnectRequest

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

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

Deletes the specified Interconnect.

Parameters
Name Description
request DeleteInterconnectRequest

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
InterconnectsClient interconnectsClient = await InterconnectsClient.CreateAsync();
// Initialize request argument(s)
DeleteInterconnectRequest request = new DeleteInterconnectRequest
{
    RequestId = "",
    Interconnect = "",
    Project = "",
};
// Make the request
lro::Operation<Operation, Operation> response = await interconnectsClient.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 interconnectsClient.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 interconnect, CallSettings callSettings = null)

Deletes the specified Interconnect.

Parameters
Name Description
project string

Project ID for this request.

interconnect string

Name of the interconnect 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
InterconnectsClient interconnectsClient = await InterconnectsClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string interconnect = "";
// Make the request
lro::Operation<Operation, Operation> response = await interconnectsClient.DeleteAsync(project, interconnect);

// 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 interconnectsClient.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 interconnect, CancellationToken cancellationToken)

Deletes the specified Interconnect.

Parameters
Name Description
project string

Project ID for this request.

interconnect string

Name of the interconnect to delete.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationOperationOperation

A Task containing the RPC response.

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

// 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 interconnectsClient.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(GetInterconnectRequest, CallSettings)

public virtual Interconnect Get(GetInterconnectRequest request, CallSettings callSettings = null)

Returns the specified Interconnect. Get a list of available Interconnects by making a list() request.

Parameters
Name Description
request GetInterconnectRequest

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
Interconnect

The RPC response.

Example
// Create client
InterconnectsClient interconnectsClient = InterconnectsClient.Create();
// Initialize request argument(s)
GetInterconnectRequest request = new GetInterconnectRequest
{
    Interconnect = "",
    Project = "",
};
// Make the request
Interconnect response = interconnectsClient.Get(request);

Get(string, string, CallSettings)

public virtual Interconnect Get(string project, string interconnect, CallSettings callSettings = null)

Returns the specified Interconnect. Get a list of available Interconnects by making a list() request.

Parameters
Name Description
project string

Project ID for this request.

interconnect string

Name of the interconnect to return.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Interconnect

The RPC response.

Example
// Create client
InterconnectsClient interconnectsClient = InterconnectsClient.Create();
// Initialize request argument(s)
string project = "";
string interconnect = "";
// Make the request
Interconnect response = interconnectsClient.Get(project, interconnect);

GetAsync(GetInterconnectRequest, CallSettings)

public virtual Task<Interconnect> GetAsync(GetInterconnectRequest request, CallSettings callSettings = null)

Returns the specified Interconnect. Get a list of available Interconnects by making a list() request.

Parameters
Name Description
request GetInterconnectRequest

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
TaskInterconnect

A Task containing the RPC response.

Example
// Create client
InterconnectsClient interconnectsClient = await InterconnectsClient.CreateAsync();
// Initialize request argument(s)
GetInterconnectRequest request = new GetInterconnectRequest
{
    Interconnect = "",
    Project = "",
};
// Make the request
Interconnect response = await interconnectsClient.GetAsync(request);

GetAsync(GetInterconnectRequest, CancellationToken)

public virtual Task<Interconnect> GetAsync(GetInterconnectRequest request, CancellationToken cancellationToken)

Returns the specified Interconnect. Get a list of available Interconnects by making a list() request.

Parameters
Name Description
request GetInterconnectRequest

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskInterconnect

A Task containing the RPC response.

Example
// Create client
InterconnectsClient interconnectsClient = await InterconnectsClient.CreateAsync();
// Initialize request argument(s)
GetInterconnectRequest request = new GetInterconnectRequest
{
    Interconnect = "",
    Project = "",
};
// Make the request
Interconnect response = await interconnectsClient.GetAsync(request);

GetAsync(string, string, CallSettings)

public virtual Task<Interconnect> GetAsync(string project, string interconnect, CallSettings callSettings = null)

Returns the specified Interconnect. Get a list of available Interconnects by making a list() request.

Parameters
Name Description
project string

Project ID for this request.

interconnect string

Name of the interconnect to return.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskInterconnect

A Task containing the RPC response.

Example
// Create client
InterconnectsClient interconnectsClient = await InterconnectsClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string interconnect = "";
// Make the request
Interconnect response = await interconnectsClient.GetAsync(project, interconnect);

GetAsync(string, string, CancellationToken)

public virtual Task<Interconnect> GetAsync(string project, string interconnect, CancellationToken cancellationToken)

Returns the specified Interconnect. Get a list of available Interconnects by making a list() request.

Parameters
Name Description
project string

Project ID for this request.

interconnect string

Name of the interconnect to return.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskInterconnect

A Task containing the RPC response.

Example
// Create client
InterconnectsClient interconnectsClient = await InterconnectsClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string interconnect = "";
// Make the request
Interconnect response = await interconnectsClient.GetAsync(project, interconnect);

GetDiagnostics(GetDiagnosticsInterconnectRequest, CallSettings)

public virtual InterconnectsGetDiagnosticsResponse GetDiagnostics(GetDiagnosticsInterconnectRequest request, CallSettings callSettings = null)

Returns the interconnectDiagnostics for the specified Interconnect. In the event of a global outage, do not use this API to make decisions about where to redirect your network traffic. Unlike a VLAN attachment, which is regional, a Cloud Interconnect connection is a global resource. A global outage can prevent this API from functioning properly.

Parameters
Name Description
request GetDiagnosticsInterconnectRequest

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
InterconnectsGetDiagnosticsResponse

The RPC response.

Example
// Create client
InterconnectsClient interconnectsClient = InterconnectsClient.Create();
// Initialize request argument(s)
GetDiagnosticsInterconnectRequest request = new GetDiagnosticsInterconnectRequest
{
    Interconnect = "",
    Project = "",
};
// Make the request
InterconnectsGetDiagnosticsResponse response = interconnectsClient.GetDiagnostics(request);

GetDiagnostics(string, string, CallSettings)

public virtual InterconnectsGetDiagnosticsResponse GetDiagnostics(string project, string interconnect, CallSettings callSettings = null)

Returns the interconnectDiagnostics for the specified Interconnect. In the event of a global outage, do not use this API to make decisions about where to redirect your network traffic. Unlike a VLAN attachment, which is regional, a Cloud Interconnect connection is a global resource. A global outage can prevent this API from functioning properly.

Parameters
Name Description
project string

Project ID for this request.

interconnect string

Name of the interconnect resource to query.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
InterconnectsGetDiagnosticsResponse

The RPC response.

Example
// Create client
InterconnectsClient interconnectsClient = InterconnectsClient.Create();
// Initialize request argument(s)
string project = "";
string interconnect = "";
// Make the request
InterconnectsGetDiagnosticsResponse response = interconnectsClient.GetDiagnostics(project, interconnect);

GetDiagnosticsAsync(GetDiagnosticsInterconnectRequest, CallSettings)

public virtual Task<InterconnectsGetDiagnosticsResponse> GetDiagnosticsAsync(GetDiagnosticsInterconnectRequest request, CallSettings callSettings = null)

Returns the interconnectDiagnostics for the specified Interconnect. In the event of a global outage, do not use this API to make decisions about where to redirect your network traffic. Unlike a VLAN attachment, which is regional, a Cloud Interconnect connection is a global resource. A global outage can prevent this API from functioning properly.

Parameters
Name Description
request GetDiagnosticsInterconnectRequest

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
TaskInterconnectsGetDiagnosticsResponse

A Task containing the RPC response.

Example
// Create client
InterconnectsClient interconnectsClient = await InterconnectsClient.CreateAsync();
// Initialize request argument(s)
GetDiagnosticsInterconnectRequest request = new GetDiagnosticsInterconnectRequest
{
    Interconnect = "",
    Project = "",
};
// Make the request
InterconnectsGetDiagnosticsResponse response = await interconnectsClient.GetDiagnosticsAsync(request);

GetDiagnosticsAsync(GetDiagnosticsInterconnectRequest, CancellationToken)

public virtual Task<InterconnectsGetDiagnosticsResponse> GetDiagnosticsAsync(GetDiagnosticsInterconnectRequest request, CancellationToken cancellationToken)

Returns the interconnectDiagnostics for the specified Interconnect. In the event of a global outage, do not use this API to make decisions about where to redirect your network traffic. Unlike a VLAN attachment, which is regional, a Cloud Interconnect connection is a global resource. A global outage can prevent this API from functioning properly.

Parameters
Name Description
request GetDiagnosticsInterconnectRequest

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskInterconnectsGetDiagnosticsResponse

A Task containing the RPC response.

Example
// Create client
InterconnectsClient interconnectsClient = await InterconnectsClient.CreateAsync();
// Initialize request argument(s)
GetDiagnosticsInterconnectRequest request = new GetDiagnosticsInterconnectRequest
{
    Interconnect = "",
    Project = "",
};
// Make the request
InterconnectsGetDiagnosticsResponse response = await interconnectsClient.GetDiagnosticsAsync(request);

GetDiagnosticsAsync(string, string, CallSettings)

public virtual Task<InterconnectsGetDiagnosticsResponse> GetDiagnosticsAsync(string project, string interconnect, CallSettings callSettings = null)

Returns the interconnectDiagnostics for the specified Interconnect. In the event of a global outage, do not use this API to make decisions about where to redirect your network traffic. Unlike a VLAN attachment, which is regional, a Cloud Interconnect connection is a global resource. A global outage can prevent this API from functioning properly.

Parameters
Name Description
project string

Project ID for this request.

interconnect string

Name of the interconnect resource to query.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskInterconnectsGetDiagnosticsResponse

A Task containing the RPC response.

Example
// Create client
InterconnectsClient interconnectsClient = await InterconnectsClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string interconnect = "";
// Make the request
InterconnectsGetDiagnosticsResponse response = await interconnectsClient.GetDiagnosticsAsync(project, interconnect);

GetDiagnosticsAsync(string, string, CancellationToken)

public virtual Task<InterconnectsGetDiagnosticsResponse> GetDiagnosticsAsync(string project, string interconnect, CancellationToken cancellationToken)

Returns the interconnectDiagnostics for the specified Interconnect. In the event of a global outage, do not use this API to make decisions about where to redirect your network traffic. Unlike a VLAN attachment, which is regional, a Cloud Interconnect connection is a global resource. A global outage can prevent this API from functioning properly.

Parameters
Name Description
project string

Project ID for this request.

interconnect string

Name of the interconnect resource to query.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskInterconnectsGetDiagnosticsResponse

A Task containing the RPC response.

Example
// Create client
InterconnectsClient interconnectsClient = await InterconnectsClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string interconnect = "";
// Make the request
InterconnectsGetDiagnosticsResponse response = await interconnectsClient.GetDiagnosticsAsync(project, interconnect);

GetMacsecConfig(GetMacsecConfigInterconnectRequest, CallSettings)

public virtual InterconnectsGetMacsecConfigResponse GetMacsecConfig(GetMacsecConfigInterconnectRequest request, CallSettings callSettings = null)

Returns the interconnectMacsecConfig for the specified Interconnect.

Parameters
Name Description
request GetMacsecConfigInterconnectRequest

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
InterconnectsGetMacsecConfigResponse

The RPC response.

Example
// Create client
InterconnectsClient interconnectsClient = InterconnectsClient.Create();
// Initialize request argument(s)
GetMacsecConfigInterconnectRequest request = new GetMacsecConfigInterconnectRequest
{
    Interconnect = "",
    Project = "",
};
// Make the request
InterconnectsGetMacsecConfigResponse response = interconnectsClient.GetMacsecConfig(request);

GetMacsecConfig(string, string, CallSettings)

public virtual InterconnectsGetMacsecConfigResponse GetMacsecConfig(string project, string interconnect, CallSettings callSettings = null)

Returns the interconnectMacsecConfig for the specified Interconnect.

Parameters
Name Description
project string

Project ID for this request.

interconnect string

Name of the interconnect resource to query.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
InterconnectsGetMacsecConfigResponse

The RPC response.

Example
// Create client
InterconnectsClient interconnectsClient = InterconnectsClient.Create();
// Initialize request argument(s)
string project = "";
string interconnect = "";
// Make the request
InterconnectsGetMacsecConfigResponse response = interconnectsClient.GetMacsecConfig(project, interconnect);

GetMacsecConfigAsync(GetMacsecConfigInterconnectRequest, CallSettings)

public virtual Task<InterconnectsGetMacsecConfigResponse> GetMacsecConfigAsync(GetMacsecConfigInterconnectRequest request, CallSettings callSettings = null)

Returns the interconnectMacsecConfig for the specified Interconnect.

Parameters
Name Description
request GetMacsecConfigInterconnectRequest

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
TaskInterconnectsGetMacsecConfigResponse

A Task containing the RPC response.

Example
// Create client
InterconnectsClient interconnectsClient = await InterconnectsClient.CreateAsync();
// Initialize request argument(s)
GetMacsecConfigInterconnectRequest request = new GetMacsecConfigInterconnectRequest
{
    Interconnect = "",
    Project = "",
};
// Make the request
InterconnectsGetMacsecConfigResponse response = await interconnectsClient.GetMacsecConfigAsync(request);

GetMacsecConfigAsync(GetMacsecConfigInterconnectRequest, CancellationToken)

public virtual Task<InterconnectsGetMacsecConfigResponse> GetMacsecConfigAsync(GetMacsecConfigInterconnectRequest request, CancellationToken cancellationToken)

Returns the interconnectMacsecConfig for the specified Interconnect.

Parameters
Name Description
request GetMacsecConfigInterconnectRequest

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskInterconnectsGetMacsecConfigResponse

A Task containing the RPC response.

Example
// Create client
InterconnectsClient interconnectsClient = await InterconnectsClient.CreateAsync();
// Initialize request argument(s)
GetMacsecConfigInterconnectRequest request = new GetMacsecConfigInterconnectRequest
{
    Interconnect = "",
    Project = "",
};
// Make the request
InterconnectsGetMacsecConfigResponse response = await interconnectsClient.GetMacsecConfigAsync(request);

GetMacsecConfigAsync(string, string, CallSettings)

public virtual Task<InterconnectsGetMacsecConfigResponse> GetMacsecConfigAsync(string project, string interconnect, CallSettings callSettings = null)

Returns the interconnectMacsecConfig for the specified Interconnect.

Parameters
Name Description
project string

Project ID for this request.

interconnect string

Name of the interconnect resource to query.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskInterconnectsGetMacsecConfigResponse

A Task containing the RPC response.

Example
// Create client
InterconnectsClient interconnectsClient = await InterconnectsClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string interconnect = "";
// Make the request
InterconnectsGetMacsecConfigResponse response = await interconnectsClient.GetMacsecConfigAsync(project, interconnect);

GetMacsecConfigAsync(string, string, CancellationToken)

public virtual Task<InterconnectsGetMacsecConfigResponse> GetMacsecConfigAsync(string project, string interconnect, CancellationToken cancellationToken)

Returns the interconnectMacsecConfig for the specified Interconnect.

Parameters
Name Description
project string

Project ID for this request.

interconnect string

Name of the interconnect resource to query.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskInterconnectsGetMacsecConfigResponse

A Task containing the RPC response.

Example
// Create client
InterconnectsClient interconnectsClient = await InterconnectsClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string interconnect = "";
// Make the request
InterconnectsGetMacsecConfigResponse response = await interconnectsClient.GetMacsecConfigAsync(project, interconnect);

Insert(InsertInterconnectRequest, CallSettings)

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

Creates an Interconnect in the specified project using the data included in the request.

Parameters
Name Description
request InsertInterconnectRequest

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
InterconnectsClient interconnectsClient = InterconnectsClient.Create();
// Initialize request argument(s)
InsertInterconnectRequest request = new InsertInterconnectRequest
{
    RequestId = "",
    Project = "",
    InterconnectResource = new Interconnect(),
};
// Make the request
lro::Operation<Operation, Operation> response = interconnectsClient.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 = interconnectsClient.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, Interconnect, CallSettings)

public virtual Operation<Operation, Operation> Insert(string project, Interconnect interconnectResource, CallSettings callSettings = null)

Creates an Interconnect in the specified project using the data included in the request.

Parameters
Name Description
project string

Project ID for this request.

interconnectResource Interconnect

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
InterconnectsClient interconnectsClient = InterconnectsClient.Create();
// Initialize request argument(s)
string project = "";
Interconnect interconnectResource = new Interconnect();
// Make the request
lro::Operation<Operation, Operation> response = interconnectsClient.Insert(project, interconnectResource);

// 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 = interconnectsClient.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(InsertInterconnectRequest, CallSettings)

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

Creates an Interconnect in the specified project using the data included in the request.

Parameters
Name Description
request InsertInterconnectRequest

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
InterconnectsClient interconnectsClient = await InterconnectsClient.CreateAsync();
// Initialize request argument(s)
InsertInterconnectRequest request = new InsertInterconnectRequest
{
    RequestId = "",
    Project = "",
    InterconnectResource = new Interconnect(),
};
// Make the request
lro::Operation<Operation, Operation> response = await interconnectsClient.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 interconnectsClient.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(InsertInterconnectRequest, CancellationToken)

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

Creates an Interconnect in the specified project using the data included in the request.

Parameters
Name Description
request InsertInterconnectRequest

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
InterconnectsClient interconnectsClient = await InterconnectsClient.CreateAsync();
// Initialize request argument(s)
InsertInterconnectRequest request = new InsertInterconnectRequest
{
    RequestId = "",
    Project = "",
    InterconnectResource = new Interconnect(),
};
// Make the request
lro::Operation<Operation, Operation> response = await interconnectsClient.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 interconnectsClient.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, Interconnect, CallSettings)

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

Creates an Interconnect in the specified project using the data included in the request.

Parameters
Name Description
project string

Project ID for this request.

interconnectResource Interconnect

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

// 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 interconnectsClient.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, Interconnect, CancellationToken)

public virtual Task<Operation<Operation, Operation>> InsertAsync(string project, Interconnect interconnectResource, CancellationToken cancellationToken)

Creates an Interconnect in the specified project using the data included in the request.

Parameters
Name Description
project string

Project ID for this request.

interconnectResource Interconnect

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

// 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 interconnectsClient.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(ListInterconnectsRequest, CallSettings)

public virtual PagedEnumerable<InterconnectList, Interconnect> List(ListInterconnectsRequest request, CallSettings callSettings = null)

Retrieves the list of Interconnects available to the specified project.

Parameters
Name Description
request ListInterconnectsRequest

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
PagedEnumerableInterconnectListInterconnect

A pageable sequence of Interconnect resources.

Example
// Create client
InterconnectsClient interconnectsClient = InterconnectsClient.Create();
// Initialize request argument(s)
ListInterconnectsRequest request = new ListInterconnectsRequest
{
    OrderBy = "",
    Project = "",
    Filter = "",
    ReturnPartialSuccess = false,
};
// Make the request
PagedEnumerable<InterconnectList, Interconnect> response = interconnectsClient.List(request);

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

Retrieves the list of Interconnects available to the specified project.

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
PagedEnumerableInterconnectListInterconnect

A pageable sequence of Interconnect resources.

Example
// Create client
InterconnectsClient interconnectsClient = InterconnectsClient.Create();
// Initialize request argument(s)
string project = "";
// Make the request
PagedEnumerable<InterconnectList, Interconnect> response = interconnectsClient.List(project);

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

public virtual PagedAsyncEnumerable<InterconnectList, Interconnect> ListAsync(ListInterconnectsRequest request, CallSettings callSettings = null)

Retrieves the list of Interconnects available to the specified project.

Parameters
Name Description
request ListInterconnectsRequest

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
PagedAsyncEnumerableInterconnectListInterconnect

A pageable asynchronous sequence of Interconnect resources.

Example
// Create client
InterconnectsClient interconnectsClient = await InterconnectsClient.CreateAsync();
// Initialize request argument(s)
ListInterconnectsRequest request = new ListInterconnectsRequest
{
    OrderBy = "",
    Project = "",
    Filter = "",
    ReturnPartialSuccess = false,
};
// Make the request
PagedAsyncEnumerable<InterconnectList, Interconnect> response = interconnectsClient.ListAsync(request);

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

Retrieves the list of Interconnects available to the specified project.

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
PagedAsyncEnumerableInterconnectListInterconnect

A pageable asynchronous sequence of Interconnect resources.

Example
// Create client
InterconnectsClient interconnectsClient = await InterconnectsClient.CreateAsync();
// Initialize request argument(s)
string project = "";
// Make the request
PagedAsyncEnumerable<InterconnectList, Interconnect> response = interconnectsClient.ListAsync(project);

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

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

Updates the specified Interconnect with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.

Parameters
Name Description
request PatchInterconnectRequest

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
InterconnectsClient interconnectsClient = InterconnectsClient.Create();
// Initialize request argument(s)
PatchInterconnectRequest request = new PatchInterconnectRequest
{
    RequestId = "",
    Interconnect = "",
    Project = "",
    InterconnectResource = new Interconnect(),
};
// Make the request
lro::Operation<Operation, Operation> response = interconnectsClient.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 = interconnectsClient.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, Interconnect, CallSettings)

public virtual Operation<Operation, Operation> Patch(string project, string interconnect, Interconnect interconnectResource, CallSettings callSettings = null)

Updates the specified Interconnect with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.

Parameters
Name Description
project string

Project ID for this request.

interconnect string

Name of the interconnect to update.

interconnectResource Interconnect

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
InterconnectsClient interconnectsClient = InterconnectsClient.Create();
// Initialize request argument(s)
string project = "";
string interconnect = "";
Interconnect interconnectResource = new Interconnect();
// Make the request
lro::Operation<Operation, Operation> response = interconnectsClient.Patch(project, interconnect, interconnectResource);

// 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 = interconnectsClient.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(PatchInterconnectRequest, CallSettings)

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

Updates the specified Interconnect with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.

Parameters
Name Description
request PatchInterconnectRequest

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
InterconnectsClient interconnectsClient = await InterconnectsClient.CreateAsync();
// Initialize request argument(s)
PatchInterconnectRequest request = new PatchInterconnectRequest
{
    RequestId = "",
    Interconnect = "",
    Project = "",
    InterconnectResource = new Interconnect(),
};
// Make the request
lro::Operation<Operation, Operation> response = await interconnectsClient.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 interconnectsClient.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(PatchInterconnectRequest, CancellationToken)

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

Updates the specified Interconnect with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.

Parameters
Name Description
request PatchInterconnectRequest

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
InterconnectsClient interconnectsClient = await InterconnectsClient.CreateAsync();
// Initialize request argument(s)
PatchInterconnectRequest request = new PatchInterconnectRequest
{
    RequestId = "",
    Interconnect = "",
    Project = "",
    InterconnectResource = new Interconnect(),
};
// Make the request
lro::Operation<Operation, Operation> response = await interconnectsClient.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 interconnectsClient.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, Interconnect, CallSettings)

public virtual Task<Operation<Operation, Operation>> PatchAsync(string project, string interconnect, Interconnect interconnectResource, CallSettings callSettings = null)

Updates the specified Interconnect with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.

Parameters
Name Description
project string

Project ID for this request.

interconnect string

Name of the interconnect to update.

interconnectResource Interconnect

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
InterconnectsClient interconnectsClient = await InterconnectsClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string interconnect = "";
Interconnect interconnectResource = new Interconnect();
// Make the request
lro::Operation<Operation, Operation> response = await interconnectsClient.PatchAsync(project, interconnect, interconnectResource);

// 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 interconnectsClient.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, Interconnect, CancellationToken)

public virtual Task<Operation<Operation, Operation>> PatchAsync(string project, string interconnect, Interconnect interconnectResource, CancellationToken cancellationToken)

Updates the specified Interconnect with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.

Parameters
Name Description
project string

Project ID for this request.

interconnect string

Name of the interconnect to update.

interconnectResource Interconnect

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
InterconnectsClient interconnectsClient = await InterconnectsClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string interconnect = "";
Interconnect interconnectResource = new Interconnect();
// Make the request
lro::Operation<Operation, Operation> response = await interconnectsClient.PatchAsync(project, interconnect, interconnectResource);

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

PollOnceSetLabels(string, CallSettings)

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

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

Parameters
Name Description
operationName string

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationOperationOperation

The result of polling the operation.

PollOnceSetLabelsAsync(string, CallSettings)

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

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

Parameters
Name Description
operationName string

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationOperationOperation

A task representing the result of polling the operation.

SetLabels(SetLabelsInterconnectRequest, CallSettings)

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

Sets the labels on an Interconnect. To learn more about labels, read the Labeling Resources documentation.

Parameters
Name Description
request SetLabelsInterconnectRequest

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
InterconnectsClient interconnectsClient = InterconnectsClient.Create();
// Initialize request argument(s)
SetLabelsInterconnectRequest request = new SetLabelsInterconnectRequest
{
    Resource = "",
    Project = "",
    GlobalSetLabelsRequestResource = new GlobalSetLabelsRequest(),
};
// Make the request
lro::Operation<Operation, Operation> response = interconnectsClient.SetLabels(request);

// Poll until the returned long-running operation is complete
lro::Operation<Operation, Operation> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Operation result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
lro::Operation<Operation, Operation> retrievedResponse = interconnectsClient.PollOnceSetLabels(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Operation retrievedResult = retrievedResponse.Result;
}

SetLabels(string, string, GlobalSetLabelsRequest, CallSettings)

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

Sets the labels on an Interconnect. To learn more about labels, read the Labeling Resources documentation.

Parameters
Name Description
project string

Project ID for this request.

resource string

Name or id of the resource for this request.

globalSetLabelsRequestResource GlobalSetLabelsRequest

The body resource for this request

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationOperationOperation

The RPC response.

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

// Poll until the returned long-running operation is complete
lro::Operation<Operation, Operation> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Operation result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
lro::Operation<Operation, Operation> retrievedResponse = interconnectsClient.PollOnceSetLabels(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Operation retrievedResult = retrievedResponse.Result;
}

SetLabelsAsync(SetLabelsInterconnectRequest, CallSettings)

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

Sets the labels on an Interconnect. To learn more about labels, read the Labeling Resources documentation.

Parameters
Name Description
request SetLabelsInterconnectRequest

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
InterconnectsClient interconnectsClient = await InterconnectsClient.CreateAsync();
// Initialize request argument(s)
SetLabelsInterconnectRequest request = new SetLabelsInterconnectRequest
{
    Resource = "",
    Project = "",
    GlobalSetLabelsRequestResource = new GlobalSetLabelsRequest(),
};
// Make the request
lro::Operation<Operation, Operation> response = await interconnectsClient.SetLabelsAsync(request);

// Poll until the returned long-running operation is complete
lro::Operation<Operation, Operation> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Operation result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
lro::Operation<Operation, Operation> retrievedResponse = await interconnectsClient.PollOnceSetLabelsAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Operation retrievedResult = retrievedResponse.Result;
}

SetLabelsAsync(SetLabelsInterconnectRequest, CancellationToken)

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

Sets the labels on an Interconnect. To learn more about labels, read the Labeling Resources documentation.

Parameters
Name Description
request SetLabelsInterconnectRequest

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
InterconnectsClient interconnectsClient = await InterconnectsClient.CreateAsync();
// Initialize request argument(s)
SetLabelsInterconnectRequest request = new SetLabelsInterconnectRequest
{
    Resource = "",
    Project = "",
    GlobalSetLabelsRequestResource = new GlobalSetLabelsRequest(),
};
// Make the request
lro::Operation<Operation, Operation> response = await interconnectsClient.SetLabelsAsync(request);

// Poll until the returned long-running operation is complete
lro::Operation<Operation, Operation> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Operation result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
lro::Operation<Operation, Operation> retrievedResponse = await interconnectsClient.PollOnceSetLabelsAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Operation retrievedResult = retrievedResponse.Result;
}

SetLabelsAsync(string, string, GlobalSetLabelsRequest, CallSettings)

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

Sets the labels on an Interconnect. To learn more about labels, read the Labeling Resources documentation.

Parameters
Name Description
project string

Project ID for this request.

resource string

Name or id of the resource for this request.

globalSetLabelsRequestResource GlobalSetLabelsRequest

The body resource for this request

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationOperationOperation

A Task containing the RPC response.

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

// Poll until the returned long-running operation is complete
lro::Operation<Operation, Operation> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Operation result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
lro::Operation<Operation, Operation> retrievedResponse = await interconnectsClient.PollOnceSetLabelsAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Operation retrievedResult = retrievedResponse.Result;
}

SetLabelsAsync(string, string, GlobalSetLabelsRequest, CancellationToken)

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

Sets the labels on an Interconnect. To learn more about labels, read the Labeling Resources documentation.

Parameters
Name Description
project string

Project ID for this request.

resource string

Name or id of the resource for this request.

globalSetLabelsRequestResource GlobalSetLabelsRequest

The body resource for this request

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationOperationOperation

A Task containing the RPC response.

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

// Poll until the returned long-running operation is complete
lro::Operation<Operation, Operation> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Operation result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
lro::Operation<Operation, Operation> retrievedResponse = await interconnectsClient.PollOnceSetLabelsAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Operation retrievedResult = retrievedResponse.Result;
}

ShutdownDefaultChannelsAsync()

public static Task ShutdownDefaultChannelsAsync()

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

Returns
Type Description
Task

A task representing the asynchronous shutdown operation.

Remarks

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