Compute Engine v1 API - Class Interconnects.InterconnectsClient (2.17.0)

public class Interconnects.InterconnectsClient : ClientBase<Interconnects.InterconnectsClient>

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

Client for Interconnects

Inheritance

object > ClientBase > ClientBaseInterconnectsInterconnectsClient > Interconnects.InterconnectsClient

Namespace

Google.Cloud.Compute.V1

Assembly

Google.Cloud.Compute.V1.dll

Constructors

InterconnectsClient()

protected InterconnectsClient()

Protected parameterless constructor to allow creation of test doubles.

InterconnectsClient(CallInvoker)

public InterconnectsClient(CallInvoker callInvoker)

Creates a new client for Interconnects that uses a custom CallInvoker.

Parameter
Name Description
callInvoker CallInvoker

The callInvoker to use to make remote calls.

InterconnectsClient(ChannelBase)

public InterconnectsClient(ChannelBase channel)

Creates a new client for Interconnects

Parameter
Name Description
channel ChannelBase

The channel to use to make remote calls.

InterconnectsClient(ClientBaseConfiguration)

protected InterconnectsClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name Description
configuration ClientBaseClientBaseConfiguration

The client configuration.

Methods

CreateOperationsClientForGlobalOperations()

public virtual Operations.OperationsClient CreateOperationsClientForGlobalOperations()

Creates a new instance of Operations.OperationsClient using the same call invoker as this client, delegating to GlobalOperations.

Returns
Type Description
OperationsOperationsClient

A new Operations client for the same target as this client.

Delete(DeleteInterconnectRequest, CallOptions)

public virtual Operation Delete(DeleteInterconnectRequest request, CallOptions options)

Deletes the specified Interconnect.

Parameters
Name Description
request DeleteInterconnectRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Operation

The response received from the server.

