Dataproc

import { Dataproc } from "https://googleapis.deno.dev/v1/dataproc:v1.ts";

Manages Hadoop-based clusters and jobs on Google Cloud Platform.

class Dataproc {

constructor(client?: CredentialsClient, baseUrl?: string);

async projectsLocationsAutoscalingPoliciesCreate(parent: string, req: AutoscalingPolicy): Promise<AutoscalingPolicy>;

async projectsLocationsAutoscalingPoliciesDelete(name: string): Promise<Empty>;

async projectsLocationsAutoscalingPoliciesGet(name: string): Promise<AutoscalingPolicy>;

async projectsLocationsAutoscalingPoliciesGetIamPolicy(resource: string, req: GetIamPolicyRequest): Promise<Policy>;

async projectsLocationsAutoscalingPoliciesList(parent: string, opts?: ProjectsLocationsAutoscalingPoliciesListOptions): Promise<ListAutoscalingPoliciesResponse>;

async projectsLocationsAutoscalingPoliciesSetIamPolicy(resource: string, req: SetIamPolicyRequest): Promise<Policy>;

async projectsLocationsAutoscalingPoliciesTestIamPermissions(resource: string, req: TestIamPermissionsRequest): Promise<TestIamPermissionsResponse>;

async projectsLocationsAutoscalingPoliciesUpdate(name: string, req: AutoscalingPolicy): Promise<AutoscalingPolicy>;

async projectsLocationsBatchesAnalyze(name: string, req: AnalyzeBatchRequest): Promise<Operation>;

async projectsLocationsBatchesCreate(

parent: string,

req: Batch,

opts?: ProjectsLocationsBatchesCreateOptions,

): Promise<Operation>;

async projectsLocationsBatchesDelete(name: string): Promise<Empty>;

async projectsLocationsBatchesGet(name: string): Promise<Batch>;

async projectsLocationsBatchesList(parent: string, opts?: ProjectsLocationsBatchesListOptions): Promise<ListBatchesResponse>;

async projectsLocationsOperationsCancel(name: string): Promise<Empty>;

async projectsLocationsOperationsDelete(name: string): Promise<Empty>;

async projectsLocationsOperationsGet(name: string): Promise<Operation>;

async projectsLocationsOperationsList(name: string, opts?: ProjectsLocationsOperationsListOptions): Promise<ListOperationsResponse>;

async projectsLocationsSessionsCreate(

parent: string,

req: Session,

opts?: ProjectsLocationsSessionsCreateOptions,

): Promise<Operation>;

async projectsLocationsSessionsDelete(name: string, opts?: ProjectsLocationsSessionsDeleteOptions): Promise<Operation>;

async projectsLocationsSessionsGet(name: string): Promise<Session>;

async projectsLocationsSessionsList(parent: string, opts?: ProjectsLocationsSessionsListOptions): Promise<ListSessionsResponse>;

async projectsLocationsSessionsTerminate(name: string, req: TerminateSessionRequest): Promise<Operation>;

async projectsLocationsSessionTemplatesCreate(parent: string, req: SessionTemplate): Promise<SessionTemplate>;

async projectsLocationsSessionTemplatesDelete(name: string): Promise<Empty>;

async projectsLocationsSessionTemplatesGet(name: string): Promise<SessionTemplate>;

async projectsLocationsSessionTemplatesList(parent: string, opts?: ProjectsLocationsSessionTemplatesListOptions): Promise<ListSessionTemplatesResponse>;

async projectsLocationsSessionTemplatesPatch(name: string, req: SessionTemplate): Promise<SessionTemplate>;

async projectsLocationsWorkflowTemplatesCreate(parent: string, req: WorkflowTemplate): Promise<WorkflowTemplate>;

async projectsLocationsWorkflowTemplatesDelete(name: string, opts?: ProjectsLocationsWorkflowTemplatesDeleteOptions): Promise<Empty>;

async projectsLocationsWorkflowTemplatesGet(name: string, opts?: ProjectsLocationsWorkflowTemplatesGetOptions): Promise<WorkflowTemplate>;

async projectsLocationsWorkflowTemplatesGetIamPolicy(resource: string, req: GetIamPolicyRequest): Promise<Policy>;

async projectsLocationsWorkflowTemplatesInstantiate(name: string, req: InstantiateWorkflowTemplateRequest): Promise<Operation>;

async projectsLocationsWorkflowTemplatesInstantiateInline(

parent: string,

req: WorkflowTemplate,

opts?: ProjectsLocationsWorkflowTemplatesInstantiateInlineOptions,

): Promise<Operation>;

async projectsLocationsWorkflowTemplatesList(parent: string, opts?: ProjectsLocationsWorkflowTemplatesListOptions): Promise<ListWorkflowTemplatesResponse>;

async projectsLocationsWorkflowTemplatesSetIamPolicy(resource: string, req: SetIamPolicyRequest): Promise<Policy>;

async projectsLocationsWorkflowTemplatesTestIamPermissions(resource: string, req: TestIamPermissionsRequest): Promise<TestIamPermissionsResponse>;

async projectsLocationsWorkflowTemplatesUpdate(name: string, req: WorkflowTemplate): Promise<WorkflowTemplate>;

async projectsRegionsAutoscalingPoliciesCreate(parent: string, req: AutoscalingPolicy): Promise<AutoscalingPolicy>;

async projectsRegionsAutoscalingPoliciesDelete(name: string): Promise<Empty>;

async projectsRegionsAutoscalingPoliciesGet(name: string): Promise<AutoscalingPolicy>;

async projectsRegionsAutoscalingPoliciesGetIamPolicy(resource: string, req: GetIamPolicyRequest): Promise<Policy>;

async projectsRegionsAutoscalingPoliciesList(parent: string, opts?: ProjectsRegionsAutoscalingPoliciesListOptions): Promise<ListAutoscalingPoliciesResponse>;

async projectsRegionsAutoscalingPoliciesSetIamPolicy(resource: string, req: SetIamPolicyRequest): Promise<Policy>;

async projectsRegionsAutoscalingPoliciesTestIamPermissions(resource: string, req: TestIamPermissionsRequest): Promise<TestIamPermissionsResponse>;

async projectsRegionsAutoscalingPoliciesUpdate(name: string, req: AutoscalingPolicy): Promise<AutoscalingPolicy>;

async projectsRegionsClustersCreate(

projectId: string,

region: string,

req: Cluster,

opts?: ProjectsRegionsClustersCreateOptions,

): Promise<Operation>;

async projectsRegionsClustersDelete(

clusterName: string,

projectId: string,

region: string,

opts?: ProjectsRegionsClustersDeleteOptions,

): Promise<Operation>;

async projectsRegionsClustersDiagnose(

clusterName: string,

projectId: string,

region: string,

req: DiagnoseClusterRequest,

): Promise<Operation>;

async projectsRegionsClustersGet(

clusterName: string,

projectId: string,

region: string,

): Promise<Cluster>;

async projectsRegionsClustersGetIamPolicy(resource: string, req: GetIamPolicyRequest): Promise<Policy>;

async projectsRegionsClustersInjectCredentials(

cluster: string,

project: string,

region: string,

req: InjectCredentialsRequest,

): Promise<Operation>;

async projectsRegionsClustersList(

projectId: string,

region: string,

opts?: ProjectsRegionsClustersListOptions,

): Promise<ListClustersResponse>;

async projectsRegionsClustersNodeGroupsCreate(

parent: string,

req: NodeGroup,

opts?: ProjectsRegionsClustersNodeGroupsCreateOptions,

): Promise<Operation>;

async projectsRegionsClustersNodeGroupsGet(name: string): Promise<NodeGroup>;

async projectsRegionsClustersNodeGroupsRepair(name: string, req: RepairNodeGroupRequest): Promise<Operation>;

async projectsRegionsClustersNodeGroupsResize(name: string, req: ResizeNodeGroupRequest): Promise<Operation>;

async projectsRegionsClustersPatch(

clusterName: string,

projectId: string,

region: string,

req: Cluster,

opts?: ProjectsRegionsClustersPatchOptions,

): Promise<Operation>;

async projectsRegionsClustersRepair(

clusterName: string,

projectId: string,

region: string,

req: RepairClusterRequest,

): Promise<Operation>;

async projectsRegionsClustersSetIamPolicy(resource: string, req: SetIamPolicyRequest): Promise<Policy>;

async projectsRegionsClustersStart(

clusterName: string,

projectId: string,

region: string,

req: StartClusterRequest,

): Promise<Operation>;

async projectsRegionsClustersStop(

clusterName: string,

projectId: string,

region: string,

req: StopClusterRequest,

): Promise<Operation>;

async projectsRegionsClustersTestIamPermissions(resource: string, req: TestIamPermissionsRequest): Promise<TestIamPermissionsResponse>;

async projectsRegionsJobsCancel(

jobId: string,

projectId: string,

region: string,

req: CancelJobRequest,

): Promise<Job>;

async projectsRegionsJobsDelete(

jobId: string,

projectId: string,

region: string,

): Promise<Empty>;

async projectsRegionsJobsGet(

jobId: string,

projectId: string,

region: string,

): Promise<Job>;

async projectsRegionsJobsGetIamPolicy(resource: string, req: GetIamPolicyRequest): Promise<Policy>;

async projectsRegionsJobsList(

projectId: string,

region: string,

opts?: ProjectsRegionsJobsListOptions,

): Promise<ListJobsResponse>;

async projectsRegionsJobsPatch(

jobId: string,

projectId: string,

region: string,

req: Job,

opts?: ProjectsRegionsJobsPatchOptions,

): Promise<Job>;

async projectsRegionsJobsSetIamPolicy(resource: string, req: SetIamPolicyRequest): Promise<Policy>;

async projectsRegionsJobsSubmit(

projectId: string,

region: string,

req: SubmitJobRequest,

): Promise<Job>;

async projectsRegionsJobsSubmitAsOperation(

projectId: string,

region: string,

req: SubmitJobRequest,

): Promise<Operation>;

async projectsRegionsJobsTestIamPermissions(resource: string, req: TestIamPermissionsRequest): Promise<TestIamPermissionsResponse>;

async projectsRegionsOperationsCancel(name: string): Promise<Empty>;

async projectsRegionsOperationsDelete(name: string): Promise<Empty>;

async projectsRegionsOperationsGet(name: string): Promise<Operation>;

async projectsRegionsOperationsGetIamPolicy(resource: string, req: GetIamPolicyRequest): Promise<Policy>;

async projectsRegionsOperationsList(name: string, opts?: ProjectsRegionsOperationsListOptions): Promise<ListOperationsResponse>;

async projectsRegionsOperationsSetIamPolicy(resource: string, req: SetIamPolicyRequest): Promise<Policy>;

async projectsRegionsOperationsTestIamPermissions(resource: string, req: TestIamPermissionsRequest): Promise<TestIamPermissionsResponse>;

async projectsRegionsWorkflowTemplatesCreate(parent: string, req: WorkflowTemplate): Promise<WorkflowTemplate>;

async projectsRegionsWorkflowTemplatesDelete(name: string, opts?: ProjectsRegionsWorkflowTemplatesDeleteOptions): Promise<Empty>;

async projectsRegionsWorkflowTemplatesGet(name: string, opts?: ProjectsRegionsWorkflowTemplatesGetOptions): Promise<WorkflowTemplate>;

async projectsRegionsWorkflowTemplatesGetIamPolicy(resource: string, req: GetIamPolicyRequest): Promise<Policy>;

async projectsRegionsWorkflowTemplatesInstantiate(name: string, req: InstantiateWorkflowTemplateRequest): Promise<Operation>;

async projectsRegionsWorkflowTemplatesInstantiateInline(

parent: string,

req: WorkflowTemplate,

opts?: ProjectsRegionsWorkflowTemplatesInstantiateInlineOptions,

): Promise<Operation>;

async projectsRegionsWorkflowTemplatesList(parent: string, opts?: ProjectsRegionsWorkflowTemplatesListOptions): Promise<ListWorkflowTemplatesResponse>;

async projectsRegionsWorkflowTemplatesSetIamPolicy(resource: string, req: SetIamPolicyRequest): Promise<Policy>;

async projectsRegionsWorkflowTemplatesTestIamPermissions(resource: string, req: TestIamPermissionsRequest): Promise<TestIamPermissionsResponse>;

async projectsRegionsWorkflowTemplatesUpdate(name: string, req: WorkflowTemplate): Promise<WorkflowTemplate>;

}

