AutoscalingPolicyServiceAsyncClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Union[str, google.cloud.dataproc_v1.services.autoscaling_policy_service.transports.base.AutoscalingPolicyServiceTransport] = 'grpc_asyncio', client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)
The API interface for managing autoscaling policies in the Dataproc API.
Inheritance
builtins.object > AutoscalingPolicyServiceAsyncClientProperties
transport
Returns the transport used by the client instance.
Type | Description |
AutoscalingPolicyServiceTransport | The transport used by the client instance. |
Methods
AutoscalingPolicyServiceAsyncClient
AutoscalingPolicyServiceAsyncClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Union[str, google.cloud.dataproc_v1.services.autoscaling_policy_service.transports.base.AutoscalingPolicyServiceTransport] = 'grpc_asyncio', client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)
Instantiates the autoscaling policy service client.
Name | Description |
credentials |
Optional[google.auth.credentials.Credentials]
The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment. |
transport |
Union[str, `.AutoscalingPolicyServiceTransport`]
The transport to use. If set to None, a transport is chosen automatically. |
client_options |
ClientOptions
Custom options for the client. It won't take effect if a |
Type | Description |
google.auth.exceptions.MutualTlsChannelError | If mutual TLS transport creation failed for any reason. |
autoscaling_policy_path
autoscaling_policy_path(project: str, location: str, autoscaling_policy: str)
Returns a fully-qualified autoscaling_policy string.
common_billing_account_path
common_billing_account_path(billing_account: str)
Returns a fully-qualified billing_account string.
common_folder_path
common_folder_path(folder: str)
Returns a fully-qualified folder string.
common_location_path
common_location_path(project: str, location: str)
Returns a fully-qualified location string.
common_organization_path
common_organization_path(organization: str)
Returns a fully-qualified organization string.
common_project_path
common_project_path(project: str)
Returns a fully-qualified project string.
create_autoscaling_policy
create_autoscaling_policy(request: Optional[Union[google.cloud.dataproc_v1.types.autoscaling_policies.CreateAutoscalingPolicyRequest, dict]] = None, *, parent: Optional[str] = None, policy: Optional[google.cloud.dataproc_v1.types.autoscaling_policies.AutoscalingPolicy] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Creates new autoscaling policy.
from google.cloud import dataproc_v1
async def sample_create_autoscaling_policy():
# Create a client
client = dataproc_v1.AutoscalingPolicyServiceAsyncClient()
# Initialize request argument(s)
policy = dataproc_v1.AutoscalingPolicy()
policy.basic_algorithm.yarn_config.scale_up_factor = 0.1578
policy.basic_algorithm.yarn_config.scale_down_factor = 0.1789
policy.worker_config.max_instances = 1389
request = dataproc_v1.CreateAutoscalingPolicyRequest(
parent="parent_value",
policy=policy,
)
# Make the request
response = await client.create_autoscaling_policy(request=request)
# Handle the response
print(response)
Name | Description |
request |
Union[google.cloud.dataproc_v1.types.CreateAutoscalingPolicyRequest, dict]
The request object. A request to create an autoscaling policy. |
parent |
`str`
Required. The "resource name" of the region or location, as described in https://cloud.google.com/apis/design/resource_names. - For |
policy |
AutoscalingPolicy
Required. The autoscaling policy to create. This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Type | Description |
google.cloud.dataproc_v1.types.AutoscalingPolicy | Describes an autoscaling policy for Dataproc cluster autoscaler. |
delete_autoscaling_policy
delete_autoscaling_policy(request: Optional[Union[google.cloud.dataproc_v1.types.autoscaling_policies.DeleteAutoscalingPolicyRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Deletes an autoscaling policy. It is an error to delete an autoscaling policy that is in use by one or more clusters.
from google.cloud import dataproc_v1
async def sample_delete_autoscaling_policy():
# Create a client
client = dataproc_v1.AutoscalingPolicyServiceAsyncClient()
# Initialize request argument(s)
request = dataproc_v1.DeleteAutoscalingPolicyRequest(
name="name_value",
)
# Make the request
await client.delete_autoscaling_policy(request=request)
Name | Description |
request |
Union[google.cloud.dataproc_v1.types.DeleteAutoscalingPolicyRequest, dict]
The request object. A request to delete an autoscaling policy. Autoscaling policies in use by one or more clusters will not be deleted. |
name |
`str`
Required. The "resource name" of the autoscaling policy, as described in https://cloud.google.com/apis/design/resource_names. - For |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
from_service_account_file
from_service_account_file(filename: str, *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 |
AutoscalingPolicyServiceAsyncClient | The constructed client. |
from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
Name | Description |
info |
dict
The service account private key info. |
Type | Description |
AutoscalingPolicyServiceAsyncClient | The constructed client. |
from_service_account_json
from_service_account_json(filename: str, *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 |
AutoscalingPolicyServiceAsyncClient | The constructed client. |
get_autoscaling_policy
get_autoscaling_policy(request: Optional[Union[google.cloud.dataproc_v1.types.autoscaling_policies.GetAutoscalingPolicyRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Retrieves autoscaling policy.
from google.cloud import dataproc_v1
async def sample_get_autoscaling_policy():
# Create a client
client = dataproc_v1.AutoscalingPolicyServiceAsyncClient()
# Initialize request argument(s)
request = dataproc_v1.GetAutoscalingPolicyRequest(
name="name_value",
)
# Make the request
response = await client.get_autoscaling_policy(request=request)
# Handle the response
print(response)
Name | Description |
request |
Union[google.cloud.dataproc_v1.types.GetAutoscalingPolicyRequest, dict]
The request object. A request to fetch an autoscaling policy. |
name |
`str`
Required. The "resource name" of the autoscaling policy, as described in https://cloud.google.com/apis/design/resource_names. - For |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Type | Description |
google.cloud.dataproc_v1.types.AutoscalingPolicy | Describes an autoscaling policy for Dataproc cluster autoscaler. |
get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: Optional[google.api_core.client_options.ClientOptions] = None,
)
Return the API endpoint and client cert source for mutual TLS.
The client cert source is determined in the following order:
(1) if GOOGLE_API_USE_CLIENT_CERTIFICATE
environment variable is not "true", the
client cert source is None.
(2) if client_options.client_cert_source
is provided, use the provided one; if the
default client cert source exists, use the default one; otherwise the client cert
source is None.
The API endpoint is determined in the following order:
(1) if client_options.api_endpoint
if provided, use the provided one.
(2) if GOOGLE_API_USE_CLIENT_CERTIFICATE
environment variable is "always", use the
default mTLS endpoint; if the environment variabel is "never", use the default API
endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise
use the default API endpoint.
More details can be found at https://google.aip.dev/auth/4114.
Name | Description |
client_options |
google.api_core.client_options.ClientOptions
Custom options for the client. Only the |
Type | Description |
google.auth.exceptions.MutualTLSChannelError | If any errors happen. |
Type | Description |
Tuple[str, Callable[[], Tuple[bytes, bytes]]] | returns the API endpoint and the client cert source to use. |
get_transport_class
get_transport_class()
Returns an appropriate transport class.
list_autoscaling_policies
list_autoscaling_policies(request: Optional[Union[google.cloud.dataproc_v1.types.autoscaling_policies.ListAutoscalingPoliciesRequest, dict]] = None, *, parent: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Lists autoscaling policies in the project.
from google.cloud import dataproc_v1
async def sample_list_autoscaling_policies():
# Create a client
client = dataproc_v1.AutoscalingPolicyServiceAsyncClient()
# Initialize request argument(s)
request = dataproc_v1.ListAutoscalingPoliciesRequest(
parent="parent_value",
)
# Make the request
page_result = client.list_autoscaling_policies(request=request)
# Handle the response
async for response in page_result:
print(response)
Name | Description |
request |
Union[google.cloud.dataproc_v1.types.ListAutoscalingPoliciesRequest, dict]
The request object. A request to list autoscaling policies in a project. |
parent |
`str`
Required. The "resource name" of the region or location, as described in https://cloud.google.com/apis/design/resource_names. - For |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Type | Description |
google.cloud.dataproc_v1.services.autoscaling_policy_service.pagers.ListAutoscalingPoliciesAsyncPager | A response to a request to list autoscaling policies in a project. Iterating over this object will yield results and resolve additional pages automatically. |
parse_autoscaling_policy_path
parse_autoscaling_policy_path(path: str)
Parses a autoscaling_policy path into its component segments.
parse_common_billing_account_path
parse_common_billing_account_path(path: str)
Parse a billing_account path into its component segments.
parse_common_folder_path
parse_common_folder_path(path: str)
Parse a folder path into its component segments.
parse_common_location_path
parse_common_location_path(path: str)
Parse a location path into its component segments.
parse_common_organization_path
parse_common_organization_path(path: str)
Parse a organization path into its component segments.
parse_common_project_path
parse_common_project_path(path: str)
Parse a project path into its component segments.
update_autoscaling_policy
update_autoscaling_policy(request: Optional[Union[google.cloud.dataproc_v1.types.autoscaling_policies.UpdateAutoscalingPolicyRequest, dict]] = None, *, policy: Optional[google.cloud.dataproc_v1.types.autoscaling_policies.AutoscalingPolicy] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Updates (replaces) autoscaling policy.
Disabled check for update_mask, because all updates will be full replacements.
from google.cloud import dataproc_v1
async def sample_update_autoscaling_policy():
# Create a client
client = dataproc_v1.AutoscalingPolicyServiceAsyncClient()
# Initialize request argument(s)
policy = dataproc_v1.AutoscalingPolicy()
policy.basic_algorithm.yarn_config.scale_up_factor = 0.1578
policy.basic_algorithm.yarn_config.scale_down_factor = 0.1789
policy.worker_config.max_instances = 1389
request = dataproc_v1.UpdateAutoscalingPolicyRequest(
policy=policy,
)
# Make the request
response = await client.update_autoscaling_policy(request=request)
# Handle the response
print(response)
Name | Description |
request |
Union[google.cloud.dataproc_v1.types.UpdateAutoscalingPolicyRequest, dict]
The request object. A request to update an autoscaling policy. |
policy |
AutoscalingPolicy
Required. The updated autoscaling policy. This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Type | Description |
google.cloud.dataproc_v1.types.AutoscalingPolicy | Describes an autoscaling policy for Dataproc cluster autoscaler. |