AutoscalingPolicyServiceClient

AutoscalingPolicyServiceClient

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

Constructor

new AutoscalingPolicyServiceClient(optionsopt)

Construct an instance of AutoscalingPolicyServiceClient.

Parameters:
Name Type Attributes Description
options object <optional>

The configuration object. See the subsequent parameters for more details.

Properties
Name Type Attributes Description
credentials object <optional>

Credentials object.

Properties
Name Type Attributes Description
client_email string <optional>
private_key string <optional>
email string <optional>

Account email address. Required when using a .pem or .p12 keyFilename.
keyFilename string <optional>

Full path to the a .json, .pem, or .p12 key downloaded from the Google Developers Console. If you provide a path to a JSON file, the projectId option below is not necessary. NOTE: .pem and .p12 require you to specify options.email as well.
port number <optional>

The port on which to connect to the remote host.
projectId string <optional>

The project ID from the Google Developer's Console, e.g. 'grape-spaceship-123'. We will also check the environment variable GCLOUD_PROJECT for your project ID. If your app is running in an environment which supports Application Default Credentials, your project ID will be detected automatically.
promise function <optional>

Custom promise module to use instead of native Promises.
apiEndpoint string <optional>

The domain name of the API remote host.
Source:

Members

(static) apiEndpoint

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

Source:

(static) port

The port for this API service.

Source:

(static) scopes

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

Source:

(static) servicePath

The DNS address for this API service.

Source:

Methods

autoscalingPolicyPath(project, region, autoscalingPolicy) → {String}

Return a fully-qualified autoscaling_policy resource name string.

Parameters:
Name Type Description
project String
region String
autoscalingPolicy String
Source:

createAutoscalingPolicy(request, optionsopt, callbackopt) → {Promise}

Creates new autoscaling policy.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
parent string

Required. The "resource name" of the region, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}.
policy Object

The autoscaling policy to create.

This object should have the same structure as AutoscalingPolicy
options Object <optional>

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
callback function <optional>

The function which will be called with the result of the API call.

The second parameter to the callback is an object representing AutoscalingPolicy.
Source:
Example
const dataproc = require('@google-cloud/dataproc');

const client = new dataproc.v1beta2.AutoscalingPolicyServiceClient({
  // optional auth parameters.
});

const formattedParent = client.regionPath('[PROJECT]', '[REGION]');
const policy = {};
const request = {
  parent: formattedParent,
  policy: policy,
};
client.createAutoscalingPolicy(request)
  .then(responses => {
    const response = responses[0];
    // doThingsWith(response)
  })
  .catch(err => {
    console.error(err);
  });

deleteAutoscalingPolicy(request, optionsopt, callbackopt) → {Promise}

Deletes an autoscaling policy. It is an error to delete an autoscaling policy that is in use by one or more clusters.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
name string

Required. The "resource name" of the autoscaling policy, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}/autoscalingPolicies/{policy_id}.
options Object <optional>

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
callback function <optional>

The function which will be called with the result of the API call.
Source:
Example
const dataproc = require('@google-cloud/dataproc');

const client = new dataproc.v1beta2.AutoscalingPolicyServiceClient({
  // optional auth parameters.
});

const formattedName = client.autoscalingPolicyPath('[PROJECT]', '[REGION]', '[AUTOSCALING_POLICY]');
client.deleteAutoscalingPolicy({name: formattedName}).catch(err => {
  console.error(err);
});

getAutoscalingPolicy(request, optionsopt, callbackopt) → {Promise}

Retrieves autoscaling policy.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
name string

Required. The "resource name" of the autoscaling policy, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}/autoscalingPolicies/{policy_id}.
options Object <optional>

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
callback function <optional>

The function which will be called with the result of the API call.

The second parameter to the callback is an object representing AutoscalingPolicy.
Source:
Example
const dataproc = require('@google-cloud/dataproc');

const client = new dataproc.v1beta2.AutoscalingPolicyServiceClient({
  // optional auth parameters.
});

const formattedName = client.autoscalingPolicyPath('[PROJECT]', '[REGION]', '[AUTOSCALING_POLICY]');
client.getAutoscalingPolicy({name: formattedName})
  .then(responses => {
    const response = responses[0];
    // doThingsWith(response)
  })
  .catch(err => {
    console.error(err);
  });

getProjectId(callback)

Return the project ID used by this class.

Parameters:
Name Type Description
callback function

the callback to be called with the current project Id.
Source:

listAutoscalingPolicies(request, optionsopt, callbackopt) → {Promise}

Lists autoscaling policies in the project.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Attributes Description
parent string

Required. The "resource name" of the region, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}
pageSize number <optional>

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.
options Object <optional>

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
callback function <optional>

