Constructor
new AutoscalingPolicyServiceClient(optionsopt, gaxInstanceopt)
Construct an instance of AutoscalingPolicyServiceClient.
Parameters:
Name | Type | Attributes | Description | ||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
object |
<optional> |
The configuration object. The options accepted by the constructor are described in detail in this document. The common options are: Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||
gaxInstance |
gax |
<optional> |
loaded instance of |
Members
apiEndpoint
The DNS address for this API service.
apiEndpoint
The DNS address for this API service - same as servicePath.
port
The port for this API service.
scopes
The scopes needed to make gRPC calls for every method defined in this service.
servicePath
The DNS address for this API service.
Methods
batchPath(project, location, batch) → {string}
Return a fully-qualified batch resource name string.
Parameters:
Name | Type | Description |
---|---|---|
project |
string | |
location |
string | |
batch |
string |
Returns:
Type | Description |
---|---|
string |
Resource name string. |
close() → {Promise}
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 |
A promise that resolves when the client is closed. |
getIamPolicy(request, optionsopt, callbackopt) → {Promise}
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Parameters:
Name | Type | Attributes | Description | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
request |
Object |
The request object that will be sent. Properties
|
|||||||||||||
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 Policy. |
Returns:
Type | Description |
---|---|
Promise |
|
getProjectId() → {Promise}
Return the project ID used by this class.
Returns:
Type | Description |
---|---|
Promise |
A promise that resolves to string containing the project ID. |
initialize() → {Promise}
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 |
A promise that resolves to an authenticated service stub. |
listAutoscalingPoliciesAsync(request, optionsopt) → {Object}
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 | Type | Attributes | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
request |
Object |
The request object that will be sent. Properties
|
|||||||||||||||||
options |
object |
<optional> |
Call options. See CallOptions for more details. |
Returns:
Type | Description |
---|---|
Object |
An iterable Object that allows async iteration. 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 for more details and examples. |
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* 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}`
*/
// const parent = 'abc123'
/**
* Optional. The maximum number of results to return in each response.
* Must be less than or equal to 1000. Defaults to 100.
*/
// const pageSize = 1234
/**
* Optional. The page token, returned by a previous call, to request the
* next page of results.
*/
// const pageToken = 'abc123'
// Imports the Dataproc library
const {AutoscalingPolicyServiceClient} = require('@google-cloud/dataproc').v1;
// Instantiates a client
const dataprocClient = new AutoscalingPolicyServiceClient();
async function callListAutoscalingPolicies() {
// Construct request
const request = {
parent,
};
// Run request
const iterable = dataprocClient.listAutoscalingPoliciesAsync(request);
for await (const response of iterable) {
console.log(response);
}
}
callListAutoscalingPolicies();
listAutoscalingPoliciesStream(request, optionsopt) → {Stream}
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Parameters:
Name | Type | Attributes | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
request |
Object |
The request object that will be sent. Properties
|
|||||||||||||||||
options |
object |
<optional> |
Call options. See CallOptions for more details. |
Returns:
Type | Description |
---|---|
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 |
locationPath(project, location) → {string}
Return a fully-qualified location resource name string.
Parameters:
Name | Type | Description |
---|---|---|
project |
string | |
location |
string |
Returns:
Type | Description |
---|---|
string |
Resource name string. |
matchAutoscalingPolicyFromProjectLocationAutoscalingPolicyName(projectLocationAutoscalingPolicyName) → {string}
Parse the autoscaling_policy from ProjectLocationAutoscalingPolicy resource.
Parameters:
Name | Type | Description |
---|---|---|
projectLocationAutoscalingPolicyName |
string |
A fully-qualified path representing project_location_autoscaling_policy resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the autoscaling_policy. |
matchAutoscalingPolicyFromProjectRegionAutoscalingPolicyName(projectRegionAutoscalingPolicyName) → {string}
Parse the autoscaling_policy from ProjectRegionAutoscalingPolicy resource.
Parameters:
Name | Type | Description |
---|---|---|
projectRegionAutoscalingPolicyName |
string |
A fully-qualified path representing project_region_autoscaling_policy resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the autoscaling_policy. |
matchBatchFromBatchName(batchName) → {string}
Parse the batch from Batch resource.
Parameters:
Name | Type | Description |
---|---|---|
batchName |
string |
A fully-qualified path representing Batch resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the batch. |
matchClusterFromNodeGroupName(nodeGroupName) → {string}
Parse the cluster from NodeGroup resource.
Parameters:
Name | Type | Description |
---|---|---|
nodeGroupName |
string |
A fully-qualified path representing NodeGroup resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the cluster. |
matchLocationFromBatchName(batchName) → {string}
Parse the location from Batch resource.
Parameters:
Name | Type | Description |
---|---|---|
batchName |
string |
A fully-qualified path representing Batch resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the location. |
matchLocationFromLocationName(locationName) → {string}
Parse the location from Location resource.
Parameters:
Name | Type | Description |
---|---|---|
locationName |
string |
A fully-qualified path representing Location resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the location. |
matchLocationFromProjectLocationAutoscalingPolicyName(projectLocationAutoscalingPolicyName) → {string}
Parse the location from ProjectLocationAutoscalingPolicy resource.
Parameters:
Name | Type | Description |
---|---|---|
projectLocationAutoscalingPolicyName |
string |
A fully-qualified path representing project_location_autoscaling_policy resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the location. |
matchLocationFromProjectLocationWorkflowTemplateName(projectLocationWorkflowTemplateName) → {string}
Parse the location from ProjectLocationWorkflowTemplate resource.
Parameters:
Name | Type | Description |
---|---|---|
projectLocationWorkflowTemplateName |
string |
A fully-qualified path representing project_location_workflow_template resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the location. |
matchLocationFromSessionName(sessionName) → {string}
Parse the location from Session resource.
Parameters:
Name | Type | Description |
---|---|---|
sessionName |
string |
A fully-qualified path representing Session resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the location. |
matchLocationFromSessionTemplateName(sessionTemplateName) → {string}
Parse the location from SessionTemplate resource.
Parameters:
Name | Type | Description |
---|---|---|
sessionTemplateName |
string |
A fully-qualified path representing SessionTemplate resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the location. |
matchNodeGroupFromNodeGroupName(nodeGroupName) → {string}
Parse the node_group from NodeGroup resource.
Parameters:
Name | Type | Description |
---|---|---|
nodeGroupName |
string |
A fully-qualified path representing NodeGroup resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the node_group. |
matchProjectFromBatchName(batchName) → {string}
Parse the project from Batch resource.
Parameters:
Name | Type | Description |
---|---|---|
batchName |
string |
A fully-qualified path representing Batch resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the project. |
matchProjectFromLocationName(locationName) → {string}
Parse the project from Location resource.
Parameters:
Name | Type | Description |
---|---|---|
locationName |
string |
A fully-qualified path representing Location resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the project. |
matchProjectFromNodeGroupName(nodeGroupName) → {string}
Parse the project from NodeGroup resource.
Parameters:
Name | Type | Description |
---|---|---|
nodeGroupName |
string |
A fully-qualified path representing NodeGroup resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the project. |
matchProjectFromProjectLocationAutoscalingPolicyName(projectLocationAutoscalingPolicyName) → {string}
Parse the project from ProjectLocationAutoscalingPolicy resource.
Parameters:
Name | Type | Description |
---|---|---|
projectLocationAutoscalingPolicyName |
string |
A fully-qualified path representing project_location_autoscaling_policy resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the project. |
matchProjectFromProjectLocationWorkflowTemplateName(projectLocationWorkflowTemplateName) → {string}
Parse the project from ProjectLocationWorkflowTemplate resource.
Parameters:
Name | Type | Description |
---|---|---|
projectLocationWorkflowTemplateName |
string |
A fully-qualified path representing project_location_workflow_template resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the project. |
matchProjectFromProjectName(projectName) → {string}
Parse the project from Project resource.
Parameters:
Name | Type | Description |
---|---|---|
projectName |
string |
A fully-qualified path representing Project resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the project. |
matchProjectFromProjectRegionAutoscalingPolicyName(projectRegionAutoscalingPolicyName) → {string}
Parse the project from ProjectRegionAutoscalingPolicy resource.
Parameters:
Name | Type | Description |
---|---|---|
projectRegionAutoscalingPolicyName |
string |
A fully-qualified path representing project_region_autoscaling_policy resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the project. |
matchProjectFromProjectRegionWorkflowTemplateName(projectRegionWorkflowTemplateName) → {string}
Parse the project from ProjectRegionWorkflowTemplate resource.
Parameters:
Name | Type | Description |
---|---|---|
projectRegionWorkflowTemplateName |
string |
A fully-qualified path representing project_region_workflow_template resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the project. |
matchProjectFromSessionName(sessionName) → {string}
Parse the project from Session resource.
Parameters:
Name | Type | Description |
---|---|---|
sessionName |
string |
A fully-qualified path representing Session resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the project. |
matchProjectFromSessionTemplateName(sessionTemplateName) → {string}
Parse the project from SessionTemplate resource.
Parameters:
Name | Type | Description |
---|---|---|
sessionTemplateName |
string |
A fully-qualified path representing SessionTemplate resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the project. |
matchRegionFromNodeGroupName(nodeGroupName) → {string}
Parse the region from NodeGroup resource.
Parameters:
Name | Type | Description |
---|---|---|
nodeGroupName |
string |
A fully-qualified path representing NodeGroup resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the region. |
matchRegionFromProjectRegionAutoscalingPolicyName(projectRegionAutoscalingPolicyName) → {string}
Parse the region from ProjectRegionAutoscalingPolicy resource.
Parameters:
Name | Type | Description |
---|---|---|
projectRegionAutoscalingPolicyName |
string |
A fully-qualified path representing project_region_autoscaling_policy resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the region. |
matchRegionFromProjectRegionWorkflowTemplateName(projectRegionWorkflowTemplateName) → {string}
Parse the region from ProjectRegionWorkflowTemplate resource.
Parameters:
Name | Type | Description |
---|---|---|
projectRegionWorkflowTemplateName |
string |
A fully-qualified path representing project_region_workflow_template resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the region. |
matchSessionFromSessionName(sessionName) → {string}
Parse the session from Session resource.
Parameters:
Name | Type | Description |
---|---|---|
sessionName |
string |
A fully-qualified path representing Session resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the session. |
matchTemplateFromSessionTemplateName(sessionTemplateName) → {string}
Parse the template from SessionTemplate resource.
Parameters:
Name | Type | Description |
---|---|---|
sessionTemplateName |
string |
A fully-qualified path representing SessionTemplate resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the template. |
matchWorkflowTemplateFromProjectLocationWorkflowTemplateName(projectLocationWorkflowTemplateName) → {string}
Parse the workflow_template from ProjectLocationWorkflowTemplate resource.
Parameters:
Name | Type | Description |
---|---|---|
projectLocationWorkflowTemplateName |
string |
A fully-qualified path representing project_location_workflow_template resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the workflow_template. |
matchWorkflowTemplateFromProjectRegionWorkflowTemplateName(projectRegionWorkflowTemplateName) → {string}
Parse the workflow_template from ProjectRegionWorkflowTemplate resource.
Parameters:
Name | Type | Description |
---|---|---|
projectRegionWorkflowTemplateName |
string |
A fully-qualified path representing project_region_workflow_template resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the workflow_template. |
nodeGroupPath(project, region, cluster, node_group) → {string}
Return a fully-qualified nodeGroup resource name string.
Parameters:
Name | Type | Description |
---|---|---|
project |
string | |
region |
string | |
cluster |
string | |
node_group |
string |
Returns:
Type | Description |
---|---|
string |
Resource name string. |
projectLocationAutoscalingPolicyPath(project, location, autoscaling_policy) → {string}
Return a fully-qualified projectLocationAutoscalingPolicy resource name string.
Parameters:
Name | Type | Description |
---|---|---|
project |
string | |
location |
string | |
autoscaling_policy |
string |
Returns:
Type | Description |
---|---|
string |
Resource name string. |
projectLocationWorkflowTemplatePath(project, location, workflow_template) → {string}
Return a fully-qualified projectLocationWorkflowTemplate resource name string.
Parameters:
Name | Type | Description |
---|---|---|
project |
string | |
location |
string | |
workflow_template |
string |
Returns:
Type | Description |
---|---|
string |
Resource name string. |
projectPath(project) → {string}
Return a fully-qualified project resource name string.
Parameters:
Name | Type | Description |
---|---|---|
project |
string |
Returns:
Type | Description |
---|---|
string |
Resource name string. |
projectRegionAutoscalingPolicyPath(project, region, autoscaling_policy) → {string}
Return a fully-qualified projectRegionAutoscalingPolicy resource name string.
Parameters:
Name | Type | Description |
---|---|---|
project |
string | |
region |
string | |
autoscaling_policy |
string |
Returns:
Type | Description |
---|---|
string |
Resource name string. |
projectRegionWorkflowTemplatePath(project, region, workflow_template) → {string}
Return a fully-qualified projectRegionWorkflowTemplate resource name string.
Parameters:
Name | Type | Description |
---|---|---|
project |
string | |
region |
string | |
workflow_template |
string |
Returns:
Type | Description |
---|---|
string |
Resource name string. |
sessionPath(project, location, session) → {string}
Return a fully-qualified session resource name string.
Parameters:
Name | Type | Description |
---|---|---|
project |
string | |
location |
string | |
session |
string |
Returns:
Type | Description |
---|---|
string |
Resource name string. |
sessionTemplatePath(project, location, template) → {string}
Return a fully-qualified sessionTemplate resource name string.
Parameters:
Name | Type | Description |
---|---|---|
project |
string | |
location |
string | |
template |
string |
Returns:
Type | Description |
---|---|
string |
Resource name string. |
setIamPolicy(request, optionsopt, callbackopt) → {Promise}
Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.
Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
Parameters:
Name | Type | Attributes | Description | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
request |
Object |
The request object that will be sent. Properties
|
||||||||||
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 TestIamPermissionsResponse. |
Returns:
Type | Description |
---|---|
Promise |
|
testIamPermissions(request, optionsopt, callbackopt) → {Promise}
Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.
Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
Parameters:
Name | Type | Attributes | Description | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
request |
Object |
The request object that will be sent. Properties
|
||||||||||
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 TestIamPermissionsResponse. |
Returns:
Type | Description |
---|---|
Promise |
|