Service for the interconnectAttachments resource.
https://cloud.google.com/compute/docs/reference/rest/v1/interconnectAttachments
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
InterconnectAttachmentsClient(InterconnectAttachmentsClient const &)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
InterconnectAttachmentsClient const &
|
InterconnectAttachmentsClient(InterconnectAttachmentsClient &&)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
InterconnectAttachmentsClient &&
|
InterconnectAttachmentsClient(std::shared_ptr< InterconnectAttachmentsConnection >, Options)
Parameters | |
---|---|
Name | Description |
connection |
std::shared_ptr< InterconnectAttachmentsConnection >
|
opts |
Options
|
Operators
operator=(InterconnectAttachmentsClient const &)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
InterconnectAttachmentsClient const &
|
Returns | |
---|---|
Type | Description |
InterconnectAttachmentsClient & |
operator=(InterconnectAttachmentsClient &&)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
InterconnectAttachmentsClient &&
|
Returns | |
---|---|
Type | Description |
InterconnectAttachmentsClient & |
Functions
AggregatedListInterconnectAttachments(std::string const &, Options)
Retrieves an aggregated list of interconnect attachments.
To prevent failure, Google recommends that you set the returnPartialSuccess
parameter to true
. https://cloud.google.com/compute/docs/reference/rest/v1/interconnectAttachments/aggregatedList
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< std::pair< std::string, google::cloud::cpp::compute::v1::InterconnectAttachmentsScopedList > > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
AggregatedListInterconnectAttachments(google::cloud::cpp::compute::interconnect_attachments::v1::AggregatedListInterconnectAttachmentsRequest, Options)
Retrieves an aggregated list of interconnect attachments.
To prevent failure, Google recommends that you set the returnPartialSuccess
parameter to true
. https://cloud.google.com/compute/docs/reference/rest/v1/interconnectAttachments/aggregatedList
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::interconnect_attachments::v1::AggregatedListInterconnectAttachmentsRequest
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< std::pair< std::string, google::cloud::cpp::compute::v1::InterconnectAttachmentsScopedList > > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
DeleteInterconnectAttachment(std::string const &, std::string const &, std::string const &, Options)
Deletes the specified interconnect attachment.
Parameters | |
---|---|
Name | Description |
project |
std::string const &
Project ID for this request. |
region |
std::string const &
Name of the region for this request. |
interconnect_attachment |
std::string const &
Name of the interconnect attachment 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 |
DeleteInterconnectAttachment(NoAwaitTag, std::string const &, std::string const &, std::string const &, Options)
Deletes the specified interconnect attachment.
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 |
|
NoAwaitTag
|
project |
std::string const &
|
region |
std::string const &
|
interconnect_attachment |
std::string const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
DeleteInterconnectAttachment(google::cloud::cpp::compute::interconnect_attachments::v1::DeleteInterconnectAttachmentRequest const &, Options)
Deletes the specified interconnect attachment.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::interconnect_attachments::v1::DeleteInterconnectAttachmentRequest 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 |
DeleteInterconnectAttachment(NoAwaitTag, google::cloud::cpp::compute::interconnect_attachments::v1::DeleteInterconnectAttachmentRequest const &, Options)
Deletes the specified interconnect attachment.
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 |
|
NoAwaitTag
|
request |
google::cloud::cpp::compute::interconnect_attachments::v1::DeleteInterconnectAttachmentRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
DeleteInterconnectAttachment(google::cloud::cpp::compute::v1::Operation const &, Options)
Deletes the specified interconnect attachment.
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 |
operation |
google::cloud::cpp::compute::v1::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::cpp::compute::v1::Operation > > |
GetInterconnectAttachment(std::string const &, std::string const &, std::string const &, Options)
Returns the specified interconnect attachment.
Parameters | |
---|---|
Name | Description |
project |
std::string const &
Project ID for this request. |
region |
std::string const &
Name of the region for this request. |
interconnect_attachment |
std::string const &
Name of the interconnect attachment 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::InterconnectAttachment > |
the result of the RPC. The response message type (google.cloud.cpp.compute.v1.InterconnectAttachment) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetInterconnectAttachment(google::cloud::cpp::compute::interconnect_attachments::v1::GetInterconnectAttachmentRequest const &, Options)
Returns the specified interconnect attachment.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::interconnect_attachments::v1::GetInterconnectAttachmentRequest 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::InterconnectAttachment > |
the result of the RPC. The response message type (google.cloud.cpp.compute.v1.InterconnectAttachment) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
InsertInterconnectAttachment(std::string const &, std::string const &, google::cloud::cpp::compute::v1::InterconnectAttachment const &, Options)
Creates an InterconnectAttachment in the specified project using the data included in the request.
Parameters | |
---|---|
Name | Description |
project |
std::string const &
Project ID for this request. |
region |
std::string const &
Name of the region for this request. |
interconnect_attachment_resource |
google::cloud::cpp::compute::v1::InterconnectAttachment const &
The InterconnectAttachment 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 |
InsertInterconnectAttachment(NoAwaitTag, std::string const &, std::string const &, google::cloud::cpp::compute::v1::InterconnectAttachment const &, Options)
Creates an InterconnectAttachment 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 |
|
NoAwaitTag
|
project |
std::string const &
|
region |
std::string const &
|
interconnect_attachment_resource |
google::cloud::cpp::compute::v1::InterconnectAttachment const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
InsertInterconnectAttachment(google::cloud::cpp::compute::interconnect_attachments::v1::InsertInterconnectAttachmentRequest const &, Options)
Creates an InterconnectAttachment in the specified project using the data included in the request.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::interconnect_attachments::v1::InsertInterconnectAttachmentRequest 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 |
InsertInterconnectAttachment(NoAwaitTag, google::cloud::cpp::compute::interconnect_attachments::v1::InsertInterconnectAttachmentRequest const &, Options)
Creates an InterconnectAttachment 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 |
|
NoAwaitTag
|
request |
google::cloud::cpp::compute::interconnect_attachments::v1::InsertInterconnectAttachmentRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
InsertInterconnectAttachment(google::cloud::cpp::compute::v1::Operation const &, Options)
Creates an InterconnectAttachment 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 |
operation |
google::cloud::cpp::compute::v1::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::cpp::compute::v1::Operation > > |
ListInterconnectAttachments(std::string const &, std::string const &, Options)
Retrieves the list of interconnect attachments contained within the specified region.
Parameters | |
---|---|
Name | Description |
project |
std::string const &
Project ID for this request. |
region |
std::string const &
Name of the region 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::InterconnectAttachment > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListInterconnectAttachments(google::cloud::cpp::compute::interconnect_attachments::v1::ListInterconnectAttachmentsRequest, Options)
Retrieves the list of interconnect attachments contained within the specified region.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::interconnect_attachments::v1::ListInterconnectAttachmentsRequest
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::InterconnectAttachment > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
PatchInterconnectAttachment(std::string const &, std::string const &, std::string const &, google::cloud::cpp::compute::v1::InterconnectAttachment const &, Options)
Updates the specified interconnect attachment 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/interconnectAttachments/patch
Parameters | |
---|---|
Name | Description |
project |
std::string const &
Project ID for this request. |
region |
std::string const &
Name of the region scoping this request. |
interconnect_attachment |
std::string const &
Name of the interconnect attachment to patch. |
interconnect_attachment_resource |
google::cloud::cpp::compute::v1::InterconnectAttachment const &
The InterconnectAttachment 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 |
PatchInterconnectAttachment(NoAwaitTag, std::string const &, std::string const &, std::string const &, google::cloud::cpp::compute::v1::InterconnectAttachment const &, Options)
Updates the specified interconnect attachment 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 |
|
NoAwaitTag
|
project |
std::string const &
|
region |
std::string const &
|
interconnect_attachment |
std::string const &
|
interconnect_attachment_resource |
google::cloud::cpp::compute::v1::InterconnectAttachment const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
PatchInterconnectAttachment(google::cloud::cpp::compute::interconnect_attachments::v1::PatchInterconnectAttachmentRequest const &, Options)
Updates the specified interconnect attachment 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/interconnectAttachments/patch
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::interconnect_attachments::v1::PatchInterconnectAttachmentRequest 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 |
PatchInterconnectAttachment(NoAwaitTag, google::cloud::cpp::compute::interconnect_attachments::v1::PatchInterconnectAttachmentRequest const &, Options)
Updates the specified interconnect attachment 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 |
|
NoAwaitTag
|
request |
google::cloud::cpp::compute::interconnect_attachments::v1::PatchInterconnectAttachmentRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
PatchInterconnectAttachment(google::cloud::cpp::compute::v1::Operation const &, Options)
Updates the specified interconnect attachment 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 |
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 &, std::string const &, google::cloud::cpp::compute::v1::RegionSetLabelsRequest const &, Options)
Sets the labels on an InterconnectAttachment.
To learn more about labels, read the Labeling Resources documentation. https://cloud.google.com/compute/docs/reference/rest/v1/interconnectAttachments/setLabels
Parameters | |
---|---|
Name | Description |
project |
std::string const &
Project ID for this request. |
region |
std::string const &
The region for this request. |
resource |
std::string const &
Name or id of the resource for this request. |
region_set_labels_request_resource |
google::cloud::cpp::compute::v1::RegionSetLabelsRequest const &
The RegionSetLabelsRequest 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(NoAwaitTag, std::string const &, std::string const &, std::string const &, google::cloud::cpp::compute::v1::RegionSetLabelsRequest const &, Options)
Sets the labels on an InterconnectAttachment.
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 |
|
NoAwaitTag
|
project |
std::string const &
|
region |
std::string const &
|
resource |
std::string const &
|
region_set_labels_request_resource |
google::cloud::cpp::compute::v1::RegionSetLabelsRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
SetLabels(google::cloud::cpp::compute::interconnect_attachments::v1::SetLabelsRequest const &, Options)
Sets the labels on an InterconnectAttachment.
To learn more about labels, read the Labeling Resources documentation. https://cloud.google.com/compute/docs/reference/rest/v1/interconnectAttachments/setLabels
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::interconnect_attachments::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(NoAwaitTag, google::cloud::cpp::compute::interconnect_attachments::v1::SetLabelsRequest const &, Options)
Sets the labels on an InterconnectAttachment.
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 |
|
NoAwaitTag
|
request |
google::cloud::cpp::compute::interconnect_attachments::v1::SetLabelsRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
SetLabels(google::cloud::cpp::compute::v1::Operation const &, Options)
Sets the labels on an InterconnectAttachment.
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 |
operation |
google::cloud::cpp::compute::v1::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::cpp::compute::v1::Operation > > |