Class AutoscalingPolicyServiceClient (2.6.1)

AutoscalingPolicyServiceClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.dataproc_v1.services.autoscaling_policy_service.transports.base.AutoscalingPolicyServiceTransport]] = None, 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 > AutoscalingPolicyServiceClient

Properties

transport

Returns the transport used by the client instance.

Returns

Type	Description
AutoscalingPolicyServiceTransport	The transport used by the client instance.

Methods

AutoscalingPolicyServiceClient

AutoscalingPolicyServiceClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.dataproc_v1.services.autoscaling_policy_service.transports.base.AutoscalingPolicyServiceTransport]] = None, 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.

Parameters

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	`google.api_core.client_options.ClientOptions` Custom options for the client. It won't take effect if a `transport` instance is provided. (1) The `api_endpoint` property can be used to override the default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT environment variable can also be used to override the endpoint: "always" (always use the default mTLS endpoint), "never" (always use the default regular endpoint) and "auto" (auto switch to the default mTLS endpoint if client certificate is present, this is the default value). However, the `api_endpoint` property takes precedence if provided. (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "true", then the `client_cert_source` property can be used to provide client certificate for mutual TLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is "false" or not set, no client certificate will be 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 `None`, then default info will be used. Generally, you only need to set this if you're developing your own client library.

Exceptions

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[google.cloud.dataproc_v1.types.autoscaling_policies.CreateAutoscalingPolicyRequest] = None, *, parent: Optional[str] = None, policy: Optional[google.cloud.dataproc_v1.types.autoscaling_policies.AutoscalingPolicy] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Creates new autoscaling policy.

Parameters

Name	Description
request	`google.cloud.dataproc_v1.types.CreateAutoscalingPolicyRequest` 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 `projects.regions.autoscalingPolicies.create`, the resource name of the region has the following format: `projects/{project_id}/regions/{region}` - For `projects.locations.autoscalingPolicies.create`, the resource name of the location has the following format: `projects/{project_id}/locations/{location}` This corresponds to the `parent` field on the `request` instance; if `request` is provided, this should not be set.
policy	`google.cloud.dataproc_v1.types.AutoscalingPolicy` Required. The autoscaling policy to create. This corresponds to the `policy` field on the `request` instance; if `request` is provided, this should not be set.
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.

Returns

Type	Description
google.cloud.dataproc_v1.types.AutoscalingPolicy	Describes an autoscaling policy for Dataproc cluster autoscaler.

delete_autoscaling_policy

delete_autoscaling_policy(request: Optional[google.cloud.dataproc_v1.types.autoscaling_policies.DeleteAutoscalingPolicyRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_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.

Parameters

Name	Description
request	`google.cloud.dataproc_v1.types.DeleteAutoscalingPolicyRequest` 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 `projects.regions.autoscalingPolicies.delete`, the resource name of the policy has the following format: `projects/{project_id}/regions/{region}/autoscalingPolicies/{policy_id}` - For `projects.locations.autoscalingPolicies.delete`, the resource name of the policy has the following format: `projects/{project_id}/locations/{location}/autoscalingPolicies/{policy_id}` This corresponds to the `name` field on the `request` instance; if `request` is provided, this should not be set.
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.

Parameter

Name	Description
filename	`str` The path to the service account private key json file.

Returns

Type	Description
AutoscalingPolicyServiceClient	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.

Parameter

Name	Description
info	`dict` The service account private key info.

Returns

Type	Description
AutoscalingPolicyServiceClient	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.

Parameter

Name	Description
filename	`str` The path to the service account private key json file.

Returns

Type	Description
AutoscalingPolicyServiceClient	The constructed client.

get_autoscaling_policy

get_autoscaling_policy(request: Optional[google.cloud.dataproc_v1.types.autoscaling_policies.GetAutoscalingPolicyRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Retrieves autoscaling policy.

Parameters

Name	Description
request	`google.cloud.dataproc_v1.types.GetAutoscalingPolicyRequest` 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 `projects.regions.autoscalingPolicies.get`, the resource name of the policy has the following format: `projects/{project_id}/regions/{region}/autoscalingPolicies/{policy_id}` - For `projects.locations.autoscalingPolicies.get`, the resource name of the policy has the following format: `projects/{project_id}/locations/{location}/autoscalingPolicies/{policy_id}` This corresponds to the `name` field on the `request` instance; if `request` is provided, this should not be set.
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.

Returns

Type	Description
google.cloud.dataproc_v1.types.AutoscalingPolicy	Describes an autoscaling policy for Dataproc cluster autoscaler.

list_autoscaling_policies

list_autoscaling_policies(request: Optional[google.cloud.dataproc_v1.types.autoscaling_policies.ListAutoscalingPoliciesRequest] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Lists autoscaling policies in the project.

Parameters

Name	Description
request	`google.cloud.dataproc_v1.types.ListAutoscalingPoliciesRequest` 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 `projects.regions.autoscalingPolicies.list`, the resource name of the region has the following format: `projects/{project_id}/regions/{region}` - For `projects.locations.autoscalingPolicies.list`, the resource name of the location has the following format: `projects/{project_id}/locations/{location}` This corresponds to the `parent` field on the `request` instance; if `request` is provided, this should not be set.
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.

Returns

Type	Description
google.cloud.dataproc_v1.services.autoscaling_policy_service.pagers.ListAutoscalingPoliciesPager	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[google.cloud.dataproc_v1.types.autoscaling_policies.UpdateAutoscalingPolicyRequest] = None, *, policy: Optional[google.cloud.dataproc_v1.types.autoscaling_policies.AutoscalingPolicy] = None, retry: google.api_core.retry.Retry = <_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.

Parameters

Name	Description
request	`google.cloud.dataproc_v1.types.UpdateAutoscalingPolicyRequest` The request object. A request to update an autoscaling policy.
policy	`google.cloud.dataproc_v1.types.AutoscalingPolicy` Required. The updated autoscaling policy. This corresponds to the `policy` field on the `request` instance; if `request` is provided, this should not be set.
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.

Returns

Type	Description
google.cloud.dataproc_v1.types.AutoscalingPolicy	Describes an autoscaling policy for Dataproc cluster autoscaler.