§Constructors

new Dataproc(client?: CredentialsClient, baseUrl?: string)

[src]

§Methods

projectsLocationsAutoscalingPoliciesCreate(parent: string, req: AutoscalingPolicy): Promise<AutoscalingPolicy>

[src]

Creates new autoscaling policy.

@param parent

Required. The "resource name" of the region or location, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.autoscalingPolicies.create, the resource name of the region has the following format: projects/{project_id}/regions/{region} For projects.locations.autoscalingPolicies.create, the resource name of the location has the following format: projects/{project_id}/locations/{location}

projectsLocationsAutoscalingPoliciesDelete(name: string): Promise<Empty>

[src]

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

@param name

Required. The "resource name" of the autoscaling policy, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.autoscalingPolicies.delete, the resource name of the policy has the following format: projects/{project_id}/regions/{region}/autoscalingPolicies/{policy_id} For projects.locations.autoscalingPolicies.delete, the resource name of the policy has the following format: projects/{project_id}/locations/{location}/autoscalingPolicies/{policy_id}

projectsLocationsAutoscalingPoliciesGet(name: string): Promise<AutoscalingPolicy>

[src]

Retrieves autoscaling policy.

@param name

Required. The "resource name" of the autoscaling policy, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.autoscalingPolicies.get, the resource name of the policy has the following format: projects/{project_id}/regions/{region}/autoscalingPolicies/{policy_id} For projects.locations.autoscalingPolicies.get, the resource name of the policy has the following format: projects/{project_id}/locations/{location}/autoscalingPolicies/{policy_id}

