Service for the serviceAttachments resource.
https://cloud.google.com/compute/docs/reference/rest/v1/serviceAttachments
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
ServiceAttachmentsClient(ServiceAttachmentsClient const &)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
ServiceAttachmentsClient const &
|
ServiceAttachmentsClient(ServiceAttachmentsClient &&)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
ServiceAttachmentsClient &&
|
ServiceAttachmentsClient(std::shared_ptr< ServiceAttachmentsConnection >, Options)
Parameters | |
---|---|
Name | Description |
connection |
std::shared_ptr< ServiceAttachmentsConnection >
|
opts |
Options
|
Operators
operator=(ServiceAttachmentsClient const &)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
ServiceAttachmentsClient const &
|
Returns | |
---|---|
Type | Description |
ServiceAttachmentsClient & |
operator=(ServiceAttachmentsClient &&)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
ServiceAttachmentsClient &&
|
Returns | |
---|---|
Type | Description |
ServiceAttachmentsClient & |
Functions
AggregatedListServiceAttachments(std::string const &, Options)
Retrieves the list of all ServiceAttachment resources, regional and global, available to the specified project.
To prevent failure, Google recommends that you set the returnPartialSuccess
parameter to true
. https://cloud.google.com/compute/docs/reference/rest/v1/serviceAttachments/aggregatedList
Parameters | |
---|---|
Name | Description |
project |
std::string const &
Name of the project scoping 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::ServiceAttachmentsScopedList > > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
AggregatedListServiceAttachments(google::cloud::cpp::compute::service_attachments::v1::AggregatedListServiceAttachmentsRequest, Options)
Retrieves the list of all ServiceAttachment resources, regional and global, available to the specified project.
To prevent failure, Google recommends that you set the returnPartialSuccess
parameter to true
. https://cloud.google.com/compute/docs/reference/rest/v1/serviceAttachments/aggregatedList
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::service_attachments::v1::AggregatedListServiceAttachmentsRequest
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::ServiceAttachmentsScopedList > > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
DeleteServiceAttachment(std::string const &, std::string const &, std::string const &, Options)
Deletes the specified ServiceAttachment in the given scope https://cloud.google.com/compute/docs/reference/rest/v1/serviceAttachments/delete.
Parameters | |
---|---|
Name | Description |
project |
std::string const &
Project ID for this request. |
region |
std::string const &
Name of the region of this request. |
service_attachment |
std::string const &
Name of the ServiceAttachment resource 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 |
DeleteServiceAttachment(NoAwaitTag, std::string const &, std::string const &, std::string const &, Options)
Deletes the specified ServiceAttachment in the given scope https://cloud.google.com/compute/docs/reference/rest/v1/serviceAttachments/delete.
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 &
|
service_attachment |
std::string const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
DeleteServiceAttachment(google::cloud::cpp::compute::service_attachments::v1::DeleteServiceAttachmentRequest const &, Options)
Deletes the specified ServiceAttachment in the given scope https://cloud.google.com/compute/docs/reference/rest/v1/serviceAttachments/delete.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::service_attachments::v1::DeleteServiceAttachmentRequest 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 |
DeleteServiceAttachment(NoAwaitTag, google::cloud::cpp::compute::service_attachments::v1::DeleteServiceAttachmentRequest const &, Options)
Deletes the specified ServiceAttachment in the given scope https://cloud.google.com/compute/docs/reference/rest/v1/serviceAttachments/delete.
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::service_attachments::v1::DeleteServiceAttachmentRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
DeleteServiceAttachment(google::cloud::cpp::compute::v1::Operation const &, Options)
Deletes the specified ServiceAttachment in the given scope https://cloud.google.com/compute/docs/reference/rest/v1/serviceAttachments/delete.
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 > > |
GetServiceAttachment(std::string const &, std::string const &, std::string const &, Options)
Returns the specified ServiceAttachment resource in the given scope.
Parameters | |
---|---|
Name | Description |
project |
std::string const &
Project ID for this request. |
region |
std::string const &
Name of the region of this request. |
service_attachment |
std::string const &
Name of the ServiceAttachment resource 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::ServiceAttachment > |
the result of the RPC. The response message type (google.cloud.cpp.compute.v1.ServiceAttachment) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetServiceAttachment(google::cloud::cpp::compute::service_attachments::v1::GetServiceAttachmentRequest const &, Options)
Returns the specified ServiceAttachment resource in the given scope.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::service_attachments::v1::GetServiceAttachmentRequest 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::ServiceAttachment > |
the result of the RPC. The response message type (google.cloud.cpp.compute.v1.ServiceAttachment) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetIamPolicy(std::string const &, std::string const &, std::string const &, Options)
Gets the access control policy for a resource.
May be empty if no such policy or resource exists. https://cloud.google.com/compute/docs/reference/rest/v1/serviceAttachments/getIamPolicy
Parameters | |
---|---|
Name | Description |
project |
std::string const &
Project ID for this request. |
region |
std::string const &
The name of the region for this request. |
resource |
std::string const &
Name or id of the resource for this request. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Policy > |
the result of the RPC. The response message type (google.cloud.cpp.compute.v1.Policy) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetIamPolicy(google::cloud::cpp::compute::service_attachments::v1::GetIamPolicyRequest const &, Options)
Gets the access control policy for a resource.
May be empty if no such policy or resource exists. https://cloud.google.com/compute/docs/reference/rest/v1/serviceAttachments/getIamPolicy
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::service_attachments::v1::GetIamPolicyRequest 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::Policy > |
the result of the RPC. The response message type (google.cloud.cpp.compute.v1.Policy) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
InsertServiceAttachment(std::string const &, std::string const &, google::cloud::cpp::compute::v1::ServiceAttachment const &, Options)
Creates a ServiceAttachment in the specified project in the given scope using the parameters that are included in the request.
Parameters | |
---|---|
Name | Description |
project |
std::string const &
Project ID for this request. |
region |
std::string const &
Name of the region of this request. |
service_attachment_resource |
google::cloud::cpp::compute::v1::ServiceAttachment const &
The ServiceAttachment 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 |
InsertServiceAttachment(NoAwaitTag, std::string const &, std::string const &, google::cloud::cpp::compute::v1::ServiceAttachment const &, Options)
Creates a ServiceAttachment in the specified project in the given scope using the parameters that are 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 &
|
service_attachment_resource |
google::cloud::cpp::compute::v1::ServiceAttachment const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
InsertServiceAttachment(google::cloud::cpp::compute::service_attachments::v1::InsertServiceAttachmentRequest const &, Options)
Creates a ServiceAttachment in the specified project in the given scope using the parameters that are included in the request.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::service_attachments::v1::InsertServiceAttachmentRequest 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 |
InsertServiceAttachment(NoAwaitTag, google::cloud::cpp::compute::service_attachments::v1::InsertServiceAttachmentRequest const &, Options)
Creates a ServiceAttachment in the specified project in the given scope using the parameters that are 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::service_attachments::v1::InsertServiceAttachmentRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
InsertServiceAttachment(google::cloud::cpp::compute::v1::Operation const &, Options)
Creates a ServiceAttachment in the specified project in the given scope using the parameters that are 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 > > |
ListServiceAttachments(std::string const &, std::string const &, Options)
Lists the ServiceAttachments for a project in the given scope.
Parameters | |
---|---|
Name | Description |
project |
std::string const &
Project ID for this request. |
region |
std::string const &
Name of the region of 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::ServiceAttachment > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListServiceAttachments(google::cloud::cpp::compute::service_attachments::v1::ListServiceAttachmentsRequest, Options)
Lists the ServiceAttachments for a project in the given scope.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::service_attachments::v1::ListServiceAttachmentsRequest
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::ServiceAttachment > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
PatchServiceAttachment(std::string const &, std::string const &, std::string const &, google::cloud::cpp::compute::v1::ServiceAttachment const &, Options)
Patches the specified ServiceAttachment resource with the data included in the request.
This method supports PATCH semantics and uses JSON merge patch format and processing rules. https://cloud.google.com/compute/docs/reference/rest/v1/serviceAttachments/patch
Parameters | |
---|---|
Name | Description |
project |
std::string const &
Project ID for this request. |
region |
std::string const &
The region scoping this request and should conform to RFC1035. |
service_attachment |
std::string const &
The resource id of the ServiceAttachment to patch. It should conform to RFC1035 resource name or be a string form on an unsigned long number. |
service_attachment_resource |
google::cloud::cpp::compute::v1::ServiceAttachment const &
The ServiceAttachment 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 |
PatchServiceAttachment(NoAwaitTag, std::string const &, std::string const &, std::string const &, google::cloud::cpp::compute::v1::ServiceAttachment const &, Options)
Patches the specified ServiceAttachment resource 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 &
|
service_attachment |
std::string const &
|
service_attachment_resource |
google::cloud::cpp::compute::v1::ServiceAttachment const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
PatchServiceAttachment(google::cloud::cpp::compute::service_attachments::v1::PatchServiceAttachmentRequest const &, Options)
Patches the specified ServiceAttachment resource with the data included in the request.
This method supports PATCH semantics and uses JSON merge patch format and processing rules. https://cloud.google.com/compute/docs/reference/rest/v1/serviceAttachments/patch
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::service_attachments::v1::PatchServiceAttachmentRequest 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 |
PatchServiceAttachment(NoAwaitTag, google::cloud::cpp::compute::service_attachments::v1::PatchServiceAttachmentRequest const &, Options)
Patches the specified ServiceAttachment resource 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::service_attachments::v1::PatchServiceAttachmentRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Operation > |
PatchServiceAttachment(google::cloud::cpp::compute::v1::Operation const &, Options)
Patches the specified ServiceAttachment resource 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 > > |
SetIamPolicy(std::string const &, std::string const &, std::string const &, google::cloud::cpp::compute::v1::RegionSetPolicyRequest const &, Options)
Sets the access control policy on the specified resource.
Replaces any existing policy. https://cloud.google.com/compute/docs/reference/rest/v1/serviceAttachments/setIamPolicy
Parameters | |
---|---|
Name | Description |
project |
std::string const &
Project ID for this request. |
region |
std::string const &
The name of the region for this request. |
resource |
std::string const &
Name or id of the resource for this request. |
region_set_policy_request_resource |
google::cloud::cpp::compute::v1::RegionSetPolicyRequest const &
The RegionSetPolicyRequest for this request. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::Policy > |
the result of the RPC. The response message type (google.cloud.cpp.compute.v1.Policy) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
SetIamPolicy(google::cloud::cpp::compute::service_attachments::v1::SetIamPolicyRequest const &, Options)
Sets the access control policy on the specified resource.
Replaces any existing policy. https://cloud.google.com/compute/docs/reference/rest/v1/serviceAttachments/setIamPolicy
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::service_attachments::v1::SetIamPolicyRequest 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::Policy > |
the result of the RPC. The response message type (google.cloud.cpp.compute.v1.Policy) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
TestIamPermissions(std::string const &, std::string const &, std::string const &, google::cloud::cpp::compute::v1::TestPermissionsRequest const &, Options)
Returns permissions that a caller has on the specified resource.
Parameters | |
---|---|
Name | Description |
project |
std::string const &
Project ID for this request. |
region |
std::string const &
The name of the region for this request. |
resource |
std::string const &
Name or id of the resource for this request. |
test_permissions_request_resource |
google::cloud::cpp::compute::v1::TestPermissionsRequest const &
The TestPermissionsRequest for this request. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cpp::compute::v1::TestPermissionsResponse > |
the result of the RPC. The response message type (google.cloud.cpp.compute.v1.TestPermissionsResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
TestIamPermissions(google::cloud::cpp::compute::service_attachments::v1::TestIamPermissionsRequest const &, Options)
Returns permissions that a caller has on the specified resource.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::service_attachments::v1::TestIamPermissionsRequest 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::TestPermissionsResponse > |
the result of the RPC. The response message type (google.cloud.cpp.compute.v1.TestPermissionsResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |