Class v1.AutoscalingPolicyServiceClient (3.0.0)

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

Package

@google-cloud/dataproc!

Constructors

(constructor)(opts)

constructor(opts?: ClientOptions);

Construct an instance of AutoscalingPolicyServiceClient.

Parameter
Name Description
opts ClientOptions

Properties

apiEndpoint

static get apiEndpoint(): string;

The DNS address for this API service - same as servicePath(), exists for compatibility reasons.

Property Value
Type Description
string

auth

auth: gax.GoogleAuth;
Property Value
Type Description
gax.GoogleAuth

autoscalingPolicyServiceStub

autoscalingPolicyServiceStub?: Promise<{
        [name: string]: Function;
    }>;
Property Value
Type Description
Promise<{ [name: string]: Function; }>

descriptors

descriptors: Descriptors;
Property Value
Type Description
Descriptors

innerApiCalls

innerApiCalls: {
        [name: string]: Function;
    };
Property Value
Type Description
{ [name: string]: Function; }

pathTemplates

pathTemplates: {
        [name: string]: gax.PathTemplate;
    };
Property Value
Type Description
{ [name: string]: gax.PathTemplate; }

port

static get port(): number;

The port for this API service.

Property Value
Type Description
number

scopes

static get scopes(): string[];

The scopes needed to make gRPC calls for every method defined in this service.

Property Value
Type Description
string[]

servicePath

static get servicePath(): string;

The DNS address for this API service.

Property Value
Type Description
string

warn

warn: (code: string, message: string, warnType?: string) => void;
Property Value
Type Description
(code: string, message: string, warnType?: string) => void

Methods

close()

close(): Promise<void>;

Terminate the gRPC channel and close the client.

The client will no longer be usable and all future behavior is undefined.

Returns
Type Description
Promise<void>

{Promise} A promise that resolves when the client is closed.

createAutoscalingPolicy(request, options)

createAutoscalingPolicy(request?: protos.google.cloud.dataproc.v1.ICreateAutoscalingPolicyRequest, options?: CallOptions): Promise<[protos.google.cloud.dataproc.v1.IAutoscalingPolicy, (protos.google.cloud.dataproc.v1.ICreateAutoscalingPolicyRequest | undefined), {} | undefined]>;
Parameters
Name Description
request protos.google.cloud.dataproc.v1.ICreateAutoscalingPolicyRequest
options CallOptions
Returns
Type Description
Promise<[protos.google.cloud.dataproc.v1.IAutoscalingPolicy, (protos.google.cloud.dataproc.v1.ICreateAutoscalingPolicyRequest | undefined), {} | undefined]>

createAutoscalingPolicy(request, options, callback)

