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.
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 |
DeleteInterconnect(ExperimentalTag, NoAwaitTag, std::string const &, std::string const &, Options)
Deletes the specified Interconnect.
Specifying the NoAwaitTag
immediately returns the [google::cloud::cpp::compute::v1::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
ExperimentalTag
|
|
NoAwaitTag
|
project |
std::string const &
|
interconnect |
std::string const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
DeleteInterconnect(google::cloud::cpp::compute::interconnects::v1::DeleteInterconnectRequest const &, Options)
Deletes the specified Interconnect.
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 |
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 |
DeleteInterconnect(ExperimentalTag, NoAwaitTag, google::cloud::cpp::compute::interconnects::v1::DeleteInterconnectRequest const &, Options)
Deletes the specified Interconnect.
Specifying the NoAwaitTag
immediately returns the [google::cloud::cpp::compute::v1::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
ExperimentalTag
|
|
NoAwaitTag
|
request |
google::cloud::cpp::compute::interconnects::v1::DeleteInterconnectRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
DeleteInterconnect(ExperimentalTag, google::cloud::cpp::compute::v1::Operation const &, Options)
Deletes the specified Interconnect.
This method accepts a google::cloud::cpp::compute::v1::Operation
that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
Parameters | |
---|---|
Name | Description |
|
ExperimentalTag
|
operation |
google::cloud::cpp::compute::v1::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::cpp::compute::v1::Operation > > |
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 |
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 |
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 |
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 |
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 |
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 |
GetMacsecConfig(std::string const &, std::string const &, Options)
Returns the interconnectMacsecConfig for the specified Interconnect.
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 |
GetMacsecConfig(google::cloud::cpp::compute::interconnects::v1::GetMacsecConfigRequest const &, Options)
Returns the interconnectMacsecConfig for the specified Interconnect.
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 |
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 |
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.
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 |
InsertInterconnect(ExperimentalTag, NoAwaitTag, 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.
Specifying the NoAwaitTag
immediately returns the [google::cloud::cpp::compute::v1::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
ExperimentalTag
|
|
NoAwaitTag
|
project |
std::string const &
|
interconnect_resource |
google::cloud::cpp::compute::v1::Interconnect const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
InsertInterconnect(google::cloud::cpp::compute::interconnects::v1::InsertInterconnectRequest const &, Options)
Creates an Interconnect in the specified project using the data included in the request.
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 |
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 |
InsertInterconnect(ExperimentalTag, NoAwaitTag, google::cloud::cpp::compute::interconnects::v1::InsertInterconnectRequest const &, Options)
Creates an Interconnect in the specified project using the data included in the request.
Specifying the NoAwaitTag
immediately returns the [google::cloud::cpp::compute::v1::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
ExperimentalTag
|
|
NoAwaitTag
|
request |
google::cloud::cpp::compute::interconnects::v1::InsertInterconnectRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
InsertInterconnect(ExperimentalTag, google::cloud::cpp::compute::v1::Operation const &, Options)
Creates an Interconnect in the specified project using the data included in the request.
This method accepts a google::cloud::cpp::compute::v1::Operation
that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
Parameters | |
---|---|
Name | Description |
|
ExperimentalTag
|
operation |
google::cloud::cpp::compute::v1::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::cpp::compute::v1::Operation > > |
ListInterconnects(std::string const &, Options)
Retrieves the list of Interconnects available to the specified project.
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 |
ListInterconnects(google::cloud::cpp::compute::interconnects::v1::ListInterconnectsRequest, Options)
Retrieves the list of Interconnects available to the specified project.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::interconnects::v1::ListInterconnectsRequest
Unary RPCs, such as the one wrapped by this function, receive a single |
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 |
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 |
PatchInterconnect(ExperimentalTag, NoAwaitTag, 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.
Specifying the NoAwaitTag
immediately returns the [google::cloud::cpp::compute::v1::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
ExperimentalTag
|
|
NoAwaitTag
|
project |
std::string const &
|
interconnect |
std::string const &
|
interconnect_resource |
google::cloud::cpp::compute::v1::Interconnect const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
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 |
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 |
PatchInterconnect(ExperimentalTag, NoAwaitTag, google::cloud::cpp::compute::interconnects::v1::PatchInterconnectRequest const &, Options)
Updates the specified Interconnect with the data included in the request.
Specifying the NoAwaitTag
immediately returns the [google::cloud::cpp::compute::v1::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
ExperimentalTag
|
|
NoAwaitTag
|
request |
google::cloud::cpp::compute::interconnects::v1::PatchInterconnectRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
PatchInterconnect(ExperimentalTag, google::cloud::cpp::compute::v1::Operation const &, Options)
Updates the specified Interconnect with the data included in the request.
This method accepts a google::cloud::cpp::compute::v1::Operation
that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
Parameters | |
---|---|
Name | Description |
|
ExperimentalTag
|
operation |
google::cloud::cpp::compute::v1::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::cpp::compute::v1::Operation > > |
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 |
SetLabels(ExperimentalTag, NoAwaitTag, std::string const &, std::string const &, google::cloud::cpp::compute::v1::GlobalSetLabelsRequest const &, Options)
Sets the labels on an Interconnect.
Specifying the NoAwaitTag
immediately returns the [google::cloud::cpp::compute::v1::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
ExperimentalTag
|
|
NoAwaitTag
|
project |
std::string const &
|
resource |
std::string const &
|
global_set_labels_request_resource |
google::cloud::cpp::compute::v1::GlobalSetLabelsRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
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 |
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 |
SetLabels(ExperimentalTag, NoAwaitTag, google::cloud::cpp::compute::interconnects::v1::SetLabelsRequest const &, Options)
Sets the labels on an Interconnect.
Specifying the NoAwaitTag
immediately returns the [google::cloud::cpp::compute::v1::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
ExperimentalTag
|
|
NoAwaitTag
|
request |
google::cloud::cpp::compute::interconnects::v1::SetLabelsRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
SetLabels(ExperimentalTag, google::cloud::cpp::compute::v1::Operation const &, Options)
Sets the labels on an Interconnect.
This method accepts a google::cloud::cpp::compute::v1::Operation
that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
Parameters | |
---|---|
Name | Description |
|
ExperimentalTag
|
operation |
google::cloud::cpp::compute::v1::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::cpp::compute::v1::Operation > > |