projectsLocationsAutoscalingPoliciesGetIamPolicy(resource: string, req: GetIamPolicyRequest): Promise<Policy>

[src]

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

@param resource

REQUIRED: The resource for which the policy is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

projectsLocationsAutoscalingPoliciesList(parent: string, opts?: ProjectsLocationsAutoscalingPoliciesListOptions): Promise<ListAutoscalingPoliciesResponse>

[src]

Lists autoscaling policies in the project.

@param parent

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}

projectsLocationsAutoscalingPoliciesSetIamPolicy(resource: string, req: SetIamPolicyRequest): Promise<Policy>

[src]

Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

@param resource

REQUIRED: The resource for which the policy is being specified. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

projectsLocationsAutoscalingPoliciesTestIamPermissions(resource: string, req: TestIamPermissionsRequest): Promise<TestIamPermissionsResponse>

[src]

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.

@param resource

REQUIRED: The resource for which the policy detail is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

projectsLocationsAutoscalingPoliciesUpdate(name: string, req: AutoscalingPolicy): Promise<AutoscalingPolicy>

[src]

Updates (replaces) autoscaling policy.Disabled check for update_mask, because all updates will be full replacements.

@param name

Output only. The "resource name" of the autoscaling policy, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.autoscalingPolicies, the resource name of the policy has the following format: projects/{project_id}/regions/{region}/autoscalingPolicies/{policy_id} For projects.locations.autoscalingPolicies, the resource name of the policy has the following format: projects/{project_id}/locations/{location}/autoscalingPolicies/{policy_id}