The function which will be called with the result of the API call.

The second parameter to the callback is Array of AutoscalingPolicy.

When autoPaginate: false is specified through options, it contains the result in a single response. If the response indicates the next page exists, the third parameter is set to be used for the next request object. The fourth parameter keeps the raw response object of an object representing ListAutoscalingPoliciesResponse.
Source:
Example
const dataproc = require('@google-cloud/dataproc');

const client = new dataproc.v1beta2.AutoscalingPolicyServiceClient({
  // optional auth parameters.
});

// Iterate over all elements.
const formattedParent = client.regionPath('[PROJECT]', '[REGION]');

client.listAutoscalingPolicies({parent: formattedParent})
  .then(responses => {
    const resources = responses[0];
    for (const resource of resources) {
      // doThingsWith(resource)
    }
  })
  .catch(err => {
    console.error(err);
  });

// Or obtain the paged response.
const formattedParent = client.regionPath('[PROJECT]', '[REGION]');


const options = {autoPaginate: false};
const callback = responses => {
  // The actual resources in a response.
  const resources = responses[0];
  // The next request if the response shows that there are more responses.
  const nextRequest = responses[1];
  // The actual response object, if necessary.
  // const rawResponse = responses[2];
  for (const resource of resources) {
    // doThingsWith(resource);
  }
  if (nextRequest) {
    // Fetch the next page.
    return client.listAutoscalingPolicies(nextRequest, options).then(callback);
  }
}
client.listAutoscalingPolicies({parent: formattedParent}, options)
  .then(callback)
  .catch(err => {
    console.error(err);
  });

listAutoscalingPoliciesStream(request, optionsopt) → {Stream}

Equivalent to listAutoscalingPolicies, but returns a NodeJS Stream object.

This fetches the paged responses for listAutoscalingPolicies continuously and invokes the callback registered for 'data' event for each element in the responses.

The returned object has 'end' method when no more elements are required.

autoPaginate option will be ignored.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Attributes Description
parent string

Required. The "resource name" of the region, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}
pageSize number <optional>

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.
options Object <optional>

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
Source:
See:
Example
const dataproc = require('@google-cloud/dataproc');

const client = new dataproc.v1beta2.AutoscalingPolicyServiceClient({
  // optional auth parameters.
});

const formattedParent = client.regionPath('[PROJECT]', '[REGION]');
client.listAutoscalingPoliciesStream({parent: formattedParent})
  .on('data', element => {
    // doThingsWith(element)
  }).on('error', err => {
    console.log(err);
  });

matchAutoscalingPolicyFromAutoscalingPolicyName(autoscalingPolicyName) → {String}

Parse the autoscalingPolicyName from a autoscaling_policy resource.

Parameters:
Name Type Description
autoscalingPolicyName String

A fully-qualified path representing a autoscaling_policy resources.
Source:

matchProjectFromAutoscalingPolicyName(autoscalingPolicyName) → {String}

Parse the autoscalingPolicyName from a autoscaling_policy resource.

Parameters:
Name Type Description
autoscalingPolicyName String

A fully-qualified path representing a autoscaling_policy resources.
Source:

matchProjectFromRegionName(regionName) → {String}

Parse the regionName from a region resource.

Parameters:
Name Type Description
regionName String

A fully-qualified path representing a region resources.
Source:

matchRegionFromAutoscalingPolicyName(autoscalingPolicyName) → {String}

Parse the autoscalingPolicyName from a autoscaling_policy resource.

Parameters:
Name Type Description
autoscalingPolicyName String

A fully-qualified path representing a autoscaling_policy resources.
Source:

matchRegionFromRegionName(regionName) → {String}

Parse the regionName from a region resource.

Parameters:
Name Type Description
regionName String

A fully-qualified path representing a region resources.
Source:

regionPath(project, region) → {String}

Return a fully-qualified region resource name string.

Parameters:
Name Type Description
project String
region String
Source:

updateAutoscalingPolicy(request, optionsopt, callbackopt) → {Promise}

Updates (replaces) autoscaling policy.

Disabled check for update_mask, because all updates will be full replacements.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
policy Object

Required. The updated autoscaling policy.

This object should have the same structure as AutoscalingPolicy
options Object <optional>

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
callback function <optional>

The function which will be called with the result of the API call.

The second parameter to the callback is an object representing AutoscalingPolicy.
Source:
Example
const dataproc = require('@google-cloud/dataproc');

const client = new dataproc.v1beta2.AutoscalingPolicyServiceClient({
  // optional auth parameters.
});

const policy = {};
client.updateAutoscalingPolicy({policy: policy})
  .then(responses => {
    const response = responses[0];
    // doThingsWith(response)
  })
  .catch(err => {
    console.error(err);
  });