Class InterconnectsClient (2.18.0)

Version 2.18.0

• 2.34.0-rc (latest)
• 2.33.0
• 2.32.0
• 2.31.0
• 2.30.0
• 2.29.0
• 2.28.0
• 2.27.0
• 2.26.0
• 2.25.1
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.1

Service for the interconnects resource.

https://cloud.google.com/compute/docs/reference/rest/v1/interconnects

Equality

Instances of this class created via copy-construction or copy-assignment always compare equal. Instances created with equal std::shared_ptr<*Connection> objects compare equal. Objects that compare equal share the same underlying resources.

Performance

Creating a new instance of this class is a relatively expensive operation, new objects establish new connections to the service. In contrast, copy-construction, move-construction, and the corresponding assignment operations are relatively efficient as the copies share all underlying resources.

Thread Safety

Concurrent access to different instances of this class, even if they compare equal, is guaranteed to work. Two or more threads operating on the same instance of this class is not guaranteed to work. Since copy-construction and move-construction is a relatively efficient operation, consider using such a copy when using this class from multiple threads.

Constructors

InterconnectsClient(InterconnectsClient const &)

Copy and move support

Parameter
Name	Description
	InterconnectsClient const &

InterconnectsClient(InterconnectsClient &&)

Copy and move support

Parameter
Name	Description
	InterconnectsClient &&

InterconnectsClient(std::shared_ptr< InterconnectsConnection >, Options)

Parameters
Name	Description
connection	std::shared_ptr< InterconnectsConnection >
opts	Options

Operators

operator=(InterconnectsClient const &)

Copy and move support

Parameter
Name	Description
	InterconnectsClient const &

Returns
Type	Description
InterconnectsClient &

operator=(InterconnectsClient &&)

Copy and move support

Parameter
Name	Description
	InterconnectsClient &&

Returns
Type	Description
InterconnectsClient &

Functions

DeleteInterconnect(std::string const &, std::string const &, Options)

Deletes the specified Interconnect.

https://cloud.google.com/compute/docs/reference/rest/v1/interconnects/delete

Parameters
Name	Description
project	std::string const & Project ID for this request.
interconnect	std::string const & Name of the interconnect to delete.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
future< StatusOr< google::cloud::cpp::compute::v1::Operation > >	A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a [google.cloud.cpp.compute.v1.Operation] proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteInterconnect(google::cloud::cpp::compute::interconnects::v1::DeleteInterconnectRequest const &, Options)

Deletes the specified Interconnect.

https://cloud.google.com/compute/docs/reference/rest/v1/interconnects/delete

Parameters
Name	Description
request	google::cloud::cpp::compute::interconnects::v1::DeleteInterconnectRequest const & Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.cpp.compute.interconnects.v1.DeleteInterconnectRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
future< StatusOr< google::cloud::cpp::compute::v1::Operation > >	A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a [google.cloud.cpp.compute.v1.Operation] proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

GetInterconnect(std::string const &, std::string const &, Options)

Returns the specified Interconnect.

Get a list of available Interconnects by making a list() request. https://cloud.google.com/compute/docs/reference/rest/v1/interconnects/get

Parameters
Name	Description
project	std::string const & Project ID for this request.
interconnect	std::string const & Name of the interconnect to return.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::cpp::compute::v1::Interconnect >	the result of the RPC. The response message type (google.cloud.cpp.compute.v1.Interconnect) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetInterconnect(google::cloud::cpp::compute::interconnects::v1::GetInterconnectRequest const &, Options)

Returns the specified Interconnect.

Get a list of available Interconnects by making a list() request. https://cloud.google.com/compute/docs/reference/rest/v1/interconnects/get