projectsLocationsBatchesAnalyze(name: string, req: AnalyzeBatchRequest): Promise<Operation>

[src]

Analyze a Batch for possible recommendations and insights.

@param name

Required. The fully qualified name of the batch to analyze in the format "projects/PROJECT_ID/locations/DATAPROC_REGION/batches/BATCH_ID"

projectsLocationsBatchesCreate(parent: string, req: Batch, opts?: ProjectsLocationsBatchesCreateOptions): Promise<Operation>

[src]

Creates a batch workload that executes asynchronously.

@param parent

Required. The parent resource where this batch will be created.

projectsLocationsBatchesDelete(name: string): Promise<Empty>

[src]

Deletes the batch workload resource. If the batch is not in a CANCELLED, SUCCEEDED or FAILED State, the delete operation fails and the response returns FAILED_PRECONDITION.

@param name

Required. The fully qualified name of the batch to retrieve in the format "projects/PROJECT_ID/locations/DATAPROC_REGION/batches/BATCH_ID"

projectsLocationsBatchesGet(name: string): Promise<Batch>

[src]

Gets the batch workload resource representation.

@param name

Required. The fully qualified name of the batch to retrieve in the format "projects/PROJECT_ID/locations/DATAPROC_REGION/batches/BATCH_ID"

projectsLocationsBatchesList(parent: string, opts?: ProjectsLocationsBatchesListOptions): Promise<ListBatchesResponse>

[src]

Lists batch workloads.

@param parent

Required. The parent, which owns this collection of batches.

projectsLocationsOperationsCancel(name: string): Promise<Empty>

[src]

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

@param name

The name of the operation resource to be cancelled.

projectsLocationsOperationsDelete(name: string): Promise<Empty>

[src]

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

@param name

The name of the operation resource to be deleted.

projectsLocationsOperationsGet(name: string): Promise<Operation>

[src]

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

@param name

The name of the operation resource.

projectsLocationsOperationsList(name: string, opts?: ProjectsLocationsOperationsListOptions): Promise<ListOperationsResponse>

[src]

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

@param name

The name of the operation's parent resource.

projectsLocationsSessionsCreate(parent: string, req: Session, opts?: ProjectsLocationsSessionsCreateOptions): Promise<Operation>

[src]

Create an interactive session asynchronously.

@param parent

Required. The parent resource where this session will be created.

projectsLocationsSessionsDelete(name: string, opts?: ProjectsLocationsSessionsDeleteOptions): Promise<Operation>

[src]

Deletes the interactive session resource. If the session is not in terminal state, it is terminated, and then deleted.

@param name

Required. The name of the session resource to delete.

projectsLocationsSessionsGet(name: string): Promise<Session>

[src]

Gets the resource representation for an interactive session.

@param name

Required. The name of the session to retrieve.

projectsLocationsSessionsList(parent: string, opts?: ProjectsLocationsSessionsListOptions): Promise<ListSessionsResponse>

[src]

Lists interactive sessions.

@param parent

Required. The parent, which owns this collection of sessions.

projectsLocationsSessionsTerminate(name: string, req: TerminateSessionRequest): Promise<Operation>

[src]

Terminates the interactive session.

@param name

Required. The name of the session resource to terminate.

projectsLocationsSessionTemplatesCreate(parent: string, req: SessionTemplate): Promise<SessionTemplate>

[src]

Create a session template synchronously.

@param parent

Required. The parent resource where this session template will be created.

projectsLocationsSessionTemplatesDelete(name: string): Promise<Empty>

[src]

Deletes a session template.

@param name

Required. The name of the session template resource to delete.

projectsLocationsSessionTemplatesGet(name: string): Promise<SessionTemplate>

[src]

Gets the resource representation for a session template.

@param name

Required. The name of the session template to retrieve.

projectsLocationsSessionTemplatesList(parent: string, opts?: ProjectsLocationsSessionTemplatesListOptions): Promise<ListSessionTemplatesResponse>

[src]

Lists session templates.

@param parent

Required. The parent that owns this collection of session templates.

projectsLocationsSessionTemplatesPatch(name: string, req: SessionTemplate): Promise<SessionTemplate>

[src]

Updates the session template synchronously.

@param name

Required. The resource name of the session template.

projectsLocationsWorkflowTemplatesCreate(parent: string, req: WorkflowTemplate): Promise<WorkflowTemplate>

[src]

Creates new workflow template.

@param parent

