Service for the networkAttachments resource.
https://cloud.google.com/compute/docs/reference/rest/v1/networkAttachments
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
NetworkAttachmentsClient(NetworkAttachmentsClient const &)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
NetworkAttachmentsClient const &
|
NetworkAttachmentsClient(NetworkAttachmentsClient &&)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
NetworkAttachmentsClient &&
|
NetworkAttachmentsClient(ExperimentalTag, std::shared_ptr< NetworkAttachmentsConnection >, Options)
Parameters | |
---|---|
Name | Description |
|
ExperimentalTag
|
connection |
std::shared_ptr< NetworkAttachmentsConnection >
|
opts |
Options
|
Operators
operator=(NetworkAttachmentsClient const &)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
NetworkAttachmentsClient const &
|
Returns | |
---|---|
Type | Description |
NetworkAttachmentsClient & |
operator=(NetworkAttachmentsClient &&)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
NetworkAttachmentsClient &&
|
Returns | |
---|---|
Type | Description |
NetworkAttachmentsClient & |
Functions
AggregatedListNetworkAttachments(std::string const &, Options)
Retrieves the list of all NetworkAttachment resources, regional and global, 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 |
StatusOr< google::cloud::cpp::compute::v1::NetworkAttachmentAggregatedList > |
the result of the RPC. The response message type (google.cloud.cpp.compute.v1.NetworkAttachmentAggregatedList) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
AggregatedListNetworkAttachments(google::cloud::cpp::compute::network_attachments::v1::AggregatedListNetworkAttachmentsRequest const &, Options)
Retrieves the list of all NetworkAttachment resources, regional and global, available to the specified project.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::network_attachments::v1::AggregatedListNetworkAttachmentsRequest 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::NetworkAttachmentAggregatedList > |
the result of the RPC. The response message type (google.cloud.cpp.compute.v1.NetworkAttachmentAggregatedList) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
DeleteNetworkAttachments(std::string const &, std::string const &, std::string const &, Options)
Deletes the specified NetworkAttachment 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. |
network_attachment |
std::string const &
Name of the NetworkAttachment 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 |
DeleteNetworkAttachments(google::cloud::cpp::compute::network_attachments::v1::DeleteNetworkAttachmentsRequest const &, Options)
Deletes the specified NetworkAttachment in the given scope.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::network_attachments::v1::DeleteNetworkAttachmentsRequest 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 |
GetNetworkAttachments(std::string const &, std::string const &, std::string const &, Options)
Returns the specified NetworkAttachment 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. |
network_attachment |
std::string const &
Name of the NetworkAttachment 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::NetworkAttachment > |
the result of the RPC. The response message type (google.cloud.cpp.compute.v1.NetworkAttachment) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetNetworkAttachments(google::cloud::cpp::compute::network_attachments::v1::GetNetworkAttachmentsRequest const &, Options)
Returns the specified NetworkAttachment resource in the given scope.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::network_attachments::v1::GetNetworkAttachmentsRequest 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::NetworkAttachment > |
the result of the RPC. The response message type (google.cloud.cpp.compute.v1.NetworkAttachment) 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.
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::network_attachments::v1::GetIamPolicyRequest const &, Options)
Gets the access control policy for a resource.
May be empty if no such policy or resource exists.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::network_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 |
InsertNetworkAttachments(std::string const &, std::string const &, google::cloud::cpp::compute::v1::NetworkAttachment const &, Options)
Creates a NetworkAttachment 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. |
network_attachment_resource |
google::cloud::cpp::compute::v1::NetworkAttachment const &
The NetworkAttachment 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 |
InsertNetworkAttachments(google::cloud::cpp::compute::network_attachments::v1::InsertNetworkAttachmentsRequest const &, Options)
Creates a NetworkAttachment 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::network_attachments::v1::InsertNetworkAttachmentsRequest 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 |
ListNetworkAttachments(std::string const &, std::string const &, Options)
Lists the NetworkAttachments 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::NetworkAttachment > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListNetworkAttachments(google::cloud::cpp::compute::network_attachments::v1::ListNetworkAttachmentsRequest, Options)
Lists the NetworkAttachments for a project in the given scope.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::network_attachments::v1::ListNetworkAttachmentsRequest
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::NetworkAttachment > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
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.
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::network_attachments::v1::SetIamPolicyRequest const &, Options)
Sets the access control policy on the specified resource.
Replaces any existing policy.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::network_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::network_attachments::v1::TestIamPermissionsRequest const &, Options)
Returns permissions that a caller has on the specified resource.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::network_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 |