Send feedback
Class v1.ClusterControllerClient (2.4.4) Stay organized with collections
Save and categorize content based on your preferences.
Version 2.4.4 keyboard_arrow_down
The ClusterControllerService provides methods to manage clusters of Compute Engine instances. v1
Package
@google-cloud/dataproc!
Constructors
(constructor)(opts)
constructor
(
opts
?:
ClientOptions
);
Construct an instance of ClusterControllerClient.
Parameter
Properties
apiEndpoint
static
get
apiEndpoint
()
:
string
;
The DNS address for this API service - same as servicePath(), exists for compatibility reasons.
Property Value
auth
auth
:
gax
.
GoogleAuth
;
Property Value
clusterControllerStub
clusterControllerStub
?:
Promise
< {
[
name
:
string
]
:
Function
;
}>;
Property Value
descriptors
descriptors
:
Descriptors
;
Property Value
innerApiCalls
innerApiCalls
:
{
[
name
:
string
]
:
Function
;
};
Property Value
operationsClient
operationsClient
:
gax
.
OperationsClient
;
Property Value
pathTemplates
pathTemplates
:
{
[
name
:
string
]
:
gax
.
PathTemplate
;
};
Property Value
port
static
get
port
()
:
number
;
The port for this API service.
Property Value
scopes
static
get
scopes
()
:
string
[];
The scopes needed to make gRPC calls for every method defined in this service.
Property Value
servicePath
static
get
servicePath
()
:
string
;
The DNS address for this API service.
Property Value
warn
warn
:
(
code
:
string
,
message
:
string
,
warnType
?:
string
)
=
>
void
;
Property Value
Methods
checkCreateClusterProgress(name)
checkCreateClusterProgress
(
name
:
string
)
:
Promise<LROperation<protos
.
google
.
cloud
.
dataproc
.
v1
.
Cluster
,
protos
.
google
.
cloud
.
dataproc
.
v1
.
ClusterOperationMetadata
>> ;
Check the status of the long running operation returned by createCluster()
.
Parameter Name
Description
name
string
The operation name that will be passed.
Returns Type
Description
Promise
< LROperation
<protos. google.cloud.dataproc.v1.Cluster
, protos. google.cloud.dataproc.v1.ClusterOperationMetadata
>>
{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.
checkDeleteClusterProgress(name)
checkDeleteClusterProgress
(
name
:
string
)
:
Promise<LROperation<protos
.
google
.
protobuf
.
Empty
,
protos
.
google
.
cloud
.
dataproc
.
v1
.
ClusterOperationMetadata
>> ;
Check the status of the long running operation returned by deleteCluster()
.
Parameter Name
Description
name
string
The operation name that will be passed.
Returns Type
Description
Promise
< LROperation
<protos. google.protobuf.Empty
, protos. google.cloud.dataproc.v1.ClusterOperationMetadata
>>
{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.
checkDiagnoseClusterProgress(name)
checkDiagnoseClusterProgress
(
name
:
string
)
:
Promise<LROperation<protos
.
google
.
cloud
.
dataproc
.
v1
.
DiagnoseClusterResults
,
protos
.
google
.
cloud
.
dataproc
.
v1
.
ClusterOperationMetadata
>> ;
Check the status of the long running operation returned by diagnoseCluster()
.
Parameter Name
Description
name
string
The operation name that will be passed.
Returns Type
Description
Promise
< LROperation
<protos. google.cloud.dataproc.v1.DiagnoseClusterResults
, protos. google.cloud.dataproc.v1.ClusterOperationMetadata
>>
{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.
checkStartClusterProgress(name)
checkStartClusterProgress
(
name
:
string
)
:
Promise<LROperation<protos
.
google
.
cloud
.
dataproc
.
v1
.
Cluster
,
protos
.
google
.
cloud
.
dataproc
.
v1
.
ClusterOperationMetadata
>> ;
Check the status of the long running operation returned by startCluster()
.
Parameter Name
Description
name
string
The operation name that will be passed.
Returns Type
Description
Promise
< LROperation
<protos. google.cloud.dataproc.v1.Cluster
, protos. google.cloud.dataproc.v1.ClusterOperationMetadata
>>
{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.
checkStopClusterProgress(name)
checkStopClusterProgress
(
name
:
string
)
:
Promise<LROperation<protos
.
google
.
cloud
.
dataproc
.
v1
.
Cluster
,
protos
.
google
.
cloud
.
dataproc
.
v1
.
ClusterOperationMetadata
>> ;
Check the status of the long running operation returned by stopCluster()
.
Parameter Name
Description
name
string
The operation name that will be passed.
Returns Type
Description
Promise
< LROperation
<protos. google.cloud.dataproc.v1.Cluster
, protos. google.cloud.dataproc.v1.ClusterOperationMetadata
>>
{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.
checkUpdateClusterProgress(name)
checkUpdateClusterProgress
(
name
:
string
)
:
Promise<LROperation<protos
.
google
.
cloud
.
dataproc
.
v1
.
Cluster
,
protos
.
google
.
cloud
.
dataproc
.
v1
.
ClusterOperationMetadata
>> ;
Check the status of the long running operation returned by updateCluster()
.
Parameter Name
Description
name
string
The operation name that will be passed.
Returns Type
Description
Promise
< LROperation
<protos. google.cloud.dataproc.v1.Cluster
, protos. google.cloud.dataproc.v1.ClusterOperationMetadata
>>
{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.
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.
createCluster(request, options)
createCluster
(
request
?:
protos
.
google
.
cloud
.
dataproc
.
v1
.
ICreateClusterRequest
,
options
?:
CallOptions
)
:
Promise
< [
LROperation<protos
.
google
.
cloud
.
dataproc
.
v1
.
ICluster
,
protos
.
google
.
cloud
.
dataproc
.
v1
.
IClusterOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
undefined
,
{}
|
undefined
]>;
Parameters Name
Description
request
protos. google.cloud.dataproc.v1.ICreateClusterRequest
options
CallOptions
Returns
createCluster(request, options, callback)
createCluster
(
request
:
protos
.
google
.
cloud
.
dataproc
.
v1
.
ICreateClusterRequest
,
options
:
CallOptions
,
callback
:
Callback<LROperation<protos
.
google
.
cloud
.
dataproc
.
v1
.
ICluster
,
protos
.
google
.
cloud
.
dataproc
.
v1
.
IClusterOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters Name
Description
request
protos. google.cloud.dataproc.v1.ICreateClusterRequest
options
CallOptions
callback
Callback
< LROperation
<protos. google.cloud.dataproc.v1.ICluster
, protos. google.cloud.dataproc.v1.IClusterOperationMetadata
>, protos. google.longrunning.IOperation
| null | undefined, {} | null | undefined>
Returns
createCluster(request, callback)
createCluster
(
request
:
protos
.
google
.
cloud
.
dataproc
.
v1
.
ICreateClusterRequest
,
callback
:
Callback<LROperation<protos
.
google
.
cloud
.
dataproc
.
v1
.
ICluster
,
protos
.
google
.
cloud
.
dataproc
.
v1
.
IClusterOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters Name
Description
request
protos. google.cloud.dataproc.v1.ICreateClusterRequest
callback
Callback
< LROperation
<protos. google.cloud.dataproc.v1.ICluster
, protos. google.cloud.dataproc.v1.IClusterOperationMetadata
>, protos. google.longrunning.IOperation
| null | undefined, {} | null | undefined>
Returns
deleteCluster(request, options)
deleteCluster
(
request
?:
protos
.
google
.
cloud
.
dataproc
.
v1
.
IDeleteClusterRequest
,
options
?:
CallOptions
)
:
Promise
< [
LROperation<protos
.
google
.
protobuf
.
IEmpty
,
protos
.
google
.
cloud
.
dataproc
.
v1
.
IClusterOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
undefined
,
{}
|
undefined
]>;
Parameters Name
Description
request
protos. google.cloud.dataproc.v1.IDeleteClusterRequest
options
CallOptions
Returns
deleteCluster(request, options, callback)
deleteCluster
(
request
:
protos
.
google
.
cloud
.
dataproc
.
v1
.
IDeleteClusterRequest
,
options
:
CallOptions
,
callback
:
Callback<LROperation<protos
.
google
.
protobuf
.
IEmpty
,
protos
.
google
.
cloud
.
dataproc
.
v1
.
IClusterOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters Name
Description
request
protos. google.cloud.dataproc.v1.IDeleteClusterRequest
options
CallOptions
callback
Callback
< LROperation
<protos. google.protobuf.IEmpty
, protos. google.cloud.dataproc.v1.IClusterOperationMetadata
>, protos. google.longrunning.IOperation
| null | undefined, {} | null | undefined>
Returns
deleteCluster(request, callback)
deleteCluster
(
request
:
protos
.
google
.
cloud
.
dataproc
.
v1
.
IDeleteClusterRequest
,
callback
:
Callback<LROperation<protos
.
google
.
protobuf
.
IEmpty
,
protos
.
google
.
cloud
.
dataproc
.
v1
.
IClusterOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters Name
Description
request
protos. google.cloud.dataproc.v1.IDeleteClusterRequest
callback
Callback
< LROperation
<protos. google.protobuf.IEmpty
, protos. google.cloud.dataproc.v1.IClusterOperationMetadata
>, protos. google.longrunning.IOperation
| null | undefined, {} | null | undefined>
Returns
diagnoseCluster(request, options)
diagnoseCluster
(
request
?:
protos
.
google
.
cloud
.
dataproc
.
v1
.
IDiagnoseClusterRequest
,
options
?:
CallOptions
)
:
Promise
< [
LROperation<protos
.
google
.
cloud
.
dataproc
.
v1
.
IDiagnoseClusterResults
,
protos
.
google
.
cloud
.
dataproc
.
v1
.
IClusterOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
undefined
,
{}
|
undefined
]>;
Parameters Name
Description
request
protos. google.cloud.dataproc.v1.IDiagnoseClusterRequest
options
CallOptions
Returns
diagnoseCluster(request, options, callback)
diagnoseCluster
(
request
:
protos
.
google
.
cloud
.
dataproc
.
v1
.
IDiagnoseClusterRequest
,
options
:
CallOptions
,
callback
:
Callback<LROperation<protos
.
google
.
cloud
.
dataproc
.
v1
.
IDiagnoseClusterResults
,
protos
.
google
.
cloud
.
dataproc
.
v1
.
IClusterOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters Name
Description
request
protos. google.cloud.dataproc.v1.IDiagnoseClusterRequest
options
CallOptions
callback
Callback
< LROperation
<protos. google.cloud.dataproc.v1.IDiagnoseClusterResults
, protos. google.cloud.dataproc.v1.IClusterOperationMetadata
>, protos. google.longrunning.IOperation
| null | undefined, {} | null | undefined>
Returns
diagnoseCluster(request, callback)
diagnoseCluster
(
request
:
protos
.
google
.
cloud
.
dataproc
.
v1
.
IDiagnoseClusterRequest
,
callback
:
Callback<LROperation<protos
.
google
.
cloud
.
dataproc
.
v1
.
IDiagnoseClusterResults
,
protos
.
google
.
cloud
.
dataproc
.
v1
.
IClusterOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters Name
Description
request
protos. google.cloud.dataproc.v1.IDiagnoseClusterRequest
callback
Callback
< LROperation
<protos. google.cloud.dataproc.v1.IDiagnoseClusterResults
, protos. google.cloud.dataproc.v1.IClusterOperationMetadata
>, protos. google.longrunning.IOperation
| null | undefined, {} | null | undefined>
Returns
getCluster(request, options)
getCluster
(
request
?:
protos
.
google
.
cloud
.
dataproc
.
v1
.
IGetClusterRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
dataproc
.
v1
.
ICluster
,
protos
.
google
.
cloud
.
dataproc
.
v1
.
IGetClusterRequest
|
undefined
,
{}
|
undefined
]>;
Parameters Name
Description
request
protos. google.cloud.dataproc.v1.IGetClusterRequest
options
CallOptions
Returns
getCluster(request, options, callback)
getCluster
(
request
:
protos
.
google
.
cloud
.
dataproc
.
v1
.
IGetClusterRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
dataproc
.
v1
.
ICluster
,
protos
.
google
.
cloud
.
dataproc
.
v1
.
IGetClusterRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters Name
Description
request
protos. google.cloud.dataproc.v1.IGetClusterRequest
options
CallOptions
callback
Callback
<protos. google.cloud.dataproc.v1.ICluster
, protos. google.cloud.dataproc.v1.IGetClusterRequest
| null | undefined, {} | null | undefined>
Returns
getCluster(request, callback)
getCluster
(
request
:
protos
.
google
.
cloud
.
dataproc
.
v1
.
IGetClusterRequest
,
callback
:
Callback<protos
.
google
.
cloud
.
dataproc
.
v1
.
ICluster
,
protos
.
google
.
cloud
.
dataproc
.
v1
.
IGetClusterRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters Name
Description
request
protos. google.cloud.dataproc.v1.IGetClusterRequest
callback
Callback
<protos. google.cloud.dataproc.v1.ICluster
, protos. google.cloud.dataproc.v1.IGetClusterRequest
| null | undefined, {} | null | undefined>
Returns
getProjectId()
getProjectId
()
:
Promise<string>
;
Returns
getProjectId(callback)
getProjectId
(
callback
:
Callback<string
,
undefined
,
undefined
> )
:
void
;
Parameter Name
Description
callback
Callback
<string, undefined, undefined>
Returns
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.
listClusters(request, options)
listClusters
(
request
?:
protos
.
google
.
cloud
.
dataproc
.
v1
.
IListClustersRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
dataproc
.
v1
.
ICluster
[],
protos
.
google
.
cloud
.
dataproc
.
v1
.
IListClustersRequest
|
null
,
protos
.
google
.
cloud
.
dataproc
.
v1
.
IListClustersResponse
]>;
Parameters Name
Description
request
protos. google.cloud.dataproc.v1.IListClustersRequest
options
CallOptions
Returns
listClusters(request, options, callback)
listClusters
(
request
:
protos
.
google
.
cloud
.
dataproc
.
v1
.
IListClustersRequest
,
options
:
CallOptions
,
callback
:
PaginationCallback<protos
.
google
.
cloud
.
dataproc
.
v1
.
IListClustersRequest
,
protos
.
google
.
cloud
.
dataproc
.
v1
.
IListClustersResponse
|
null
|
undefined
,
protos
.
google
.
cloud
.
dataproc
.
v1
.
ICluster
> )
:
void
;
Parameters Name
Description
request
protos. google.cloud.dataproc.v1.IListClustersRequest
options
CallOptions
callback
PaginationCallback
<protos. google.cloud.dataproc.v1.IListClustersRequest
, protos. google.cloud.dataproc.v1.IListClustersResponse
| null | undefined, protos. google.cloud.dataproc.v1.ICluster
>
Returns
listClusters(request, callback)
listClusters
(
request
:
protos
.
google
.
cloud
.
dataproc
.
v1
.
IListClustersRequest
,
callback
:
PaginationCallback<protos
.
google
.
cloud
.
dataproc
.
v1
.
IListClustersRequest
,
protos
.
google
.
cloud
.
dataproc
.
v1
.
IListClustersResponse
|
null
|
undefined
,
protos
.
google
.
cloud
.
dataproc
.
v1
.
ICluster
> )
:
void
;
Parameters Name
Description
request
protos. google.cloud.dataproc.v1.IListClustersRequest
callback
PaginationCallback
<protos. google.cloud.dataproc.v1.IListClustersRequest
, protos. google.cloud.dataproc.v1.IListClustersResponse
| null | undefined, protos. google.cloud.dataproc.v1.ICluster
>
Returns
listClustersAsync(request, options)
listClustersAsync
(
request
?:
protos
.
google
.
cloud
.
dataproc
.
v1
.
IListClustersRequest
,
options
?:
CallOptions
)
:
AsyncIterable<protos
.
google
.
cloud
.
dataproc
.
v1
.
ICluster
> ;
Equivalent to listClusters
, 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.IListClustersRequest
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.ICluster
>
{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 [Cluster]. 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.
listClustersStream
(
request
?:
protos
.
google
.
cloud
.
dataproc
.
v1
.
IListClustersRequest
,
options
?:
CallOptions
)
:
Transform
;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Parameters Name
Description
request
protos. google.cloud.dataproc.v1.IListClustersRequest
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 [Cluster] 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 listClustersAsync()
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.
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.
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.
matchLocationFromServiceName(serviceName)
matchLocationFromServiceName
(
serviceName
:
string
)
:
string
|
number
;
Parse the location from Service resource.
Parameter Name
Description
serviceName
string
A fully-qualified path representing Service resource.
Returns Type
Description
string | number
{string} A string representing the location.
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.
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.
matchProjectFromServiceName(serviceName)
matchProjectFromServiceName
(
serviceName
:
string
)
:
string
|
number
;
Parse the project from Service resource.
Parameter Name
Description
serviceName
string
A fully-qualified path representing Service 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.
matchServiceFromServiceName(serviceName)
matchServiceFromServiceName
(
serviceName
:
string
)
:
string
|
number
;
Parse the service from Service resource.
Parameter Name
Description
serviceName
string
A fully-qualified path representing Service resource.
Returns Type
Description
string | number
{string} A string representing the service.
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
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
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
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
Returns Type
Description
string
{string} Resource name string.
servicePath(project, location, service)
servicePath
(
project
:
string
,
location
:
string
,
service
:
string
)
:
string
;
Return a fully-qualified service resource name string.
Parameters
Returns Type
Description
string
{string} Resource name string.
startCluster(request, options)
startCluster
(
request
?:
protos
.
google
.
cloud
.
dataproc
.
v1
.
IStartClusterRequest
,
options
?:
CallOptions
)
:
Promise
< [
LROperation<protos
.
google
.
cloud
.
dataproc
.
v1
.
ICluster
,
protos
.
google
.
cloud
.
dataproc
.
v1
.
IClusterOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
undefined
,
{}
|
undefined
]>;
Parameters Name
Description
request
protos. google.cloud.dataproc.v1.IStartClusterRequest
options
CallOptions
Returns
startCluster(request, options, callback)
startCluster
(
request
:
protos
.
google
.
cloud
.
dataproc
.
v1
.
IStartClusterRequest
,
options
:
CallOptions
,
callback
:
Callback<LROperation<protos
.
google
.
cloud
.
dataproc
.
v1
.
ICluster
,
protos
.
google
.
cloud
.
dataproc
.
v1
.
IClusterOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters Name
Description
request
protos. google.cloud.dataproc.v1.IStartClusterRequest
options
CallOptions
callback
Callback
< LROperation
<protos. google.cloud.dataproc.v1.ICluster
, protos. google.cloud.dataproc.v1.IClusterOperationMetadata
>, protos. google.longrunning.IOperation
| null | undefined, {} | null | undefined>
Returns
startCluster(request, callback)
startCluster
(
request
:
protos
.
google
.
cloud
.
dataproc
.
v1
.
IStartClusterRequest
,
callback
:
Callback<LROperation<protos
.
google
.
cloud
.
dataproc
.
v1
.
ICluster
,
protos
.
google
.
cloud
.
dataproc
.
v1
.
IClusterOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters Name
Description
request
protos. google.cloud.dataproc.v1.IStartClusterRequest
callback
Callback
< LROperation
<protos. google.cloud.dataproc.v1.ICluster
, protos. google.cloud.dataproc.v1.IClusterOperationMetadata
>, protos. google.longrunning.IOperation
| null | undefined, {} | null | undefined>
Returns
stopCluster(request, options)
stopCluster
(
request
?:
protos
.
google
.
cloud
.
dataproc
.
v1
.
IStopClusterRequest
,
options
?:
CallOptions
)
:
Promise
< [
LROperation<protos
.
google
.
cloud
.
dataproc
.
v1
.
ICluster
,
protos
.
google
.
cloud
.
dataproc
.
v1
.
IClusterOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
undefined
,
{}
|
undefined
]>;
Parameters Name
Description
request
protos. google.cloud.dataproc.v1.IStopClusterRequest
options
CallOptions
Returns
stopCluster(request, options, callback)
stopCluster
(
request
:
protos
.
google
.
cloud
.
dataproc
.
v1
.
IStopClusterRequest
,
options
:
CallOptions
,
callback
:
Callback<LROperation<protos
.
google
.
cloud
.
dataproc
.
v1
.
ICluster
,
protos
.
google
.
cloud
.
dataproc
.
v1
.
IClusterOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters Name
Description
request
protos. google.cloud.dataproc.v1.IStopClusterRequest
options
CallOptions
callback
Callback
< LROperation
<protos. google.cloud.dataproc.v1.ICluster
, protos. google.cloud.dataproc.v1.IClusterOperationMetadata
>, protos. google.longrunning.IOperation
| null | undefined, {} | null | undefined>
Returns
stopCluster(request, callback)
stopCluster
(
request
:
protos
.
google
.
cloud
.
dataproc
.
v1
.
IStopClusterRequest
,
callback
:
Callback<LROperation<protos
.
google
.
cloud
.
dataproc
.
v1
.
ICluster
,
protos
.
google
.
cloud
.
dataproc
.
v1
.
IClusterOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters Name
Description
request
protos. google.cloud.dataproc.v1.IStopClusterRequest
callback
Callback
< LROperation
<protos. google.cloud.dataproc.v1.ICluster
, protos. google.cloud.dataproc.v1.IClusterOperationMetadata
>, protos. google.longrunning.IOperation
| null | undefined, {} | null | undefined>
Returns
updateCluster(request, options)
updateCluster
(
request
?:
protos
.
google
.
cloud
.
dataproc
.
v1
.
IUpdateClusterRequest
,
options
?:
CallOptions
)
:
Promise
< [
LROperation<protos
.
google
.
cloud
.
dataproc
.
v1
.
ICluster
,
protos
.
google
.
cloud
.
dataproc
.
v1
.
IClusterOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
undefined
,
{}
|
undefined
]>;
Parameters Name
Description
request
protos. google.cloud.dataproc.v1.IUpdateClusterRequest
options
CallOptions
Returns
updateCluster(request, options, callback)
updateCluster
(
request
:
protos
.
google
.
cloud
.
dataproc
.
v1
.
IUpdateClusterRequest
,
options
:
CallOptions
,
callback
:
Callback<LROperation<protos
.
google
.
cloud
.
dataproc
.
v1
.
ICluster
,
protos
.
google
.
cloud
.
dataproc
.
v1
.
IClusterOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters Name
Description
request
protos. google.cloud.dataproc.v1.IUpdateClusterRequest
options
CallOptions
callback
Callback
< LROperation
<protos. google.cloud.dataproc.v1.ICluster
, protos. google.cloud.dataproc.v1.IClusterOperationMetadata
>, protos. google.longrunning.IOperation
| null | undefined, {} | null | undefined>
Returns
updateCluster(request, callback)
updateCluster
(
request
:
protos
.
google
.
cloud
.
dataproc
.
v1
.
IUpdateClusterRequest
,
callback
:
Callback<LROperation<protos
.
google
.
cloud
.
dataproc
.
v1
.
ICluster
,
protos
.
google
.
cloud
.
dataproc
.
v1
.
IClusterOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters Name
Description
request
protos. google.cloud.dataproc.v1.IUpdateClusterRequest
callback
Callback
< LROperation
<protos. google.cloud.dataproc.v1.ICluster
, protos. google.cloud.dataproc.v1.IClusterOperationMetadata
>, protos. google.longrunning.IOperation
| null | undefined, {} | null | undefined>
Returns
Send feedback
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License
, and code samples are licensed under the Apache 2.0 License
. For details, see the Google Developers Site Policies
. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-09-04 UTC.
Need to tell us more?
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,[]]