Required. The resource name of the region or location, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.workflowTemplates.create, the resource name of the region has the following format: projects/{project_id}/regions/{region} For projects.locations.workflowTemplates.create, the resource name of the location has the following format: projects/{project_id}/locations/{location}

projectsLocationsWorkflowTemplatesDelete(name: string, opts?: ProjectsLocationsWorkflowTemplatesDeleteOptions): Promise<Empty>

[src]

Deletes a workflow template. It does not cancel in-progress workflows.

@param name

Required. The resource name of the workflow template, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.workflowTemplates.delete, the resource name of the template has the following format: projects/{project_id}/regions/{region}/workflowTemplates/{template_id} For projects.locations.workflowTemplates.instantiate, the resource name of the template has the following format: projects/{project_id}/locations/{location}/workflowTemplates/{template_id}

projectsLocationsWorkflowTemplatesGet(name: string, opts?: ProjectsLocationsWorkflowTemplatesGetOptions): Promise<WorkflowTemplate>

[src]

Retrieves the latest workflow template.Can retrieve previously instantiated template by specifying optional version parameter.

@param name

Required. The resource name of the workflow template, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.workflowTemplates.get, the resource name of the template has the following format: projects/{project_id}/regions/{region}/workflowTemplates/{template_id} For projects.locations.workflowTemplates.get, the resource name of the template has the following format: projects/{project_id}/locations/{location}/workflowTemplates/{template_id}

projectsLocationsWorkflowTemplatesGetIamPolicy(resource: string, req: GetIamPolicyRequest): Promise<Policy>

[src]

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

@param resource

REQUIRED: The resource for which the policy is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

projectsLocationsWorkflowTemplatesInstantiate(name: string, req: InstantiateWorkflowTemplateRequest): Promise<Operation>

[src]

