class Interconnects extends Resource (View source)

The "interconnects" collection of methods.

Typical usage is:

 $computeService = new Google\Service\Compute(...);
 $interconnects = $computeService->interconnects;

Methods

delete(string $project, string $interconnect, array $optParams = [])

Deletes the specified Interconnect. (interconnects.delete)

get(string $project, string $interconnect, array $optParams = [])

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

getDiagnostics(string $project, string $interconnect, array $optParams = [])

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.

getMacsecConfig(string $project, string $interconnect, array $optParams = [])

Returns the interconnectMacsecConfig for the specified Interconnect.

insert(string $project, Interconnect $postBody, array $optParams = [])

Creates an Interconnect in the specified project using the data included in the request. (interconnects.insert)

listInterconnects(string $project, array $optParams = [])

Retrieves the list of Interconnects available to the specified project.

patch(string $project, string $interconnect, Interconnect $postBody, array $optParams = [])

Updates the specified Interconnect with the data included in the request.

setLabels(string $project, string $resource, GlobalSetLabelsRequest $postBody, array $optParams = [])

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

Details

Operation delete(string $project, string $interconnect, array $optParams = [])

Deletes the specified Interconnect. (interconnects.delete)

Parameters

string $project

Project ID for this request.

string $interconnect

Name of the interconnect to delete.

array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

Interconnect get(string $project, string $interconnect, array $optParams = [])

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

Parameters

string $project

Project ID for this request.

string $interconnect

Name of the interconnect to return.

array $optParams

Optional parameters.

Return Value

Interconnect

Exceptions

Exception

InterconnectsGetDiagnosticsResponse getDiagnostics(string $project, string $interconnect, array $optParams = [])

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.

(interconnects.getDiagnostics)

Parameters

string $project

Project ID for this request.

string $interconnect

Name of the interconnect resource to query.

array $optParams

Optional parameters.

Return Value

InterconnectsGetDiagnosticsResponse

Exceptions

Exception

InterconnectsGetMacsecConfigResponse getMacsecConfig(string $project, string $interconnect, array $optParams = [])

Returns the interconnectMacsecConfig for the specified Interconnect.

(interconnects.getMacsecConfig)

Parameters

string $project

Project ID for this request.

string $interconnect

Name of the interconnect resource to query.

array $optParams

Optional parameters.

Return Value

InterconnectsGetMacsecConfigResponse

Exceptions

Exception

Operation insert(string $project, Interconnect $postBody, array $optParams = [])

Creates an Interconnect in the specified project using the data included in the request. (interconnects.insert)

Parameters

string $project

Project ID for this request.

Interconnect $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

InterconnectList listInterconnects(string $project, array $optParams = [])

Retrieves the list of Interconnects available to the specified project.

(interconnects.listInterconnects)

Parameters

string $project

Project ID for this request.

array $optParams

Optional parameters.

Return Value

InterconnectList

Exceptions

Exception

Operation patch(string $project, string $interconnect, Interconnect $postBody, array $optParams = [])

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. (interconnects.patch)

Parameters

string $project

Project ID for this request.

string $interconnect

Name of the interconnect to update.

Interconnect $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

Operation setLabels(string $project, string $resource, GlobalSetLabelsRequest $postBody, array $optParams = [])

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

Parameters

string $project

Project ID for this request.

string $resource

Name or id of the resource for this request.

GlobalSetLabelsRequest $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception