The API interface for managing autoscaling policies in the Dataproc API.
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
AutoscalingPolicyServiceClient(AutoscalingPolicyServiceClient const &)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
AutoscalingPolicyServiceClient const &
|
AutoscalingPolicyServiceClient(AutoscalingPolicyServiceClient &&)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
AutoscalingPolicyServiceClient &&
|
AutoscalingPolicyServiceClient(std::shared_ptr< AutoscalingPolicyServiceConnection >, Options)
Parameters | |
---|---|
Name | Description |
connection |
std::shared_ptr< AutoscalingPolicyServiceConnection >
|
opts |
Options
|
Operators
operator=(AutoscalingPolicyServiceClient const &)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
AutoscalingPolicyServiceClient const &
|
Returns | |
---|---|
Type | Description |
AutoscalingPolicyServiceClient & |
operator=(AutoscalingPolicyServiceClient &&)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
AutoscalingPolicyServiceClient &&
|
Returns | |
---|---|
Type | Description |
AutoscalingPolicyServiceClient & |
Functions
CreateAutoscalingPolicy(std::string const &, google::cloud::dataproc::v1::AutoscalingPolicy const &, Options)
Creates new autoscaling policy.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The "resource name" of the region or location, as described in https://cloud.google.com/apis/design/resource_names.
|
policy |
google::cloud::dataproc::v1::AutoscalingPolicy const &
Required. The autoscaling policy to create. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::dataproc::v1::AutoscalingPolicy > |
the result of the RPC. The response message type (google.cloud.dataproc.v1.AutoscalingPolicy) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
CreateAutoscalingPolicy(google::cloud::dataproc::v1::CreateAutoscalingPolicyRequest const &, Options)
Creates new autoscaling policy.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::dataproc::v1::CreateAutoscalingPolicyRequest 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::dataproc::v1::AutoscalingPolicy > |
the result of the RPC. The response message type (google.cloud.dataproc.v1.AutoscalingPolicy) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
UpdateAutoscalingPolicy(google::cloud::dataproc::v1::AutoscalingPolicy const &, Options)
Updates (replaces) autoscaling policy.
Disabled check for update_mask, because all updates will be full replacements.
Parameters | |
---|---|
Name | Description |
policy |
google::cloud::dataproc::v1::AutoscalingPolicy const &
Required. The updated autoscaling policy. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::dataproc::v1::AutoscalingPolicy > |
the result of the RPC. The response message type (google.cloud.dataproc.v1.AutoscalingPolicy) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
UpdateAutoscalingPolicy(google::cloud::dataproc::v1::UpdateAutoscalingPolicyRequest const &, Options)
Updates (replaces) autoscaling policy.
Disabled check for update_mask, because all updates will be full replacements.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::dataproc::v1::UpdateAutoscalingPolicyRequest 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::dataproc::v1::AutoscalingPolicy > |
the result of the RPC. The response message type (google.cloud.dataproc.v1.AutoscalingPolicy) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetAutoscalingPolicy(std::string const &, Options)
Retrieves autoscaling policy.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The "resource name" of the autoscaling policy, as described in https://cloud.google.com/apis/design/resource_names.
|
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::dataproc::v1::AutoscalingPolicy > |
the result of the RPC. The response message type (google.cloud.dataproc.v1.AutoscalingPolicy) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetAutoscalingPolicy(google::cloud::dataproc::v1::GetAutoscalingPolicyRequest const &, Options)
Retrieves autoscaling policy.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::dataproc::v1::GetAutoscalingPolicyRequest 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::dataproc::v1::AutoscalingPolicy > |
the result of the RPC. The response message type (google.cloud.dataproc.v1.AutoscalingPolicy) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
ListAutoscalingPolicies(std::string const &, Options)
Lists autoscaling policies in the project.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The "resource name" of the region or location, as described in https://cloud.google.com/apis/design/resource_names.
|
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::dataproc::v1::AutoscalingPolicy > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListAutoscalingPolicies(google::cloud::dataproc::v1::ListAutoscalingPoliciesRequest, Options)
Lists autoscaling policies in the project.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::dataproc::v1::ListAutoscalingPoliciesRequest
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::dataproc::v1::AutoscalingPolicy > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
DeleteAutoscalingPolicy(std::string const &, Options)
Deletes an autoscaling policy.
It is an error to delete an autoscaling policy that is in use by one or more clusters.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The "resource name" of the autoscaling policy, as described in https://cloud.google.com/apis/design/resource_names.
|
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
Status |
a |
DeleteAutoscalingPolicy(google::cloud::dataproc::v1::DeleteAutoscalingPolicyRequest const &, Options)
Deletes an autoscaling policy.
It is an error to delete an autoscaling policy that is in use by one or more clusters.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::dataproc::v1::DeleteAutoscalingPolicyRequest 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 |
Status |
a |