AutoscalingPolicyServiceClient(
transport=None,
channel=None,
credentials=None,
client_config=None,
client_info=None,
client_options=None,
)
The API interface for managing autoscaling policies in the Cloud Dataproc API.
Inheritance
builtins.object > google.cloud.dataproc_v1beta2.gapic.autoscaling_policy_service_client.AutoscalingPolicyServiceClient > AutoscalingPolicyServiceClientMethods
AutoscalingPolicyServiceClient
AutoscalingPolicyServiceClient(
transport=None,
channel=None,
credentials=None,
client_config=None,
client_info=None,
client_options=None,
)
Constructor.
Name | Description |
channel |
grpc.Channel
DEPRECATED. A |
credentials |
google.auth.credentials.Credentials
The authorization credentials to attach to requests. These credentials identify this application to the service. If none are specified, the client will attempt to ascertain the credentials from the environment. This argument is mutually exclusive with providing a transport instance to |
client_config |
dict
DEPRECATED. A dictionary of call options for each method. If not specified, the default configuration is used. |
client_info |
google.api_core.gapic_v1.client_info.ClientInfo
The client info used to send a user-agent string along with API requests. If |
client_options |
Union[dict, google.api_core.client_options.ClientOptions]
Client options used to set user options on the client. API Endpoint should be set through client_options. |
autoscaling_policy_path
autoscaling_policy_path(project, location, autoscaling_policy)
Return a fully-qualified autoscaling_policy string.
create_autoscaling_policy
create_autoscaling_policy(parent, policy, retry=<object object>, timeout=<object object>, metadata=None)
Creates new autoscaling policy.
.. rubric:: Example
from google.cloud import dataproc_v1beta2
client = dataproc_v1beta2.AutoscalingPolicyServiceClient()
parent = client.region_path('[PROJECT]', '[REGION]')
TODO: Initialize
policy
:policy = {}
response = client.create_autoscaling_policy(parent, policy)
Name | Description |
parent |
str
Required. The "resource name" of the region or location, as described in https://cloud.google.com/apis/design/resource_names. - For |
policy |
Union[dict, AutoscalingPolicy]
Required. The autoscaling policy to create. If a dict is provided, it must be of the same form as the protobuf message AutoscalingPolicy |
retry |
Optional[google.api_core.retry.Retry]
A retry object used to retry requests. If |
timeout |
Optional[float]
The amount of time, in seconds, to wait for the request to complete. Note that if |
metadata |
Optional[Sequence[Tuple[str, str]]]
Additional metadata that is provided to the method. |
Type | Description |
google.api_core.exceptions.GoogleAPICallError | If the request failed for any reason. |
google.api_core.exceptions.RetryError | If the request failed due to a retryable error and retry attempts failed. |
ValueError | If the parameters are invalid. |
delete_autoscaling_policy
delete_autoscaling_policy(name, retry=<object object>, timeout=<object object>, metadata=None)
Deletes an autoscaling policy. It is an error to delete an autoscaling policy that is in use by one or more clusters.
.. rubric:: Example
from google.cloud import dataproc_v1beta2
client = dataproc_v1beta2.AutoscalingPolicyServiceClient()
TODO: Initialize
name
:name = ''
client.delete_autoscaling_policy(name)
Name | Description |
name |
str
Required. The "resource name" of the autoscaling policy, as described in https://cloud.google.com/apis/design/resource_names. - For |
retry |
Optional[google.api_core.retry.Retry]
A retry object used to retry requests. If |
timeout |
Optional[float]
The amount of time, in seconds, to wait for the request to complete. Note that if |
metadata |
Optional[Sequence[Tuple[str, str]]]
Additional metadata that is provided to the method. |
Type | Description |
google.api_core.exceptions.GoogleAPICallError | If the request failed for any reason. |
google.api_core.exceptions.RetryError | If the request failed due to a retryable error and retry attempts failed. |
ValueError | If the parameters are invalid. |
from_service_account_file
from_service_account_file(filename, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
Name | Description |
filename |
str
The path to the service account private key json file. |
Type | Description |
AutoscalingPolicyServiceClient | The constructed client. |
from_service_account_json
from_service_account_json(filename, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
Name | Description |
filename |
str
The path to the service account private key json file. |
Type | Description |
AutoscalingPolicyServiceClient | The constructed client. |
get_autoscaling_policy
get_autoscaling_policy(name, retry=<object object>, timeout=<object object>, metadata=None)
Retrieves autoscaling policy.
.. rubric:: Example
from google.cloud import dataproc_v1beta2
client = dataproc_v1beta2.AutoscalingPolicyServiceClient()
TODO: Initialize
name
:name = ''
response = client.get_autoscaling_policy(name)
Name | Description |
name |
str
Required. The "resource name" of the autoscaling policy, as described in https://cloud.google.com/apis/design/resource_names. - For |
retry |
Optional[google.api_core.retry.Retry]
A retry object used to retry requests. If |
timeout |
Optional[float]
The amount of time, in seconds, to wait for the request to complete. Note that if |
metadata |
Optional[Sequence[Tuple[str, str]]]
Additional metadata that is provided to the method. |
Type | Description |
google.api_core.exceptions.GoogleAPICallError | If the request failed for any reason. |
google.api_core.exceptions.RetryError | If the request failed due to a retryable error and retry attempts failed. |
ValueError | If the parameters are invalid. |
list_autoscaling_policies
list_autoscaling_policies(parent, page_size=None, retry=<object object>, timeout=<object object>, metadata=None)
Lists autoscaling policies in the project.
.. rubric:: Example
from google.cloud import dataproc_v1beta2
client = dataproc_v1beta2.AutoscalingPolicyServiceClient()
parent = client.region_path('[PROJECT]', '[REGION]')
Iterate over all results
for element in client.list_autoscaling_policies(parent): ... # process element ... pass
Alternatively:
Iterate over results one page at a time
for page in client.list_autoscaling_policies(parent).pages: ... for element in page: ... # process element ... pass
Name | Description |
parent |
str
Required. The "resource name" of the region or location, as described in https://cloud.google.com/apis/design/resource_names. - For |
page_size |
int
The maximum number of resources contained in the underlying API response. If page streaming is performed per- resource, this parameter does not affect the return value. If page streaming is performed per-page, this determines the maximum number of resources in a page. |
retry |
Optional[google.api_core.retry.Retry]
A retry object used to retry requests. If |
timeout |
Optional[float]
The amount of time, in seconds, to wait for the request to complete. Note that if |
metadata |
Optional[Sequence[Tuple[str, str]]]
Additional metadata that is provided to the method. |
Type | Description |
google.api_core.exceptions.GoogleAPICallError | If the request failed for any reason. |
google.api_core.exceptions.RetryError | If the request failed due to a retryable error and retry attempts failed. |
ValueError | If the parameters are invalid. |
location_path
location_path(project, location)
Return a fully-qualified location string.
region_path
region_path(project, region)
Return a fully-qualified region string.
update_autoscaling_policy
update_autoscaling_policy(policy, retry=<object object>, timeout=<object object>, metadata=None)
Updates (replaces) autoscaling policy.
Disabled check for update_mask, because all updates will be full replacements.
.. rubric:: Example
from google.cloud import dataproc_v1beta2
client = dataproc_v1beta2.AutoscalingPolicyServiceClient()
TODO: Initialize
policy
:policy = {}
response = client.update_autoscaling_policy(policy)
Name | Description |
policy |
Union[dict, AutoscalingPolicy]
Required. The updated autoscaling policy. If a dict is provided, it must be of the same form as the protobuf message AutoscalingPolicy |
retry |
Optional[google.api_core.retry.Retry]
A retry object used to retry requests. If |
timeout |
Optional[float]
The amount of time, in seconds, to wait for the request to complete. Note that if |
metadata |
Optional[Sequence[Tuple[str, str]]]
Additional metadata that is provided to the method. |
Type | Description |
google.api_core.exceptions.GoogleAPICallError | If the request failed for any reason. |
google.api_core.exceptions.RetryError | If the request failed due to a retryable error and retry attempts failed. |
ValueError | If the parameters are invalid. |