Class AutoscalingPolicyServiceClient (2.0.2)

AutoscalingPolicyServiceClient(*, credentials: google.auth.credentials.Credentials = None, transport: Union[str, google.cloud.dataproc_v1beta2.services.autoscaling_policy_service.transports.base.AutoscalingPolicyServiceTransport] = None, client_options: <module 'google.api_core.client_options' from '/workspace/python-dataproc/.nox/docfx/lib/python3.9/site-packages/google/api_core/client_options.py'> = None)

The API interface for managing autoscaling policies in the Cloud Dataproc API.

Methods

AutoscalingPolicyServiceClient

AutoscalingPolicyServiceClient(*, credentials: google.auth.credentials.Credentials = None, transport: Union[str, google.cloud.dataproc_v1beta2.services.autoscaling_policy_service.transports.base.AutoscalingPolicyServiceTransport] = None, client_options: <module 'google.api_core.client_options' from '/workspace/python-dataproc/.nox/docfx/lib/python3.9/site-packages/google/api_core/client_options.py'> = None)

Instantiate 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`	`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 environment variable can also be used to override the endpoint: "always" (always use the default mTLS endpoint), "never" (always use the default regular endpoint, this is the default value for the environment variable) and "auto" (auto switch to the default mTLS endpoint if client SSL credentials is present). However, the `api_endpoint` property takes precedence if provided. (2) The `client_cert_source` property is used to provide client SSL credentials for mutual TLS transport. If not provided, the default SSL credentials will be used if present.

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)

Return a fully-qualified autoscaling_policy string.

create_autoscaling_policy

create_autoscaling_policy(request: Optional[google.cloud.dataproc_v1beta2.types.autoscaling_policies.CreateAutoscalingPolicyRequest] = None, *, parent: Optional[str] = None, policy: Optional[google.cloud.dataproc_v1beta2.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`	`.autoscaling_policies.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 has the following format: `projects/{project_id}/regions/{region}` - For `projects.locations.autoscalingPolicies.create`, the resource name 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`	`.autoscaling_policies.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
`.autoscaling_policies.AutoscalingPolicy`	Describes an autoscaling policy for Dataproc cluster autoscaler.

delete_autoscaling_policy

delete_autoscaling_policy(request: Optional[google.cloud.dataproc_v1beta2.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`	`.autoscaling_policies.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
`{@api.name}`	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
`{@api.name}`	The constructed client.

get_autoscaling_policy

get_autoscaling_policy(request: Optional[google.cloud.dataproc_v1beta2.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`	`.autoscaling_policies.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
`.autoscaling_policies.AutoscalingPolicy`	Describes an autoscaling policy for Dataproc cluster autoscaler.

list_autoscaling_policies

list_autoscaling_policies(request: Optional[google.cloud.dataproc_v1beta2.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`	`.autoscaling_policies.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
`.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)

Parse a autoscaling_policy path into its component segments.

update_autoscaling_policy

update_autoscaling_policy(request: Optional[google.cloud.dataproc_v1beta2.types.autoscaling_policies.UpdateAutoscalingPolicyRequest] = None, *, policy: Optional[google.cloud.dataproc_v1beta2.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`	`.autoscaling_policies.UpdateAutoscalingPolicyRequest` The request object. A request to update an autoscaling policy.
`policy`	`.autoscaling_policies.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
`.autoscaling_policies.AutoscalingPolicy`	Describes an autoscaling policy for Dataproc cluster autoscaler.