Parameters
Name	Description
request	google::cloud::cpp::compute::interconnects::v1::GetInterconnectRequest const & Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.cpp.compute.interconnects.v1.GetInterconnectRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::cpp::compute::v1::Interconnect >	the result of the RPC. The response message type (google.cloud.cpp.compute.v1.Interconnect) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetDiagnostics(std::string const &, std::string const &, 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. https://cloud.google.com/compute/docs/reference/rest/v1/interconnects/getDiagnostics

Parameters
Name	Description
project	std::string const & Project ID for this request.
interconnect	std::string const & Name of the interconnect resource to query.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::cpp::compute::v1::InterconnectsGetDiagnosticsResponse >	the result of the RPC. The response message type (google.cloud.cpp.compute.v1.InterconnectsGetDiagnosticsResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetDiagnostics(google::cloud::cpp::compute::interconnects::v1::GetDiagnosticsRequest const &, 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. https://cloud.google.com/compute/docs/reference/rest/v1/interconnects/getDiagnostics

Parameters
Name	Description
request	google::cloud::cpp::compute::interconnects::v1::GetDiagnosticsRequest const & Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.cpp.compute.interconnects.v1.GetDiagnosticsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::cpp::compute::v1::InterconnectsGetDiagnosticsResponse >	the result of the RPC. The response message type (google.cloud.cpp.compute.v1.InterconnectsGetDiagnosticsResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetMacsecConfig(std::string const &, std::string const &, Options)

Returns the interconnectMacsecConfig for the specified Interconnect.

https://cloud.google.com/compute/docs/reference/rest/v1/interconnects/getMacsecConfig

Parameters
Name	Description
project	std::string const & Project ID for this request.
interconnect	std::string const & Name of the interconnect resource to query.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::cpp::compute::v1::InterconnectsGetMacsecConfigResponse >	the result of the RPC. The response message type (google.cloud.cpp.compute.v1.InterconnectsGetMacsecConfigResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetMacsecConfig(google::cloud::cpp::compute::interconnects::v1::GetMacsecConfigRequest const &, Options)

Returns the interconnectMacsecConfig for the specified Interconnect.

https://cloud.google.com/compute/docs/reference/rest/v1/interconnects/getMacsecConfig

Parameters
Name	Description
request	google::cloud::cpp::compute::interconnects::v1::GetMacsecConfigRequest const & Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.cpp.compute.interconnects.v1.GetMacsecConfigRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::cpp::compute::v1::InterconnectsGetMacsecConfigResponse >	the result of the RPC. The response message type (google.cloud.cpp.compute.v1.InterconnectsGetMacsecConfigResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

InsertInterconnect(std::string const &, google::cloud::cpp::compute::v1::Interconnect const &, Options)

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

https://cloud.google.com/compute/docs/reference/rest/v1/interconnects/insert

Parameters
Name	Description
project	std::string const & Project ID for this request.
interconnect_resource	google::cloud::cpp::compute::v1::Interconnect const & The Interconnect for this request.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
future< StatusOr< google::cloud::cpp::compute::v1::Operation > >	A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a [google.cloud.cpp.compute.v1.Operation] proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

InsertInterconnect(google::cloud::cpp::compute::interconnects::v1::InsertInterconnectRequest const &, Options)

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

https://cloud.google.com/compute/docs/reference/rest/v1/interconnects/insert

Parameters
Name	Description
request	google::cloud::cpp::compute::interconnects::v1::InsertInterconnectRequest const & Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.cpp.compute.interconnects.v1.InsertInterconnectRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
future< StatusOr< google::cloud::cpp::compute::v1::Operation > >	A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a [google.cloud.cpp.compute.v1.Operation] proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

ListInterconnects(std::string const &, Options)

Retrieves the list of Interconnects available to the specified project.

https://cloud.google.com/compute/docs/reference/rest/v1/interconnects/list

Parameters
Name	Description
project	std::string const & Project ID for this request.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StreamRange< google::cloud::cpp::compute::v1::Interconnect >	a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.cpp.compute.v1.Interconnect, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListInterconnects(google::cloud::cpp::compute::interconnects::v1::ListInterconnectsRequest, Options)

Retrieves the list of Interconnects available to the specified project.

https://cloud.google.com/compute/docs/reference/rest/v1/interconnects/list

Parameters
Name	Description
request	google::cloud::cpp::compute::interconnects::v1::ListInterconnectsRequest Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.cpp.compute.interconnects.v1.ListInterconnectsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StreamRange< google::cloud::cpp::compute::v1::Interconnect >	a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.cpp.compute.v1.Interconnect, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

PatchInterconnect(std::string const &, std::string const &, google::cloud::cpp::compute::v1::Interconnect const &, 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. https://cloud.google.com/compute/docs/reference/rest/v1/interconnects/patch

Parameters
Name	Description
project	std::string const & Project ID for this request.
interconnect	std::string const & Name of the interconnect to update.
interconnect_resource	google::cloud::cpp::compute::v1::Interconnect const & The Interconnect for this request.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
future< StatusOr< google::cloud::cpp::compute::v1::Operation > >	A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a [google.cloud.cpp.compute.v1.Operation] proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

PatchInterconnect(google::cloud::cpp::compute::interconnects::v1::PatchInterconnectRequest const &, 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. https://cloud.google.com/compute/docs/reference/rest/v1/interconnects/patch

Parameters
Name	Description
request	google::cloud::cpp::compute::interconnects::v1::PatchInterconnectRequest const & Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.cpp.compute.interconnects.v1.PatchInterconnectRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
future< StatusOr< google::cloud::cpp::compute::v1::Operation > >	A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a [google.cloud.cpp.compute.v1.Operation] proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

SetLabels(std::string const &, std::string const &, google::cloud::cpp::compute::v1::GlobalSetLabelsRequest const &, Options)

Sets the labels on an Interconnect.

To learn more about labels, read the Labeling Resources documentation. https://cloud.google.com/compute/docs/reference/rest/v1/interconnects/setLabels

Parameters
Name	Description
project	std::string const & Project ID for this request.
resource	std::string const & Name or id of the resource for this request.
global_set_labels_request_resource	google::cloud::cpp::compute::v1::GlobalSetLabelsRequest const & The GlobalSetLabelsRequest for this request.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
future< StatusOr< google::cloud::cpp::compute::v1::Operation > >	A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a [google.cloud.cpp.compute.v1.Operation] proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

SetLabels(google::cloud::cpp::compute::interconnects::v1::SetLabelsRequest const &, Options)

Sets the labels on an Interconnect.

To learn more about labels, read the Labeling Resources documentation. https://cloud.google.com/compute/docs/reference/rest/v1/interconnects/setLabels

Parameters
Name	Description
request	google::cloud::cpp::compute::interconnects::v1::SetLabelsRequest const & Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.cpp.compute.interconnects.v1.SetLabelsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
future< StatusOr< google::cloud::cpp::compute::v1::Operation > >	A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a [google.cloud.cpp.compute.v1.Operation] proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.