Instantiates a template and begins execution.The returned Operation can be used to track execution of workflow by polling operations.get. The Operation will complete when entire workflow is finished.The running workflow can be aborted via operations.cancel. This will cause any inflight jobs to be cancelled and workflow-owned clusters to be deleted.The Operation.metadata will be WorkflowMetadata (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#workflowmetadata). Also see Using WorkflowMetadata (https://cloud.google.com/dataproc/docs/concepts/workflows/debugging#using_workflowmetadata).On successful completion, Operation.response will be Empty.

@param name

Required. The resource name of the workflow template, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.workflowTemplates.instantiate, the resource name of the template has the following format: projects/{project_id}/regions/{region}/workflowTemplates/{template_id} For projects.locations.workflowTemplates.instantiate, the resource name of the template has the following format: projects/{project_id}/locations/{location}/workflowTemplates/{template_id}

projectsLocationsWorkflowTemplatesInstantiateInline(parent: string, req: WorkflowTemplate, opts?: ProjectsLocationsWorkflowTemplatesInstantiateInlineOptions): Promise<Operation>

[src]

Instantiates a template and begins execution.This method is equivalent to executing the sequence CreateWorkflowTemplate, InstantiateWorkflowTemplate, DeleteWorkflowTemplate.The returned Operation can be used to track execution of workflow by polling operations.get. The Operation will complete when entire workflow is finished.The running workflow can be aborted via operations.cancel. This will cause any inflight jobs to be cancelled and workflow-owned clusters to be deleted.The Operation.metadata will be WorkflowMetadata (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#workflowmetadata). Also see Using WorkflowMetadata (https://cloud.google.com/dataproc/docs/concepts/workflows/debugging#using_workflowmetadata).On successful completion, Operation.response will be Empty.

@param parent

Required. The resource name of the region or location, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.workflowTemplates,instantiateinline, the resource name of the region has the following format: projects/{project_id}/regions/{region} For projects.locations.workflowTemplates.instantiateinline, the resource name of the location has the following format: projects/{project_id}/locations/{location}

projectsLocationsWorkflowTemplatesList(parent: string, opts?: ProjectsLocationsWorkflowTemplatesListOptions): Promise<ListWorkflowTemplatesResponse>

[src]

Lists workflows that match the specified filter in the request.

@param parent

Required. The resource name of the region or location, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.workflowTemplates,list, the resource name of the region has the following format: projects/{project_id}/regions/{region} For projects.locations.workflowTemplates.list, the resource name of the location has the following format: projects/{project_id}/locations/{location}

projectsLocationsWorkflowTemplatesSetIamPolicy(resource: string, req: SetIamPolicyRequest): Promise<Policy>

[src]

Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

@param resource

REQUIRED: The resource for which the policy is being specified. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

projectsLocationsWorkflowTemplatesTestIamPermissions(resource: string, req: TestIamPermissionsRequest): Promise<TestIamPermissionsResponse>

[src]

@param resource

REQUIRED: The resource for which the policy detail is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

projectsLocationsWorkflowTemplatesUpdate(name: string, req: WorkflowTemplate): Promise<WorkflowTemplate>

[src]

Updates (replaces) workflow template. The updated template must contain version that matches the current server version.

@param name

Output only. The resource name of the workflow template, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.workflowTemplates, the resource name of the template has the following format: projects/{project_id}/regions/{region}/workflowTemplates/{template_id} For projects.locations.workflowTemplates, the resource name of the template has the following format: projects/{project_id}/locations/{location}/workflowTemplates/{template_id}

projectsRegionsAutoscalingPoliciesCreate(parent: string, req: AutoscalingPolicy): Promise<AutoscalingPolicy>

[src]

Creates new autoscaling policy.

@param parent

projectsRegionsAutoscalingPoliciesDelete(name: string): Promise<Empty>

[src]

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

@param name

projectsRegionsAutoscalingPoliciesGet(name: string): Promise<AutoscalingPolicy>

[src]

Retrieves autoscaling policy.

@param name

Required. The "resource name" of the autoscaling policy, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.autoscalingPolicies.get, the resource name of the policy has the following format: projects/{project_id}/regions/{region}/autoscalingPolicies/{policy_id} For projects.locations.autoscalingPolicies.get, the resource name of the policy has the following format: projects/{project_id}/locations/{location}/autoscalingPolicies/{policy_id}

projectsRegionsAutoscalingPoliciesGetIamPolicy(resource: string, req: GetIamPolicyRequest): Promise<Policy>

[src]

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

@param resource

REQUIRED: The resource for which the policy is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

projectsRegionsAutoscalingPoliciesList(parent: string, opts?: ProjectsRegionsAutoscalingPoliciesListOptions): Promise<ListAutoscalingPoliciesResponse>

[src]

Lists autoscaling policies in the project.

@param parent

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}

projectsRegionsAutoscalingPoliciesSetIamPolicy(resource: string, req: SetIamPolicyRequest): Promise<Policy>

[src]

Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

@param resource

REQUIRED: The resource for which the policy is being specified. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

projectsRegionsAutoscalingPoliciesTestIamPermissions(resource: string, req: TestIamPermissionsRequest): Promise<TestIamPermissionsResponse>

[src]

@param resource

REQUIRED: The resource for which the policy detail is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

projectsRegionsAutoscalingPoliciesUpdate(name: string, req: AutoscalingPolicy): Promise<AutoscalingPolicy>

[src]

Updates (replaces) autoscaling policy.Disabled check for update_mask, because all updates will be full replacements.

@param name

projectsRegionsClustersCreate(projectId: string, region: string, req: Cluster, opts?: ProjectsRegionsClustersCreateOptions): Promise<Operation>

[src]

Creates a cluster in a project. The returned Operation.metadata will be ClusterOperationMetadata (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#clusteroperationmetadata).

@param projectId

Required. The ID of the Google Cloud Platform project that the cluster belongs to.

@param region

Required. The Dataproc region in which to handle the request.

projectsRegionsClustersDelete(clusterName: string, projectId: string, region: string, opts?: ProjectsRegionsClustersDeleteOptions): Promise<Operation>

[src]

Deletes a cluster in a project. The returned Operation.metadata will be ClusterOperationMetadata (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#clusteroperationmetadata).

@param clusterName

Required. The cluster name.

@param projectId

Required. The ID of the Google Cloud Platform project that the cluster belongs to.

@param region

Required. The Dataproc region in which to handle the request.

projectsRegionsClustersDiagnose(clusterName: string, projectId: string, region: string, req: DiagnoseClusterRequest): Promise<Operation>

[src]

Gets cluster diagnostic information. The returned Operation.metadata will be ClusterOperationMetadata (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#clusteroperationmetadata). After the operation completes, Operation.response contains DiagnoseClusterResults (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#diagnoseclusterresults).

@param clusterName

Required. The cluster name.

@param projectId

Required. The ID of the Google Cloud Platform project that the cluster belongs to.

@param region

Required. The Dataproc region in which to handle the request.

projectsRegionsClustersGet(clusterName: string, projectId: string, region: string): Promise<Cluster>

[src]

Gets the resource representation for a cluster in a project.

@param clusterName

Required. The cluster name.

@param projectId

Required. The ID of the Google Cloud Platform project that the cluster belongs to.

@param region

Required. The Dataproc region in which to handle the request.

projectsRegionsClustersGetIamPolicy(resource: string, req: GetIamPolicyRequest): Promise<Policy>

[src]

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

@param resource

REQUIRED: The resource for which the policy is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

projectsRegionsClustersInjectCredentials(cluster: string, project: string, region: string, req: InjectCredentialsRequest): Promise<Operation>

[src]

Inject encrypted credentials into all of the VMs in a cluster.The target cluster must be a personal auth cluster assigned to the user who is issuing the RPC.

@param cluster

Required. The cluster, in the form clusters/.

@param project

Required. The ID of the Google Cloud Platform project the cluster belongs to, of the form projects/.

@param region

Required. The region containing the cluster, of the form regions/.

projectsRegionsClustersList(projectId: string, region: string, opts?: ProjectsRegionsClustersListOptions): Promise<ListClustersResponse>

[src]

Lists all regions/{region}/clusters in a project alphabetically.

@param projectId

Required. The ID of the Google Cloud Platform project that the cluster belongs to.

@param region

Required. The Dataproc region in which to handle the request.

projectsRegionsClustersNodeGroupsCreate(parent: string, req: NodeGroup, opts?: ProjectsRegionsClustersNodeGroupsCreateOptions): Promise<Operation>

[src]

Creates a node group in a cluster. The returned Operation.metadata is NodeGroupOperationMetadata (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#nodegroupoperationmetadata).

@param parent

Required. The parent resource where this node group will be created. Format: projects/{project}/regions/{region}/clusters/{cluster}

projectsRegionsClustersNodeGroupsGet(name: string): Promise<NodeGroup>

[src]

Gets the resource representation for a node group in a cluster.

@param name

Required. The name of the node group to retrieve. Format: projects/{project}/regions/{region}/clusters/{cluster}/nodeGroups/{nodeGroup}

projectsRegionsClustersNodeGroupsRepair(name: string, req: RepairNodeGroupRequest): Promise<Operation>

[src]

Repair nodes in a node group.

@param name

Required. The name of the node group to resize. Format: projects/{project}/regions/{region}/clusters/{cluster}/nodeGroups/{nodeGroup}

projectsRegionsClustersNodeGroupsResize(name: string, req: ResizeNodeGroupRequest): Promise<Operation>

[src]

Resizes a node group in a cluster. The returned Operation.metadata is NodeGroupOperationMetadata (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#nodegroupoperationmetadata).

@param name

Required. The name of the node group to resize. Format: projects/{project}/regions/{region}/clusters/{cluster}/nodeGroups/{nodeGroup}

projectsRegionsClustersPatch(clusterName: string, projectId: string, region: string, req: Cluster, opts?: ProjectsRegionsClustersPatchOptions): Promise<Operation>

[src]

Updates a cluster in a project. The returned Operation.metadata will be ClusterOperationMetadata (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#clusteroperationmetadata). The cluster must be in a RUNNING state or an error is returned.

@param clusterName

Required. The cluster name.

@param projectId

Required. The ID of the Google Cloud Platform project the cluster belongs to.

@param region

Required. The Dataproc region in which to handle the request.

projectsRegionsClustersRepair(clusterName: string, projectId: string, region: string, req: RepairClusterRequest): Promise<Operation>

[src]

Repairs a cluster.

@param clusterName

Required. The cluster name.

@param projectId

Required. The ID of the Google Cloud Platform project the cluster belongs to.

@param region

Required. The Dataproc region in which to handle the request.

projectsRegionsClustersSetIamPolicy(resource: string, req: SetIamPolicyRequest): Promise<Policy>

[src]

Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

@param resource

REQUIRED: The resource for which the policy is being specified. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

projectsRegionsClustersStart(clusterName: string, projectId: string, region: string, req: StartClusterRequest): Promise<Operation>

[src]

Starts a cluster in a project.

@param clusterName

Required. The cluster name.

@param projectId

Required. The ID of the Google Cloud Platform project the cluster belongs to.

@param region

Required. The Dataproc region in which to handle the request.

projectsRegionsClustersStop(clusterName: string, projectId: string, region: string, req: StopClusterRequest): Promise<Operation>

[src]

Stops a cluster in a project.

@param clusterName

Required. The cluster name.

@param projectId

Required. The ID of the Google Cloud Platform project the cluster belongs to.

@param region

Required. The Dataproc region in which to handle the request.

projectsRegionsClustersTestIamPermissions(resource: string, req: TestIamPermissionsRequest): Promise<TestIamPermissionsResponse>

[src]

@param resource

REQUIRED: The resource for which the policy detail is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

projectsRegionsJobsCancel(jobId: string, projectId: string, region: string, req: CancelJobRequest): Promise<Job>

[src]

Starts a job cancellation request. To access the job resource after cancellation, call regions/{region}/jobs.list (https://cloud.google.com/dataproc/docs/reference/rest/v1/projects.regions.jobs/list) or regions/{region}/jobs.get (https://cloud.google.com/dataproc/docs/reference/rest/v1/projects.regions.jobs/get).

@param jobId

Required. The job ID.

@param projectId

Required. The ID of the Google Cloud Platform project that the job belongs to.

@param region

Required. The Dataproc region in which to handle the request.

projectsRegionsJobsDelete(jobId: string, projectId: string, region: string): Promise<Empty>

[src]

Deletes the job from the project. If the job is active, the delete fails, and the response returns FAILED_PRECONDITION.

@param jobId

Required. The job ID.

@param projectId

Required. The ID of the Google Cloud Platform project that the job belongs to.

@param region

Required. The Dataproc region in which to handle the request.

projectsRegionsJobsGet(jobId: string, projectId: string, region: string): Promise<Job>

[src]

Gets the resource representation for a job in a project.

@param jobId

Required. The job ID.

@param projectId

Required. The ID of the Google Cloud Platform project that the job belongs to.

@param region

Required. The Dataproc region in which to handle the request.

projectsRegionsJobsGetIamPolicy(resource: string, req: GetIamPolicyRequest): Promise<Policy>

[src]

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

@param resource

REQUIRED: The resource for which the policy is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

projectsRegionsJobsList(projectId: string, region: string, opts?: ProjectsRegionsJobsListOptions): Promise<ListJobsResponse>

[src]

Lists regions/{region}/jobs in a project.

@param projectId

Required. The ID of the Google Cloud Platform project that the job belongs to.

@param region

Required. The Dataproc region in which to handle the request.

projectsRegionsJobsPatch(jobId: string, projectId: string, region: string, req: Job, opts?: ProjectsRegionsJobsPatchOptions): Promise<Job>

[src]

Updates a job in a project.

@param jobId

Required. The job ID.

@param projectId

Required. The ID of the Google Cloud Platform project that the job belongs to.

@param region

Required. The Dataproc region in which to handle the request.

projectsRegionsJobsSetIamPolicy(resource: string, req: SetIamPolicyRequest): Promise<Policy>

[src]

Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

@param resource

REQUIRED: The resource for which the policy is being specified. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

projectsRegionsJobsSubmit(projectId: string, region: string, req: SubmitJobRequest): Promise<Job>

[src]

Submits a job to a cluster.

@param projectId

Required. The ID of the Google Cloud Platform project that the job belongs to.

@param region

Required. The Dataproc region in which to handle the request.

projectsRegionsJobsSubmitAsOperation(projectId: string, region: string, req: SubmitJobRequest): Promise<Operation>

[src]

Submits job to a cluster.

@param projectId

Required. The ID of the Google Cloud Platform project that the job belongs to.

@param region

Required. The Dataproc region in which to handle the request.

projectsRegionsJobsTestIamPermissions(resource: string, req: TestIamPermissionsRequest): Promise<TestIamPermissionsResponse>

[src]

@param resource

REQUIRED: The resource for which the policy detail is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

projectsRegionsOperationsCancel(name: string): Promise<Empty>

[src]

@param name

The name of the operation resource to be cancelled.

projectsRegionsOperationsDelete(name: string): Promise<Empty>

[src]

@param name

The name of the operation resource to be deleted.

projectsRegionsOperationsGet(name: string): Promise<Operation>

[src]

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

@param name

The name of the operation resource.

projectsRegionsOperationsGetIamPolicy(resource: string, req: GetIamPolicyRequest): Promise<Policy>

[src]

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

@param resource

REQUIRED: The resource for which the policy is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

projectsRegionsOperationsList(name: string, opts?: ProjectsRegionsOperationsListOptions): Promise<ListOperationsResponse>

[src]

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

@param name

The name of the operation's parent resource.

projectsRegionsOperationsSetIamPolicy(resource: string, req: SetIamPolicyRequest): Promise<Policy>

[src]

Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

@param resource

REQUIRED: The resource for which the policy is being specified. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

projectsRegionsOperationsTestIamPermissions(resource: string, req: TestIamPermissionsRequest): Promise<TestIamPermissionsResponse>

[src]

@param resource

REQUIRED: The resource for which the policy detail is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

projectsRegionsWorkflowTemplatesCreate(parent: string, req: WorkflowTemplate): Promise<WorkflowTemplate>

[src]

Creates new workflow template.

@param parent

projectsRegionsWorkflowTemplatesDelete(name: string, opts?: ProjectsRegionsWorkflowTemplatesDeleteOptions): Promise<Empty>

[src]

Deletes a workflow template. It does not cancel in-progress workflows.

@param name

projectsRegionsWorkflowTemplatesGet(name: string, opts?: ProjectsRegionsWorkflowTemplatesGetOptions): Promise<WorkflowTemplate>

[src]

Retrieves the latest workflow template.Can retrieve previously instantiated template by specifying optional version parameter.

@param name

projectsRegionsWorkflowTemplatesGetIamPolicy(resource: string, req: GetIamPolicyRequest): Promise<Policy>

[src]

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

@param resource

REQUIRED: The resource for which the policy is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

projectsRegionsWorkflowTemplatesInstantiate(name: string, req: InstantiateWorkflowTemplateRequest): Promise<Operation>

[src]

@param name

projectsRegionsWorkflowTemplatesInstantiateInline(parent: string, req: WorkflowTemplate, opts?: ProjectsRegionsWorkflowTemplatesInstantiateInlineOptions): Promise<Operation>

[src]

@param parent

projectsRegionsWorkflowTemplatesList(parent: string, opts?: ProjectsRegionsWorkflowTemplatesListOptions): Promise<ListWorkflowTemplatesResponse>

[src]

Lists workflows that match the specified filter in the request.

@param parent

projectsRegionsWorkflowTemplatesSetIamPolicy(resource: string, req: SetIamPolicyRequest): Promise<Policy>

[src]

Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

@param resource

REQUIRED: The resource for which the policy is being specified. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

projectsRegionsWorkflowTemplatesTestIamPermissions(resource: string, req: TestIamPermissionsRequest): Promise<TestIamPermissionsResponse>

[src]

@param resource

REQUIRED: The resource for which the policy detail is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

projectsRegionsWorkflowTemplatesUpdate(name: string, req: WorkflowTemplate): Promise<WorkflowTemplate>

[src]

Updates (replaces) workflow template. The updated template must contain version that matches the current server version.

@param name