The API interface for managing Workflow Templates in the Dataproc API. v1
Package
@google-cloud/dataproc!
Constructors
(constructor)(opts)
constructor(opts?: ClientOptions);
Construct an instance of WorkflowTemplateServiceClient.
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
auth
Property Value
Type | Description |
gax.GoogleAuth | |
descriptors
descriptors: Descriptors;
Property Value
Type | Description |
Descriptors | |
innerApiCalls
innerApiCalls: {
[name: string]: Function;
};
Property Value
Type | Description |
{
[name: string]: Function;
} | |
operationsClient
operationsClient: gax.OperationsClient;
Property Value
Type | Description |
gax.OperationsClient | |
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
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
Type | Description |
(code: string, message: string, warnType?: string) => void | |
workflowTemplateServiceStub
workflowTemplateServiceStub?: Promise<{
[name: string]: Function;
}>;
Property Value
Type | Description |
Promise<{
[name: string]: Function;
}> | |
Methods
checkInstantiateInlineWorkflowTemplateProgress(name)
checkInstantiateInlineWorkflowTemplateProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.dataproc.v1.WorkflowMetadata>>;
Check the status of the long running operation returned by instantiateInlineWorkflowTemplate()
.
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.WorkflowMetadata>> | {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.
|
checkInstantiateWorkflowTemplateProgress(name)
checkInstantiateWorkflowTemplateProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.dataproc.v1.WorkflowMetadata>>;
Check the status of the long running operation returned by instantiateWorkflowTemplate()
.
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.WorkflowMetadata>> | {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()
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.
|
createWorkflowTemplate(request, options)
createWorkflowTemplate(request?: protos.google.cloud.dataproc.v1.ICreateWorkflowTemplateRequest, options?: CallOptions): Promise<[protos.google.cloud.dataproc.v1.IWorkflowTemplate, (protos.google.cloud.dataproc.v1.ICreateWorkflowTemplateRequest | undefined), {} | undefined]>;
Parameters
Name | Description |
request |
protos.google.cloud.dataproc.v1.ICreateWorkflowTemplateRequest
|
options |
CallOptions
|
Returns
Type | Description |
Promise<[protos.google.cloud.dataproc.v1.IWorkflowTemplate, (protos.google.cloud.dataproc.v1.ICreateWorkflowTemplateRequest | undefined), {} | undefined]> | |
createWorkflowTemplate(request, options, callback)
createWorkflowTemplate(request: protos.google.cloud.dataproc.v1.ICreateWorkflowTemplateRequest, options: CallOptions, callback: Callback<protos.google.cloud.dataproc.v1.IWorkflowTemplate, protos.google.cloud.dataproc.v1.ICreateWorkflowTemplateRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.dataproc.v1.ICreateWorkflowTemplateRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.dataproc.v1.IWorkflowTemplate, protos.google.cloud.dataproc.v1.ICreateWorkflowTemplateRequest | null | undefined, {} | null | undefined>
|
Returns
createWorkflowTemplate(request, callback)
createWorkflowTemplate(request: protos.google.cloud.dataproc.v1.ICreateWorkflowTemplateRequest, callback: Callback<protos.google.cloud.dataproc.v1.IWorkflowTemplate, protos.google.cloud.dataproc.v1.ICreateWorkflowTemplateRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.dataproc.v1.ICreateWorkflowTemplateRequest
|
callback |
Callback<protos.google.cloud.dataproc.v1.IWorkflowTemplate, protos.google.cloud.dataproc.v1.ICreateWorkflowTemplateRequest | null | undefined, {} | null | undefined>
|
Returns
deleteWorkflowTemplate(request, options)
deleteWorkflowTemplate(request?: protos.google.cloud.dataproc.v1.IDeleteWorkflowTemplateRequest, options?: CallOptions): Promise<[protos.google.protobuf.IEmpty, (protos.google.cloud.dataproc.v1.IDeleteWorkflowTemplateRequest | undefined), {} | undefined]>;
Parameters
Name | Description |
request |
protos.google.cloud.dataproc.v1.IDeleteWorkflowTemplateRequest
|
options |
CallOptions
|
Returns
Type | Description |
Promise<[protos.google.protobuf.IEmpty, (protos.google.cloud.dataproc.v1.IDeleteWorkflowTemplateRequest | undefined), {} | undefined]> | |
deleteWorkflowTemplate(request, options, callback)
deleteWorkflowTemplate(request: protos.google.cloud.dataproc.v1.IDeleteWorkflowTemplateRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.dataproc.v1.IDeleteWorkflowTemplateRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.dataproc.v1.IDeleteWorkflowTemplateRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.protobuf.IEmpty, protos.google.cloud.dataproc.v1.IDeleteWorkflowTemplateRequest | null | undefined, {} | null | undefined>
|
Returns
deleteWorkflowTemplate(request, callback)
deleteWorkflowTemplate(request: protos.google.cloud.dataproc.v1.IDeleteWorkflowTemplateRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.dataproc.v1.IDeleteWorkflowTemplateRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.dataproc.v1.IDeleteWorkflowTemplateRequest
|
callback |
Callback<protos.google.protobuf.IEmpty, protos.google.cloud.dataproc.v1.IDeleteWorkflowTemplateRequest | null | undefined, {} | null | undefined>
|
Returns
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
getWorkflowTemplate(request, options)
getWorkflowTemplate(request?: protos.google.cloud.dataproc.v1.IGetWorkflowTemplateRequest, options?: CallOptions): Promise<[protos.google.cloud.dataproc.v1.IWorkflowTemplate, protos.google.cloud.dataproc.v1.IGetWorkflowTemplateRequest | undefined, {} | undefined]>;
Parameters
Name | Description |
request |
protos.google.cloud.dataproc.v1.IGetWorkflowTemplateRequest
|
options |
CallOptions
|
Returns
Type | Description |
Promise<[protos.google.cloud.dataproc.v1.IWorkflowTemplate, protos.google.cloud.dataproc.v1.IGetWorkflowTemplateRequest | undefined, {} | undefined]> | |
getWorkflowTemplate(request, options, callback)
getWorkflowTemplate(request: protos.google.cloud.dataproc.v1.IGetWorkflowTemplateRequest, options: CallOptions, callback: Callback<protos.google.cloud.dataproc.v1.IWorkflowTemplate, protos.google.cloud.dataproc.v1.IGetWorkflowTemplateRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.dataproc.v1.IGetWorkflowTemplateRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.dataproc.v1.IWorkflowTemplate, protos.google.cloud.dataproc.v1.IGetWorkflowTemplateRequest | null | undefined, {} | null | undefined>
|
Returns
getWorkflowTemplate(request, callback)
getWorkflowTemplate(request: protos.google.cloud.dataproc.v1.IGetWorkflowTemplateRequest, callback: Callback<protos.google.cloud.dataproc.v1.IWorkflowTemplate, protos.google.cloud.dataproc.v1.IGetWorkflowTemplateRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.dataproc.v1.IGetWorkflowTemplateRequest
|
callback |
Callback<protos.google.cloud.dataproc.v1.IWorkflowTemplate, protos.google.cloud.dataproc.v1.IGetWorkflowTemplateRequest | null | undefined, {} | null | 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.
|
instantiateInlineWorkflowTemplate(request, options)
instantiateInlineWorkflowTemplate(request?: protos.google.cloud.dataproc.v1.IInstantiateInlineWorkflowTemplateRequest, options?: CallOptions): Promise<[LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.dataproc.v1.IWorkflowMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined]>;
Parameters
Name | Description |
request |
protos.google.cloud.dataproc.v1.IInstantiateInlineWorkflowTemplateRequest
|
options |
CallOptions
|
Returns
Type | Description |
Promise<[LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.dataproc.v1.IWorkflowMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined]> | |
instantiateInlineWorkflowTemplate(request, options, callback)
instantiateInlineWorkflowTemplate(request: protos.google.cloud.dataproc.v1.IInstantiateInlineWorkflowTemplateRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.dataproc.v1.IWorkflowMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.dataproc.v1.IInstantiateInlineWorkflowTemplateRequest
|
options |
CallOptions
|
callback |
Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.dataproc.v1.IWorkflowMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Returns
instantiateInlineWorkflowTemplate(request, callback)
instantiateInlineWorkflowTemplate(request: protos.google.cloud.dataproc.v1.IInstantiateInlineWorkflowTemplateRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.dataproc.v1.IWorkflowMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.dataproc.v1.IInstantiateInlineWorkflowTemplateRequest
|
callback |
Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.dataproc.v1.IWorkflowMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Returns
instantiateWorkflowTemplate(request, options)
instantiateWorkflowTemplate(request?: protos.google.cloud.dataproc.v1.IInstantiateWorkflowTemplateRequest, options?: CallOptions): Promise<[LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.dataproc.v1.IWorkflowMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined]>;
Parameters
Name | Description |
request |
protos.google.cloud.dataproc.v1.IInstantiateWorkflowTemplateRequest
|
options |
CallOptions
|
Returns
Type | Description |
Promise<[LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.dataproc.v1.IWorkflowMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined]> | |
instantiateWorkflowTemplate(request, options, callback)
instantiateWorkflowTemplate(request: protos.google.cloud.dataproc.v1.IInstantiateWorkflowTemplateRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.dataproc.v1.IWorkflowMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.dataproc.v1.IInstantiateWorkflowTemplateRequest
|
options |
CallOptions
|
callback |
Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.dataproc.v1.IWorkflowMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Returns
instantiateWorkflowTemplate(request, callback)
instantiateWorkflowTemplate(request: protos.google.cloud.dataproc.v1.IInstantiateWorkflowTemplateRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.dataproc.v1.IWorkflowMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.dataproc.v1.IInstantiateWorkflowTemplateRequest
|
callback |
Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.dataproc.v1.IWorkflowMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Returns
listWorkflowTemplates(request, options)
listWorkflowTemplates(request?: protos.google.cloud.dataproc.v1.IListWorkflowTemplatesRequest, options?: CallOptions): Promise<[protos.google.cloud.dataproc.v1.IWorkflowTemplate[], protos.google.cloud.dataproc.v1.IListWorkflowTemplatesRequest | null, protos.google.cloud.dataproc.v1.IListWorkflowTemplatesResponse]>;
Parameters
Name | Description |
request |
protos.google.cloud.dataproc.v1.IListWorkflowTemplatesRequest
|
options |
CallOptions
|
Returns
Type | Description |
Promise<[protos.google.cloud.dataproc.v1.IWorkflowTemplate[], protos.google.cloud.dataproc.v1.IListWorkflowTemplatesRequest | null, protos.google.cloud.dataproc.v1.IListWorkflowTemplatesResponse]> | |
listWorkflowTemplates(request, options, callback)
listWorkflowTemplates(request: protos.google.cloud.dataproc.v1.IListWorkflowTemplatesRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.dataproc.v1.IListWorkflowTemplatesRequest, protos.google.cloud.dataproc.v1.IListWorkflowTemplatesResponse | null | undefined, protos.google.cloud.dataproc.v1.IWorkflowTemplate>): void;
Parameters
Name | Description |
request |
protos.google.cloud.dataproc.v1.IListWorkflowTemplatesRequest
|
options |
CallOptions
|
callback |
PaginationCallback<protos.google.cloud.dataproc.v1.IListWorkflowTemplatesRequest, protos.google.cloud.dataproc.v1.IListWorkflowTemplatesResponse | null | undefined, protos.google.cloud.dataproc.v1.IWorkflowTemplate>
|
Returns
listWorkflowTemplates(request, callback)
listWorkflowTemplates(request: protos.google.cloud.dataproc.v1.IListWorkflowTemplatesRequest, callback: PaginationCallback<protos.google.cloud.dataproc.v1.IListWorkflowTemplatesRequest, protos.google.cloud.dataproc.v1.IListWorkflowTemplatesResponse | null | undefined, protos.google.cloud.dataproc.v1.IWorkflowTemplate>): void;
Parameters
Name | Description |
request |
protos.google.cloud.dataproc.v1.IListWorkflowTemplatesRequest
|
callback |
PaginationCallback<protos.google.cloud.dataproc.v1.IListWorkflowTemplatesRequest, protos.google.cloud.dataproc.v1.IListWorkflowTemplatesResponse | null | undefined, protos.google.cloud.dataproc.v1.IWorkflowTemplate>
|
Returns
listWorkflowTemplatesAsync(request, options)
listWorkflowTemplatesAsync(request?: protos.google.cloud.dataproc.v1.IListWorkflowTemplatesRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.dataproc.v1.IWorkflowTemplate>;
Equivalent to listWorkflowTemplates
, 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.IListWorkflowTemplatesRequest
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.IWorkflowTemplate> | {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 [WorkflowTemplate]. 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.
|
listWorkflowTemplatesStream(request, options)
listWorkflowTemplatesStream(request?: protos.google.cloud.dataproc.v1.IListWorkflowTemplatesRequest, options?: CallOptions): Transform;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Parameters
Name | Description |
request |
protos.google.cloud.dataproc.v1.IListWorkflowTemplatesRequest
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 [WorkflowTemplate] 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 listWorkflowTemplatesAsync() 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.
|
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.
|
matchProjectFromRegionName(regionName)
matchProjectFromRegionName(regionName: string): string | number;
Parse the project from Region resource.
Parameter
Name | Description |
regionName |
string
A fully-qualified path representing Region 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.
|
matchRegionFromRegionName(regionName)
matchRegionFromRegionName(regionName: string): string | number;
Parse the region from Region resource.
Parameter
Name | Description |
regionName |
string
A fully-qualified path representing Region 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.
|
regionPath(project, region)
regionPath(project: string, region: string): string;
Return a fully-qualified region resource name string.
Parameters
Name | Description |
project |
string
|
region |
string
|
Returns
Type | Description |
string | {string} Resource name string.
|
updateWorkflowTemplate(request, options)
updateWorkflowTemplate(request?: protos.google.cloud.dataproc.v1.IUpdateWorkflowTemplateRequest, options?: CallOptions): Promise<[protos.google.cloud.dataproc.v1.IWorkflowTemplate, (protos.google.cloud.dataproc.v1.IUpdateWorkflowTemplateRequest | undefined), {} | undefined]>;
Parameters
Name | Description |
request |
protos.google.cloud.dataproc.v1.IUpdateWorkflowTemplateRequest
|
options |
CallOptions
|
Returns
Type | Description |
Promise<[protos.google.cloud.dataproc.v1.IWorkflowTemplate, (protos.google.cloud.dataproc.v1.IUpdateWorkflowTemplateRequest | undefined), {} | undefined]> | |
updateWorkflowTemplate(request, options, callback)
updateWorkflowTemplate(request: protos.google.cloud.dataproc.v1.IUpdateWorkflowTemplateRequest, options: CallOptions, callback: Callback<protos.google.cloud.dataproc.v1.IWorkflowTemplate, protos.google.cloud.dataproc.v1.IUpdateWorkflowTemplateRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.dataproc.v1.IUpdateWorkflowTemplateRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.dataproc.v1.IWorkflowTemplate, protos.google.cloud.dataproc.v1.IUpdateWorkflowTemplateRequest | null | undefined, {} | null | undefined>
|
Returns
updateWorkflowTemplate(request, callback)
updateWorkflowTemplate(request: protos.google.cloud.dataproc.v1.IUpdateWorkflowTemplateRequest, callback: Callback<protos.google.cloud.dataproc.v1.IWorkflowTemplate, protos.google.cloud.dataproc.v1.IUpdateWorkflowTemplateRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.dataproc.v1.IUpdateWorkflowTemplateRequest
|
callback |
Callback<protos.google.cloud.dataproc.v1.IWorkflowTemplate, protos.google.cloud.dataproc.v1.IUpdateWorkflowTemplateRequest | null | undefined, {} | null | undefined>
|
Returns