Delete(DeleteInterconnectRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation Delete(DeleteInterconnectRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes the specified Interconnect.

Parameters
Name Description
request DeleteInterconnectRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline System.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
Operation

The response received from the server.

DeleteAsync(DeleteInterconnectRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> DeleteAsync(DeleteInterconnectRequest request, CallOptions options)

Deletes the specified Interconnect.

Parameters
Name Description
request DeleteInterconnectRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

DeleteAsync(DeleteInterconnectRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> DeleteAsync(DeleteInterconnectRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes the specified Interconnect.

Parameters
Name Description
request DeleteInterconnectRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline System.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

Get(GetInterconnectRequest, CallOptions)

public virtual Interconnect Get(GetInterconnectRequest request, CallOptions options)

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

Parameters
Name Description
request GetInterconnectRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Interconnect

The response received from the server.

Get(GetInterconnectRequest, Metadata, DateTime?, CancellationToken)

public virtual Interconnect Get(GetInterconnectRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name Description
request GetInterconnectRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline System.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
Interconnect

The response received from the server.

GetAsync(GetInterconnectRequest, CallOptions)

public virtual AsyncUnaryCall<Interconnect> GetAsync(GetInterconnectRequest request, CallOptions options)

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

Parameters
Name Description
request GetInterconnectRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallInterconnect

The call object.

GetAsync(GetInterconnectRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Interconnect> GetAsync(GetInterconnectRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name Description
request GetInterconnectRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline System.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallInterconnect

The call object.

GetDiagnostics(GetDiagnosticsInterconnectRequest, CallOptions)

public virtual InterconnectsGetDiagnosticsResponse GetDiagnostics(GetDiagnosticsInterconnectRequest request, CallOptions options)

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 to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
InterconnectsGetDiagnosticsResponse

The response received from the server.

GetDiagnostics(GetDiagnosticsInterconnectRequest, Metadata, DateTime?, CancellationToken)

public virtual InterconnectsGetDiagnosticsResponse GetDiagnostics(GetDiagnosticsInterconnectRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline System.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
InterconnectsGetDiagnosticsResponse

The response received from the server.

GetDiagnosticsAsync(GetDiagnosticsInterconnectRequest, CallOptions)

public virtual AsyncUnaryCall<InterconnectsGetDiagnosticsResponse> GetDiagnosticsAsync(GetDiagnosticsInterconnectRequest request, CallOptions options)

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 to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallInterconnectsGetDiagnosticsResponse

The call object.

GetDiagnosticsAsync(GetDiagnosticsInterconnectRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<InterconnectsGetDiagnosticsResponse> GetDiagnosticsAsync(GetDiagnosticsInterconnectRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline System.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallInterconnectsGetDiagnosticsResponse

The call object.

GetMacsecConfig(GetMacsecConfigInterconnectRequest, CallOptions)

public virtual InterconnectsGetMacsecConfigResponse GetMacsecConfig(GetMacsecConfigInterconnectRequest request, CallOptions options)

Returns the interconnectMacsecConfig for the specified Interconnect.

Parameters
Name Description
request GetMacsecConfigInterconnectRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
InterconnectsGetMacsecConfigResponse

The response received from the server.

GetMacsecConfig(GetMacsecConfigInterconnectRequest, Metadata, DateTime?, CancellationToken)

public virtual InterconnectsGetMacsecConfigResponse GetMacsecConfig(GetMacsecConfigInterconnectRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Returns the interconnectMacsecConfig for the specified Interconnect.

Parameters
Name Description
request GetMacsecConfigInterconnectRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline System.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
InterconnectsGetMacsecConfigResponse

The response received from the server.

GetMacsecConfigAsync(GetMacsecConfigInterconnectRequest, CallOptions)

public virtual AsyncUnaryCall<InterconnectsGetMacsecConfigResponse> GetMacsecConfigAsync(GetMacsecConfigInterconnectRequest request, CallOptions options)

Returns the interconnectMacsecConfig for the specified Interconnect.

Parameters
Name Description
request GetMacsecConfigInterconnectRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallInterconnectsGetMacsecConfigResponse

The call object.

GetMacsecConfigAsync(GetMacsecConfigInterconnectRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<InterconnectsGetMacsecConfigResponse> GetMacsecConfigAsync(GetMacsecConfigInterconnectRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Returns the interconnectMacsecConfig for the specified Interconnect.

Parameters
Name Description
request GetMacsecConfigInterconnectRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline System.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallInterconnectsGetMacsecConfigResponse

The call object.

Insert(InsertInterconnectRequest, CallOptions)

public virtual Operation Insert(InsertInterconnectRequest request, CallOptions options)

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

Parameters
Name Description
request InsertInterconnectRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Operation

The response received from the server.

Insert(InsertInterconnectRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation Insert(InsertInterconnectRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name Description
request InsertInterconnectRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline System.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
Operation

The response received from the server.

InsertAsync(InsertInterconnectRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> InsertAsync(InsertInterconnectRequest request, CallOptions options)

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

Parameters
Name Description
request InsertInterconnectRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

InsertAsync(InsertInterconnectRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> InsertAsync(InsertInterconnectRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name Description
request InsertInterconnectRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline System.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

List(ListInterconnectsRequest, CallOptions)

public virtual InterconnectList List(ListInterconnectsRequest request, CallOptions options)

Retrieves the list of Interconnects available to the specified project.

Parameters
Name Description
request ListInterconnectsRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
InterconnectList

The response received from the server.

List(ListInterconnectsRequest, Metadata, DateTime?, CancellationToken)

public virtual InterconnectList List(ListInterconnectsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Retrieves the list of Interconnects available to the specified project.

Parameters
Name Description
request ListInterconnectsRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline System.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
InterconnectList

The response received from the server.

ListAsync(ListInterconnectsRequest, CallOptions)

public virtual AsyncUnaryCall<InterconnectList> ListAsync(ListInterconnectsRequest request, CallOptions options)

Retrieves the list of Interconnects available to the specified project.

Parameters
Name Description
request ListInterconnectsRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallInterconnectList

The call object.

ListAsync(ListInterconnectsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<InterconnectList> ListAsync(ListInterconnectsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Retrieves the list of Interconnects available to the specified project.

Parameters
Name Description
request ListInterconnectsRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline System.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallInterconnectList

The call object.

NewInstance(ClientBaseConfiguration)

protected override Interconnects.InterconnectsClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name Description
configuration ClientBaseClientBaseConfiguration
Returns
Type Description
InterconnectsInterconnectsClient
Overrides
Grpc.Core.ClientBase<Google.Cloud.Compute.V1.Interconnects.InterconnectsClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)

Patch(PatchInterconnectRequest, CallOptions)

public virtual Operation Patch(PatchInterconnectRequest request, CallOptions options)

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 to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Operation

The response received from the server.

Patch(PatchInterconnectRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation Patch(PatchInterconnectRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline System.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
Operation

The response received from the server.

PatchAsync(PatchInterconnectRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> PatchAsync(PatchInterconnectRequest request, CallOptions options)

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 to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

PatchAsync(PatchInterconnectRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> PatchAsync(PatchInterconnectRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline System.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

SetLabels(SetLabelsInterconnectRequest, CallOptions)

public virtual Operation SetLabels(SetLabelsInterconnectRequest request, CallOptions options)

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

Parameters
Name Description
request SetLabelsInterconnectRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Operation

The response received from the server.

SetLabels(SetLabelsInterconnectRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation SetLabels(SetLabelsInterconnectRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name Description
request SetLabelsInterconnectRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline System.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
Operation

The response received from the server.

SetLabelsAsync(SetLabelsInterconnectRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> SetLabelsAsync(SetLabelsInterconnectRequest request, CallOptions options)

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

Parameters
Name Description
request SetLabelsInterconnectRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

SetLabelsAsync(SetLabelsInterconnectRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> SetLabelsAsync(SetLabelsInterconnectRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name Description
request SetLabelsInterconnectRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline System.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.