Service for the backendBuckets resource.
https://cloud.google.com/compute/docs/reference/rest/v1/backendBuckets
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
BackendBucketsClient(BackendBucketsClient const &)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
BackendBucketsClient const &
|
BackendBucketsClient(BackendBucketsClient &&)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
BackendBucketsClient &&
|
BackendBucketsClient(ExperimentalTag, std::shared_ptr< BackendBucketsConnection >, Options)
Parameters | |
---|---|
Name | Description |
|
ExperimentalTag
|
connection |
std::shared_ptr< BackendBucketsConnection >
|
opts |
Options
|
Operators
operator=(BackendBucketsClient const &)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
BackendBucketsClient const &
|
Returns | |
---|---|
Type | Description |
BackendBucketsClient & |
operator=(BackendBucketsClient &&)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
BackendBucketsClient &&
|
Returns | |
---|---|
Type | Description |
BackendBucketsClient & |
Functions
AddSignedUrlKey(std::string const &, std::string const &, google::cloud::cpp::compute::v1::SignedUrlKey const &, Options)
Adds a key for validating requests with signed URLs for this backend bucket.
Parameters | |
---|---|
Name | Description |
project |
std::string const &
Project ID for this request. |
backend_bucket |
std::string const &
Name of the BackendBucket resource to which the Signed URL Key should be added. The name should conform to RFC1035. |
signed_url_key_resource |
google::cloud::cpp::compute::v1::SignedUrlKey const &
The SignedUrlKey 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 |
AddSignedUrlKey(google::cloud::cpp::compute::backend_buckets::v1::AddSignedUrlKeyRequest const &, Options)
Adds a key for validating requests with signed URLs for this backend bucket.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::backend_buckets::v1::AddSignedUrlKeyRequest 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 |
DeleteBackendBuckets(std::string const &, std::string const &, Options)
Deletes the specified BackendBucket resource.
Parameters | |
---|---|
Name | Description |
project |
std::string const &
Project ID for this request. |
backend_bucket |
std::string const &
Name of the BackendBucket 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 |
DeleteBackendBuckets(google::cloud::cpp::compute::backend_buckets::v1::DeleteBackendBucketsRequest const &, Options)
Deletes the specified BackendBucket resource.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::backend_buckets::v1::DeleteBackendBucketsRequest 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 |
DeleteSignedUrlKey(std::string const &, std::string const &, std::string const &, Options)
Deletes a key for validating requests with signed URLs for this backend bucket.
Parameters | |
---|---|
Name | Description |
project |
std::string const &
Project ID for this request. |
backend_bucket |
std::string const &
Name of the BackendBucket resource to which the Signed URL Key should be added. The name should conform to RFC1035. |
key_name |
std::string const &
The name of the Signed URL Key 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 |
DeleteSignedUrlKey(google::cloud::cpp::compute::backend_buckets::v1::DeleteSignedUrlKeyRequest const &, Options)
Deletes a key for validating requests with signed URLs for this backend bucket.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::backend_buckets::v1::DeleteSignedUrlKeyRequest 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 |
GetBackendBuckets(std::string const &, std::string const &, Options)
Returns the specified BackendBucket resource.
Parameters | |
---|---|
Name | Description |
project |
std::string const &
Project ID for this request. |
backend_bucket |
std::string const &
Name of the BackendBucket 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::BackendBucket > |
the result of the RPC. The response message type (google.cloud.cpp.compute.v1.BackendBucket) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetBackendBuckets(google::cloud::cpp::compute::backend_buckets::v1::GetBackendBucketsRequest const &, Options)
Returns the specified BackendBucket resource.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::backend_buckets::v1::GetBackendBucketsRequest 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::BackendBucket > |
the result of the RPC. The response message type (google.cloud.cpp.compute.v1.BackendBucket) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
InsertBackendBuckets(std::string const &, google::cloud::cpp::compute::v1::BackendBucket const &, Options)
Creates a BackendBucket resource in the specified project using the data included in the request.
Parameters | |
---|---|
Name | Description |
project |
std::string const &
Project ID for this request. |
backend_bucket_resource |
google::cloud::cpp::compute::v1::BackendBucket const &
The BackendBucket 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 |
InsertBackendBuckets(google::cloud::cpp::compute::backend_buckets::v1::InsertBackendBucketsRequest const &, Options)
Creates a BackendBucket resource in the specified project using the data included in the request.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::backend_buckets::v1::InsertBackendBucketsRequest 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 |
ListBackendBuckets(std::string const &, Options)
Retrieves the list of BackendBucket resources 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::BackendBucket > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListBackendBuckets(google::cloud::cpp::compute::backend_buckets::v1::ListBackendBucketsRequest, Options)
Retrieves the list of BackendBucket resources available to the specified project.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::backend_buckets::v1::ListBackendBucketsRequest
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::BackendBucket > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
PatchBackendBuckets(std::string const &, std::string const &, google::cloud::cpp::compute::v1::BackendBucket const &, Options)
Updates the specified BackendBucket resource with the data included in the request.
This method supports PATCH semantics and uses the JSON merge patch format and processing rules.
Parameters | |
---|---|
Name | Description |
project |
std::string const &
Project ID for this request. |
backend_bucket |
std::string const &
Name of the BackendBucket resource to patch. |
backend_bucket_resource |
google::cloud::cpp::compute::v1::BackendBucket const &
The BackendBucket 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 |
PatchBackendBuckets(google::cloud::cpp::compute::backend_buckets::v1::PatchBackendBucketsRequest const &, Options)
Updates the specified BackendBucket resource with the data included in the request.
This method supports PATCH semantics and uses the JSON merge patch format and processing rules.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::backend_buckets::v1::PatchBackendBucketsRequest 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 |
SetEdgeSecurityPolicy(std::string const &, std::string const &, google::cloud::cpp::compute::v1::SecurityPolicyReference const &, Options)
Sets the edge security policy for the specified backend bucket.
Parameters | |
---|---|
Name | Description |
project |
std::string const &
Project ID for this request. |
backend_bucket |
std::string const &
Name of the BackendService resource to which the security policy should be set. The name should conform to RFC1035. |
security_policy_reference_resource |
google::cloud::cpp::compute::v1::SecurityPolicyReference const &
The SecurityPolicyReference 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 |
SetEdgeSecurityPolicy(google::cloud::cpp::compute::backend_buckets::v1::SetEdgeSecurityPolicyRequest const &, Options)
Sets the edge security policy for the specified backend bucket.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::backend_buckets::v1::SetEdgeSecurityPolicyRequest 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 |
UpdateBackendBuckets(std::string const &, std::string const &, google::cloud::cpp::compute::v1::BackendBucket const &, Options)
Updates the specified BackendBucket resource with the data included in the request.
Parameters | |
---|---|
Name | Description |
project |
std::string const &
Project ID for this request. |
backend_bucket |
std::string const &
Name of the BackendBucket resource to update. |
backend_bucket_resource |
google::cloud::cpp::compute::v1::BackendBucket const &
The BackendBucket 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 |
UpdateBackendBuckets(google::cloud::cpp::compute::backend_buckets::v1::UpdateBackendBucketsRequest const &, Options)
Updates the specified BackendBucket resource with the data included in the request.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cpp::compute::backend_buckets::v1::UpdateBackendBucketsRequest 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 |