createAutoscalingPolicy(request: protos.google.cloud.dataproc.v1.ICreateAutoscalingPolicyRequest, options: CallOptions, callback: Callback<protos.google.cloud.dataproc.v1.IAutoscalingPolicy, protos.google.cloud.dataproc.v1.ICreateAutoscalingPolicyRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.dataproc.v1.ICreateAutoscalingPolicyRequest
options CallOptions
callback Callback<protos.google.cloud.dataproc.v1.IAutoscalingPolicy, protos.google.cloud.dataproc.v1.ICreateAutoscalingPolicyRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

createAutoscalingPolicy(request, callback)

createAutoscalingPolicy(request: protos.google.cloud.dataproc.v1.ICreateAutoscalingPolicyRequest, callback: Callback<protos.google.cloud.dataproc.v1.IAutoscalingPolicy, protos.google.cloud.dataproc.v1.ICreateAutoscalingPolicyRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.dataproc.v1.ICreateAutoscalingPolicyRequest
callback Callback<protos.google.cloud.dataproc.v1.IAutoscalingPolicy, protos.google.cloud.dataproc.v1.ICreateAutoscalingPolicyRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

deleteAutoscalingPolicy(request, options)

deleteAutoscalingPolicy(request?: protos.google.cloud.dataproc.v1.IDeleteAutoscalingPolicyRequest, options?: CallOptions): Promise<[protos.google.protobuf.IEmpty, (protos.google.cloud.dataproc.v1.IDeleteAutoscalingPolicyRequest | undefined), {} | undefined]>;
Parameters
Name Description
request protos.google.cloud.dataproc.v1.IDeleteAutoscalingPolicyRequest
options CallOptions
Returns
Type Description
Promise<[protos.google.protobuf.IEmpty, (protos.google.cloud.dataproc.v1.IDeleteAutoscalingPolicyRequest | undefined), {} | undefined]>

deleteAutoscalingPolicy(request, options, callback)

deleteAutoscalingPolicy(request: protos.google.cloud.dataproc.v1.IDeleteAutoscalingPolicyRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.dataproc.v1.IDeleteAutoscalingPolicyRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.dataproc.v1.IDeleteAutoscalingPolicyRequest
options CallOptions
callback Callback<protos.google.protobuf.IEmpty, protos.google.cloud.dataproc.v1.IDeleteAutoscalingPolicyRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

deleteAutoscalingPolicy(request, callback)

deleteAutoscalingPolicy(request: protos.google.cloud.dataproc.v1.IDeleteAutoscalingPolicyRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.dataproc.v1.IDeleteAutoscalingPolicyRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.dataproc.v1.IDeleteAutoscalingPolicyRequest
callback Callback<protos.google.protobuf.IEmpty, protos.google.cloud.dataproc.v1.IDeleteAutoscalingPolicyRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getAutoscalingPolicy(request, options)

getAutoscalingPolicy(request?: protos.google.cloud.dataproc.v1.IGetAutoscalingPolicyRequest, options?: CallOptions): Promise<[protos.google.cloud.dataproc.v1.IAutoscalingPolicy, protos.google.cloud.dataproc.v1.IGetAutoscalingPolicyRequest | undefined, {} | undefined]>;
Parameters
Name Description
request protos.google.cloud.dataproc.v1.IGetAutoscalingPolicyRequest
options CallOptions
Returns
Type Description
Promise<[protos.google.cloud.dataproc.v1.IAutoscalingPolicy, protos.google.cloud.dataproc.v1.IGetAutoscalingPolicyRequest | undefined, {} | undefined]>

getAutoscalingPolicy(request, options, callback)

getAutoscalingPolicy(request: protos.google.cloud.dataproc.v1.IGetAutoscalingPolicyRequest, options: CallOptions, callback: Callback<protos.google.cloud.dataproc.v1.IAutoscalingPolicy, protos.google.cloud.dataproc.v1.IGetAutoscalingPolicyRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.dataproc.v1.IGetAutoscalingPolicyRequest
options CallOptions
callback Callback<protos.google.cloud.dataproc.v1.IAutoscalingPolicy, protos.google.cloud.dataproc.v1.IGetAutoscalingPolicyRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getAutoscalingPolicy(request, callback)

getAutoscalingPolicy(request: protos.google.cloud.dataproc.v1.IGetAutoscalingPolicyRequest, callback: Callback<protos.google.cloud.dataproc.v1.IAutoscalingPolicy, protos.google.cloud.dataproc.v1.IGetAutoscalingPolicyRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.dataproc.v1.IGetAutoscalingPolicyRequest
callback Callback<protos.google.cloud.dataproc.v1.IAutoscalingPolicy, protos.google.cloud.dataproc.v1.IGetAutoscalingPolicyRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getProjectId()

getProjectId(): Promise<string>;
Returns
Type Description
Promise<string>

getProjectId(callback)

getProjectId(callback: Callback<string, undefined, undefined>): void;
Parameter
Name Description
callback Callback<string, undefined, undefined>
Returns
Type Description
void

initialize()

initialize(): Promise<{
        [name: string]: Function;
    }>;

Initialize the client. Performs asynchronous operations (such as authentication) and prepares the client. This function will be called automatically when any class method is called for the first time, but if you need to initialize it before calling an actual method, feel free to call initialize() directly.

You can await on this method if you want to make sure the client is initialized.

Returns
Type Description
Promise<{ [name: string]: Function; }>

{Promise} A promise that resolves to an authenticated service stub.

listAutoscalingPolicies(request, options)

listAutoscalingPolicies(request?: protos.google.cloud.dataproc.v1.IListAutoscalingPoliciesRequest, options?: CallOptions): Promise<[protos.google.cloud.dataproc.v1.IAutoscalingPolicy[], protos.google.cloud.dataproc.v1.IListAutoscalingPoliciesRequest | null, protos.google.cloud.dataproc.v1.IListAutoscalingPoliciesResponse]>;
Parameters
Name Description
request protos.google.cloud.dataproc.v1.IListAutoscalingPoliciesRequest
options CallOptions
Returns
Type Description
Promise<[protos.google.cloud.dataproc.v1.IAutoscalingPolicy[], protos.google.cloud.dataproc.v1.IListAutoscalingPoliciesRequest | null, protos.google.cloud.dataproc.v1.IListAutoscalingPoliciesResponse]>

listAutoscalingPolicies(request, options, callback)

listAutoscalingPolicies(request: protos.google.cloud.dataproc.v1.IListAutoscalingPoliciesRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.dataproc.v1.IListAutoscalingPoliciesRequest, protos.google.cloud.dataproc.v1.IListAutoscalingPoliciesResponse | null | undefined, protos.google.cloud.dataproc.v1.IAutoscalingPolicy>): void;
Parameters
Name Description
request protos.google.cloud.dataproc.v1.IListAutoscalingPoliciesRequest
options CallOptions
callback PaginationCallback<protos.google.cloud.dataproc.v1.IListAutoscalingPoliciesRequest, protos.google.cloud.dataproc.v1.IListAutoscalingPoliciesResponse | null | undefined, protos.google.cloud.dataproc.v1.IAutoscalingPolicy>
Returns
Type Description
void

listAutoscalingPolicies(request, callback)

listAutoscalingPolicies(request: protos.google.cloud.dataproc.v1.IListAutoscalingPoliciesRequest, callback: PaginationCallback<protos.google.cloud.dataproc.v1.IListAutoscalingPoliciesRequest, protos.google.cloud.dataproc.v1.IListAutoscalingPoliciesResponse | null | undefined, protos.google.cloud.dataproc.v1.IAutoscalingPolicy>): void;
Parameters
Name Description
request protos.google.cloud.dataproc.v1.IListAutoscalingPoliciesRequest
callback PaginationCallback<protos.google.cloud.dataproc.v1.IListAutoscalingPoliciesRequest, protos.google.cloud.dataproc.v1.IListAutoscalingPoliciesResponse | null | undefined, protos.google.cloud.dataproc.v1.IAutoscalingPolicy>
Returns
Type Description
void

listAutoscalingPoliciesAsync(request, options)

listAutoscalingPoliciesAsync(request?: protos.google.cloud.dataproc.v1.IListAutoscalingPoliciesRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.dataproc.v1.IAutoscalingPolicy>;

Equivalent to listAutoscalingPolicies, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters
Name Description
request protos.google.cloud.dataproc.v1.IListAutoscalingPoliciesRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
AsyncIterable<protos.google.cloud.dataproc.v1.IAutoscalingPolicy>

{Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing [AutoscalingPolicy]. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listAutoscalingPoliciesStream(request, options)

listAutoscalingPoliciesStream(request?: protos.google.cloud.dataproc.v1.IListAutoscalingPoliciesRequest, options?: CallOptions): Transform;

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters
Name Description
request protos.google.cloud.dataproc.v1.IListAutoscalingPoliciesRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
Transform

{Stream} An object stream which emits an object representing [AutoscalingPolicy] on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listAutoscalingPoliciesAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

locationPath(project, location)

locationPath(project: string, location: string): string;

Return a fully-qualified location resource name string.

Parameters
Name Description
project string
location string
Returns
Type Description
string

{string} Resource name string.

matchAutoscalingPolicyFromProjectLocationAutoscalingPolicyName(projectLocationAutoscalingPolicyName)

matchAutoscalingPolicyFromProjectLocationAutoscalingPolicyName(projectLocationAutoscalingPolicyName: string): string | number;

Parse the autoscaling_policy from ProjectLocationAutoscalingPolicy resource.

Parameter
Name Description
projectLocationAutoscalingPolicyName string

A fully-qualified path representing project_location_autoscaling_policy resource.
Returns
Type Description
string | number

{string} A string representing the autoscaling_policy.

matchAutoscalingPolicyFromProjectRegionAutoscalingPolicyName(projectRegionAutoscalingPolicyName)

matchAutoscalingPolicyFromProjectRegionAutoscalingPolicyName(projectRegionAutoscalingPolicyName: string): string | number;

Parse the autoscaling_policy from ProjectRegionAutoscalingPolicy resource.

Parameter
Name Description
projectRegionAutoscalingPolicyName string

A fully-qualified path representing project_region_autoscaling_policy resource.
Returns
Type Description
string | number

{string} A string representing the autoscaling_policy.

matchLocationFromLocationName(locationName)

matchLocationFromLocationName(locationName: string): string | number;

Parse the location from Location resource.

Parameter
Name Description
locationName string

A fully-qualified path representing Location resource.
Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromProjectLocationAutoscalingPolicyName(projectLocationAutoscalingPolicyName)

matchLocationFromProjectLocationAutoscalingPolicyName(projectLocationAutoscalingPolicyName: string): string | number;

Parse the location from ProjectLocationAutoscalingPolicy resource.

Parameter
Name Description
projectLocationAutoscalingPolicyName string

A fully-qualified path representing project_location_autoscaling_policy resource.
Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromProjectLocationWorkflowTemplateName(projectLocationWorkflowTemplateName)

matchLocationFromProjectLocationWorkflowTemplateName(projectLocationWorkflowTemplateName: string): string | number;

Parse the location from ProjectLocationWorkflowTemplate resource.

Parameter
Name Description
projectLocationWorkflowTemplateName string

A fully-qualified path representing project_location_workflow_template resource.
Returns
Type Description
string | number

{string} A string representing the location.

matchProjectFromLocationName(locationName)

matchProjectFromLocationName(locationName: string): string | number;

Parse the project from Location resource.

Parameter
Name Description
locationName string

A fully-qualified path representing Location resource.
Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromProjectLocationAutoscalingPolicyName(projectLocationAutoscalingPolicyName)

matchProjectFromProjectLocationAutoscalingPolicyName(projectLocationAutoscalingPolicyName: string): string | number;

Parse the project from ProjectLocationAutoscalingPolicy resource.

Parameter
Name Description
projectLocationAutoscalingPolicyName string

A fully-qualified path representing project_location_autoscaling_policy resource.
Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromProjectLocationWorkflowTemplateName(projectLocationWorkflowTemplateName)

matchProjectFromProjectLocationWorkflowTemplateName(projectLocationWorkflowTemplateName: string): string | number;

Parse the project from ProjectLocationWorkflowTemplate resource.

Parameter
Name Description
projectLocationWorkflowTemplateName string

A fully-qualified path representing project_location_workflow_template resource.
Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromProjectName(projectName)

matchProjectFromProjectName(projectName: string): string | number;

Parse the project from Project resource.

Parameter
Name Description
projectName string

A fully-qualified path representing Project resource.
Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromProjectRegionAutoscalingPolicyName(projectRegionAutoscalingPolicyName)

matchProjectFromProjectRegionAutoscalingPolicyName(projectRegionAutoscalingPolicyName: string): string | number;

Parse the project from ProjectRegionAutoscalingPolicy resource.

Parameter
Name Description
projectRegionAutoscalingPolicyName string

A fully-qualified path representing project_region_autoscaling_policy resource.
Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromProjectRegionWorkflowTemplateName(projectRegionWorkflowTemplateName)

matchProjectFromProjectRegionWorkflowTemplateName(projectRegionWorkflowTemplateName: string): string | number;

Parse the project from ProjectRegionWorkflowTemplate resource.

Parameter
Name Description
projectRegionWorkflowTemplateName string

A fully-qualified path representing project_region_workflow_template resource.
Returns
Type Description
string | number

{string} A string representing the project.

matchRegionFromProjectRegionAutoscalingPolicyName(projectRegionAutoscalingPolicyName)

matchRegionFromProjectRegionAutoscalingPolicyName(projectRegionAutoscalingPolicyName: string): string | number;

Parse the region from ProjectRegionAutoscalingPolicy resource.

Parameter
Name Description
projectRegionAutoscalingPolicyName string

A fully-qualified path representing project_region_autoscaling_policy resource.
Returns
Type Description
string | number

{string} A string representing the region.

matchRegionFromProjectRegionWorkflowTemplateName(projectRegionWorkflowTemplateName)

matchRegionFromProjectRegionWorkflowTemplateName(projectRegionWorkflowTemplateName: string): string | number;

Parse the region from ProjectRegionWorkflowTemplate resource.

Parameter
Name Description
projectRegionWorkflowTemplateName string

A fully-qualified path representing project_region_workflow_template resource.
Returns
Type Description
string | number

{string} A string representing the region.

matchWorkflowTemplateFromProjectLocationWorkflowTemplateName(projectLocationWorkflowTemplateName)

matchWorkflowTemplateFromProjectLocationWorkflowTemplateName(projectLocationWorkflowTemplateName: string): string | number;

Parse the workflow_template from ProjectLocationWorkflowTemplate resource.

Parameter
Name Description
projectLocationWorkflowTemplateName string

A fully-qualified path representing project_location_workflow_template resource.
Returns
Type Description
string | number

{string} A string representing the workflow_template.

matchWorkflowTemplateFromProjectRegionWorkflowTemplateName(projectRegionWorkflowTemplateName)

matchWorkflowTemplateFromProjectRegionWorkflowTemplateName(projectRegionWorkflowTemplateName: string): string | number;

Parse the workflow_template from ProjectRegionWorkflowTemplate resource.

Parameter
Name Description
projectRegionWorkflowTemplateName string

A fully-qualified path representing project_region_workflow_template resource.
Returns
Type Description
string | number

{string} A string representing the workflow_template.

projectLocationAutoscalingPolicyPath(project, location, autoscalingPolicy)

projectLocationAutoscalingPolicyPath(project: string, location: string, autoscalingPolicy: string): string;

Return a fully-qualified projectLocationAutoscalingPolicy resource name string.

Parameters
Name Description
project string
location string
autoscalingPolicy string
Returns
Type Description
string

{string} Resource name string.

projectLocationWorkflowTemplatePath(project, location, workflowTemplate)

projectLocationWorkflowTemplatePath(project: string, location: string, workflowTemplate: string): string;

Return a fully-qualified projectLocationWorkflowTemplate resource name string.

Parameters
Name Description
project string
location string
workflowTemplate string
Returns
Type Description
string

{string} Resource name string.

projectPath(project)

projectPath(project: string): string;

Return a fully-qualified project resource name string.

Parameter
Name Description
project string
Returns
Type Description
string

{string} Resource name string.

projectRegionAutoscalingPolicyPath(project, region, autoscalingPolicy)

projectRegionAutoscalingPolicyPath(project: string, region: string, autoscalingPolicy: string): string;

Return a fully-qualified projectRegionAutoscalingPolicy resource name string.

Parameters
Name Description
project string
region string
autoscalingPolicy string
Returns
Type Description
string

{string} Resource name string.

projectRegionWorkflowTemplatePath(project, region, workflowTemplate)

projectRegionWorkflowTemplatePath(project: string, region: string, workflowTemplate: string): string;

Return a fully-qualified projectRegionWorkflowTemplate resource name string.

Parameters
Name Description
project string
region string
workflowTemplate string
Returns
Type Description
string

{string} Resource name string.

updateAutoscalingPolicy(request, options)

updateAutoscalingPolicy(request?: protos.google.cloud.dataproc.v1.IUpdateAutoscalingPolicyRequest, options?: CallOptions): Promise<[protos.google.cloud.dataproc.v1.IAutoscalingPolicy, (protos.google.cloud.dataproc.v1.IUpdateAutoscalingPolicyRequest | undefined), {} | undefined]>;
Parameters
Name Description
request protos.google.cloud.dataproc.v1.IUpdateAutoscalingPolicyRequest
options CallOptions
Returns
Type Description
Promise<[protos.google.cloud.dataproc.v1.IAutoscalingPolicy, (protos.google.cloud.dataproc.v1.IUpdateAutoscalingPolicyRequest | undefined), {} | undefined]>

updateAutoscalingPolicy(request, options, callback)

updateAutoscalingPolicy(request: protos.google.cloud.dataproc.v1.IUpdateAutoscalingPolicyRequest, options: CallOptions, callback: Callback<protos.google.cloud.dataproc.v1.IAutoscalingPolicy, protos.google.cloud.dataproc.v1.IUpdateAutoscalingPolicyRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.dataproc.v1.IUpdateAutoscalingPolicyRequest
options CallOptions
callback Callback<protos.google.cloud.dataproc.v1.IAutoscalingPolicy, protos.google.cloud.dataproc.v1.IUpdateAutoscalingPolicyRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

updateAutoscalingPolicy(request, callback)

updateAutoscalingPolicy(request: protos.google.cloud.dataproc.v1.IUpdateAutoscalingPolicyRequest, callback: Callback<protos.google.cloud.dataproc.v1.IAutoscalingPolicy, protos.google.cloud.dataproc.v1.IUpdateAutoscalingPolicyRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.dataproc.v1.IUpdateAutoscalingPolicyRequest
callback Callback<protos.google.cloud.dataproc.v1.IAutoscalingPolicy, protos.google.cloud.dataproc.v1.IUpdateAutoscalingPolicyRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void