Dataflow

import { Dataflow } from "https://googleapis.deno.dev/v1/dataflow:v1b3.ts";

Manages Google Cloud Dataflow projects on Google Cloud Platform.

class Dataflow {

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

async projectsDeleteSnapshots(projectId: string, opts?: ProjectsDeleteSnapshotsOptions): Promise<DeleteSnapshotResponse>;

async projectsJobsAggregated(projectId: string, opts?: ProjectsJobsAggregatedOptions): Promise<ListJobsResponse>;

async projectsJobsCreate(

projectId: string,

req: Job,

opts?: ProjectsJobsCreateOptions,

): Promise<Job>;

async projectsJobsDebugGetConfig(

jobId: string,

projectId: string,

req: GetDebugConfigRequest,

): Promise<GetDebugConfigResponse>;

async projectsJobsDebugSendCapture(

jobId: string,

projectId: string,

req: SendDebugCaptureRequest,

): Promise<SendDebugCaptureResponse>;

async projectsJobsGet(

jobId: string,

projectId: string,

opts?: ProjectsJobsGetOptions,

): Promise<Job>;

async projectsJobsGetMetrics(

jobId: string,

projectId: string,

opts?: ProjectsJobsGetMetricsOptions,

): Promise<JobMetrics>;

async projectsJobsList(projectId: string, opts?: ProjectsJobsListOptions): Promise<ListJobsResponse>;

async projectsJobsMessagesList(

jobId: string,

projectId: string,

opts?: ProjectsJobsMessagesListOptions,

): Promise<ListJobMessagesResponse>;

async projectsJobsSnapshot(

jobId: string,

projectId: string,

req: SnapshotJobRequest,

): Promise<Snapshot>;

async projectsJobsUpdate(

jobId: string,

projectId: string,

req: Job,

opts?: ProjectsJobsUpdateOptions,

): Promise<Job>;

async projectsJobsWorkItemsLease(

jobId: string,

projectId: string,

req: LeaseWorkItemRequest,

): Promise<LeaseWorkItemResponse>;

async projectsJobsWorkItemsReportStatus(

jobId: string,

projectId: string,

req: ReportWorkItemStatusRequest,

): Promise<ReportWorkItemStatusResponse>;

async projectsLocationsFlexTemplatesLaunch(

location: string,

projectId: string,

req: LaunchFlexTemplateRequest,

): Promise<LaunchFlexTemplateResponse>;

async projectsLocationsJobsCreate(

location: string,

projectId: string,

req: Job,

opts?: ProjectsLocationsJobsCreateOptions,

): Promise<Job>;

async projectsLocationsJobsDebugGetConfig(

jobId: string,

location: string,

projectId: string,

req: GetDebugConfigRequest,

): Promise<GetDebugConfigResponse>;

async projectsLocationsJobsDebugSendCapture(

jobId: string,

location: string,

projectId: string,

req: SendDebugCaptureRequest,

): Promise<SendDebugCaptureResponse>;

async projectsLocationsJobsGet(

jobId: string,

location: string,

projectId: string,

opts?: ProjectsLocationsJobsGetOptions,

): Promise<Job>;

async projectsLocationsJobsGetExecutionDetails(

jobId: string,

location: string,

projectId: string,

opts?: ProjectsLocationsJobsGetExecutionDetailsOptions,

): Promise<JobExecutionDetails>;

async projectsLocationsJobsGetMetrics(

jobId: string,

location: string,

projectId: string,

opts?: ProjectsLocationsJobsGetMetricsOptions,

): Promise<JobMetrics>;

async projectsLocationsJobsList(

location: string,

projectId: string,

opts?: ProjectsLocationsJobsListOptions,

): Promise<ListJobsResponse>;

async projectsLocationsJobsMessagesList(

jobId: string,

location: string,

projectId: string,

opts?: ProjectsLocationsJobsMessagesListOptions,

): Promise<ListJobMessagesResponse>;

async projectsLocationsJobsSnapshot(

jobId: string,

location: string,

projectId: string,

req: SnapshotJobRequest,

): Promise<Snapshot>;

async projectsLocationsJobsSnapshotsList(

jobId: string,

location: string,

projectId: string,

): Promise<ListSnapshotsResponse>;

async projectsLocationsJobsStagesGetExecutionDetails(

jobId: string,

location: string,

projectId: string,

stageId: string,

opts?: ProjectsLocationsJobsStagesGetExecutionDetailsOptions,

): Promise<StageExecutionDetails>;

async projectsLocationsJobsUpdate(

jobId: string,

location: string,

projectId: string,

req: Job,

opts?: ProjectsLocationsJobsUpdateOptions,

): Promise<Job>;

async projectsLocationsJobsWorkItemsLease(

jobId: string,

location: string,

projectId: string,

req: LeaseWorkItemRequest,

): Promise<LeaseWorkItemResponse>;

async projectsLocationsJobsWorkItemsReportStatus(

jobId: string,

location: string,

projectId: string,

req: ReportWorkItemStatusRequest,

): Promise<ReportWorkItemStatusResponse>;

async projectsLocationsSnapshotsDelete(

location: string,

projectId: string,

snapshotId: string,

): Promise<DeleteSnapshotResponse>;

async projectsLocationsSnapshotsGet(

location: string,

projectId: string,

snapshotId: string,

): Promise<Snapshot>;

async projectsLocationsSnapshotsList(

location: string,

projectId: string,

opts?: ProjectsLocationsSnapshotsListOptions,

): Promise<ListSnapshotsResponse>;

async projectsLocationsTemplatesCreate(

location: string,

projectId: string,

req: CreateJobFromTemplateRequest,

): Promise<Job>;

async projectsLocationsTemplatesGet(

location: string,

projectId: string,

opts?: ProjectsLocationsTemplatesGetOptions,

): Promise<GetTemplateResponse>;

async projectsLocationsTemplatesLaunch(

location: string,

projectId: string,

req: LaunchTemplateParameters,

opts?: ProjectsLocationsTemplatesLaunchOptions,

): Promise<LaunchTemplateResponse>;

async projectsLocationsWorkerMessages(

location: string,

projectId: string,

req: SendWorkerMessagesRequest,

): Promise<SendWorkerMessagesResponse>;

async projectsSnapshotsGet(

projectId: string,

snapshotId: string,

opts?: ProjectsSnapshotsGetOptions,

): Promise<Snapshot>;

async projectsSnapshotsList(projectId: string, opts?: ProjectsSnapshotsListOptions): Promise<ListSnapshotsResponse>;

async projectsTemplatesCreate(projectId: string, req: CreateJobFromTemplateRequest): Promise<Job>;

async projectsTemplatesGet(projectId: string, opts?: ProjectsTemplatesGetOptions): Promise<GetTemplateResponse>;

async projectsTemplatesLaunch(

projectId: string,

req: LaunchTemplateParameters,

opts?: ProjectsTemplatesLaunchOptions,

): Promise<LaunchTemplateResponse>;

async projectsWorkerMessages(projectId: string, req: SendWorkerMessagesRequest): Promise<SendWorkerMessagesResponse>;

}

§Constructors

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

[src]

§Methods

projectsDeleteSnapshots(projectId: string, opts?: ProjectsDeleteSnapshotsOptions): Promise<DeleteSnapshotResponse>

[src]

Deletes a snapshot.

@param projectId

The ID of the Cloud Platform project that the snapshot belongs to.

projectsJobsAggregated(projectId: string, opts?: ProjectsJobsAggregatedOptions): Promise<ListJobsResponse>

[src]

List the jobs of a project across all regions. Note: This method doesn't support filtering the list of jobs by name.

@param projectId

The project which owns the jobs.

projectsJobsCreate(projectId: string, req: Job, opts?: ProjectsJobsCreateOptions): Promise<Job>

[src]

Creates a Cloud Dataflow job. To create a job, we recommend using projects.locations.jobs.create with a [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). Using projects.jobs.create is not recommended, as your job will always start in us-central1. Do not enter confidential information when you supply string values using the API.

@param projectId

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

projectsJobsDebugGetConfig(jobId: string, projectId: string, req: GetDebugConfigRequest): Promise<GetDebugConfigResponse>

[src]

Get encoded debug configuration for component. Not cacheable.

@param jobId

The job id.

@param projectId

The project id.

projectsJobsDebugSendCapture(jobId: string, projectId: string, req: SendDebugCaptureRequest): Promise<SendDebugCaptureResponse>

[src]

Send encoded debug capture data for component.

@param jobId

The job id.

@param projectId

The project id.

projectsJobsGet(jobId: string, projectId: string, opts?: ProjectsJobsGetOptions): Promise<Job>

[src]

Gets the state of the specified Cloud Dataflow job. To get the state of a job, we recommend using projects.locations.jobs.get with a [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). Using projects.jobs.get is not recommended, as you can only get the state of jobs that are running in us-central1.

@param jobId

The job ID.

@param projectId

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

projectsJobsGetMetrics(jobId: string, projectId: string, opts?: ProjectsJobsGetMetricsOptions): Promise<JobMetrics>

[src]

Request the job status. To request the status of a job, we recommend using projects.locations.jobs.getMetrics with a [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). Using projects.jobs.getMetrics is not recommended, as you can only request the status of jobs that are running in us-central1.

@param jobId

The job to get metrics for.

@param projectId

A project id.

projectsJobsList(projectId: string, opts?: ProjectsJobsListOptions): Promise<ListJobsResponse>

[src]

List the jobs of a project. To list the jobs of a project in a region, we recommend using projects.locations.jobs.list with a [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). To list the all jobs across all regions, use projects.jobs.aggregated. Using projects.jobs.list is not recommended, because you can only get the list of jobs that are running in us-central1. projects.locations.jobs.list and projects.jobs.list support filtering the list of jobs by name. Filtering by name isn't supported by projects.jobs.aggregated.

@param projectId

The project which owns the jobs.

projectsJobsMessagesList(jobId: string, projectId: string, opts?: ProjectsJobsMessagesListOptions): Promise<ListJobMessagesResponse>

[src]

Request the job status. To request the status of a job, we recommend using projects.locations.jobs.messages.list with a [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). Using projects.jobs.messages.list is not recommended, as you can only request the status of jobs that are running in us-central1.

@param jobId

The job to get messages about.

@param projectId

A project id.

projectsJobsSnapshot(jobId: string, projectId: string, req: SnapshotJobRequest): Promise<Snapshot>

[src]

Snapshot the state of a streaming job.

@param jobId

The job to be snapshotted.

@param projectId

The project which owns the job to be snapshotted.

projectsJobsUpdate(jobId: string, projectId: string, req: Job, opts?: ProjectsJobsUpdateOptions): Promise<Job>

[src]

Updates the state of an existing Cloud Dataflow job. To update the state of an existing job, we recommend using projects.locations.jobs.update with a [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). Using projects.jobs.update is not recommended, as you can only update the state of jobs that are running in us-central1.

@param jobId

The job ID.

@param projectId

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

projectsJobsWorkItemsLease(jobId: string, projectId: string, req: LeaseWorkItemRequest): Promise<LeaseWorkItemResponse>

[src]

Leases a dataflow WorkItem to run.

@param jobId

Identifies the workflow job this worker belongs to.

@param projectId

Identifies the project this worker belongs to.

projectsJobsWorkItemsReportStatus(jobId: string, projectId: string, req: ReportWorkItemStatusRequest): Promise<ReportWorkItemStatusResponse>

[src]

Reports the status of dataflow WorkItems leased by a worker.

@param jobId

The job which the WorkItem is part of.

@param projectId

The project which owns the WorkItem's job.

projectsLocationsFlexTemplatesLaunch(location: string, projectId: string, req: LaunchFlexTemplateRequest): Promise<LaunchFlexTemplateResponse>

[src]

Launch a job with a FlexTemplate.

@param location

Required. The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) to which to direct the request. E.g., us-central1, us-west1.

@param projectId

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

projectsLocationsJobsCreate(location: string, projectId: string, req: Job, opts?: ProjectsLocationsJobsCreateOptions): Promise<Job>

[src]

@param location

The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains this job.

@param projectId

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

projectsLocationsJobsDebugGetConfig(jobId: string, location: string, projectId: string, req: GetDebugConfigRequest): Promise<GetDebugConfigResponse>

[src]

Get encoded debug configuration for component. Not cacheable.

@param jobId

The job id.

@param location

The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains the job specified by job_id.

@param projectId

The project id.

projectsLocationsJobsDebugSendCapture(jobId: string, location: string, projectId: string, req: SendDebugCaptureRequest): Promise<SendDebugCaptureResponse>

[src]

Send encoded debug capture data for component.

@param jobId

The job id.

@param location

The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains the job specified by job_id.

@param projectId

The project id.

projectsLocationsJobsGet(jobId: string, location: string, projectId: string, opts?: ProjectsLocationsJobsGetOptions): Promise<Job>

[src]

@param jobId

The job ID.

@param location

The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains this job.

@param projectId

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

projectsLocationsJobsGetExecutionDetails(jobId: string, location: string, projectId: string, opts?: ProjectsLocationsJobsGetExecutionDetailsOptions): Promise<JobExecutionDetails>

[src]

Request detailed information about the execution status of the job. EXPERIMENTAL. This API is subject to change or removal without notice.

@param jobId

The job to get execution details for.

@param location

The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains the job specified by job_id.

@param projectId

A project id.

projectsLocationsJobsGetMetrics(jobId: string, location: string, projectId: string, opts?: ProjectsLocationsJobsGetMetricsOptions): Promise<JobMetrics>

[src]

@param jobId

The job to get metrics for.

@param location

The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains the job specified by job_id.

@param projectId

A project id.

projectsLocationsJobsList(location: string, projectId: string, opts?: ProjectsLocationsJobsListOptions): Promise<ListJobsResponse>

[src]

@param location

The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains this job.

@param projectId

The project which owns the jobs.

projectsLocationsJobsMessagesList(jobId: string, location: string, projectId: string, opts?: ProjectsLocationsJobsMessagesListOptions): Promise<ListJobMessagesResponse>

[src]

@param jobId

The job to get messages about.

@param location

The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains the job specified by job_id.

@param projectId

A project id.

projectsLocationsJobsSnapshot(jobId: string, location: string, projectId: string, req: SnapshotJobRequest): Promise<Snapshot>

[src]

Snapshot the state of a streaming job.

@param jobId

The job to be snapshotted.

@param location

The location that contains this job.

@param projectId

The project which owns the job to be snapshotted.

projectsLocationsJobsSnapshotsList(jobId: string, location: string, projectId: string): Promise<ListSnapshotsResponse>

[src]

Lists snapshots.

@param jobId

If specified, list snapshots created from this job.

@param location

The location to list snapshots in.

@param projectId

The project ID to list snapshots for.

projectsLocationsJobsStagesGetExecutionDetails(jobId: string, location: string, projectId: string, stageId: string, opts?: ProjectsLocationsJobsStagesGetExecutionDetailsOptions): Promise<StageExecutionDetails>

[src]

Request detailed information about the execution status of a stage of the job. EXPERIMENTAL. This API is subject to change or removal without notice.

@param jobId

The job to get execution details for.

@param location

The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains the job specified by job_id.

@param projectId

A project id.

@param stageId

The stage for which to fetch information.

projectsLocationsJobsUpdate(jobId: string, location: string, projectId: string, req: Job, opts?: ProjectsLocationsJobsUpdateOptions): Promise<Job>

[src]

@param jobId

The job ID.

@param location

The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains this job.

@param projectId

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

projectsLocationsJobsWorkItemsLease(jobId: string, location: string, projectId: string, req: LeaseWorkItemRequest): Promise<LeaseWorkItemResponse>

[src]

Leases a dataflow WorkItem to run.

@param jobId

Identifies the workflow job this worker belongs to.

@param location

The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains the WorkItem's job.

@param projectId

Identifies the project this worker belongs to.

projectsLocationsJobsWorkItemsReportStatus(jobId: string, location: string, projectId: string, req: ReportWorkItemStatusRequest): Promise<ReportWorkItemStatusResponse>

[src]

Reports the status of dataflow WorkItems leased by a worker.

@param jobId

The job which the WorkItem is part of.

@param location

The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains the WorkItem's job.

@param projectId

The project which owns the WorkItem's job.

projectsLocationsSnapshotsDelete(location: string, projectId: string, snapshotId: string): Promise<DeleteSnapshotResponse>

[src]

Deletes a snapshot.

@param location

The location that contains this snapshot.

@param projectId

The ID of the Cloud Platform project that the snapshot belongs to.

@param snapshotId

The ID of the snapshot.

projectsLocationsSnapshotsGet(location: string, projectId: string, snapshotId: string): Promise<Snapshot>

[src]

Gets information about a snapshot.

@param location

The location that contains this snapshot.

@param projectId

The ID of the Cloud Platform project that the snapshot belongs to.

@param snapshotId

The ID of the snapshot.

projectsLocationsSnapshotsList(location: string, projectId: string, opts?: ProjectsLocationsSnapshotsListOptions): Promise<ListSnapshotsResponse>

[src]

Lists snapshots.

@param location

The location to list snapshots in.

@param projectId

The project ID to list snapshots for.

projectsLocationsTemplatesCreate(location: string, projectId: string, req: CreateJobFromTemplateRequest): Promise<Job>

[src]

Creates a Cloud Dataflow job from a template. Do not enter confidential information when you supply string values using the API.

@param location

The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) to which to direct the request.

@param projectId

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

projectsLocationsTemplatesGet(location: string, projectId: string, opts?: ProjectsLocationsTemplatesGetOptions): Promise<GetTemplateResponse>

[src]

Get the template associated with a template.

@param location

The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) to which to direct the request.

@param projectId

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

projectsLocationsTemplatesLaunch(location: string, projectId: string, req: LaunchTemplateParameters, opts?: ProjectsLocationsTemplatesLaunchOptions): Promise<LaunchTemplateResponse>

[src]

Launch a template.

@param location

The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) to which to direct the request.

@param projectId

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

projectsLocationsWorkerMessages(location: string, projectId: string, req: SendWorkerMessagesRequest): Promise<SendWorkerMessagesResponse>

[src]

Send a worker_message to the service.

@param location

The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains the job.

@param projectId

The project to send the WorkerMessages to.

projectsSnapshotsGet(projectId: string, snapshotId: string, opts?: ProjectsSnapshotsGetOptions): Promise<Snapshot>

[src]

Gets information about a snapshot.

@param projectId

The ID of the Cloud Platform project that the snapshot belongs to.

@param snapshotId

The ID of the snapshot.

projectsSnapshotsList(projectId: string, opts?: ProjectsSnapshotsListOptions): Promise<ListSnapshotsResponse>

[src]

Lists snapshots.

@param projectId

The project ID to list snapshots for.

projectsTemplatesCreate(projectId: string, req: CreateJobFromTemplateRequest): Promise<Job>

[src]

Creates a Cloud Dataflow job from a template. Do not enter confidential information when you supply string values using the API.

@param projectId

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

projectsTemplatesGet(projectId: string, opts?: ProjectsTemplatesGetOptions): Promise<GetTemplateResponse>

[src]

Get the template associated with a template.

@param projectId

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

projectsTemplatesLaunch(projectId: string, req: LaunchTemplateParameters, opts?: ProjectsTemplatesLaunchOptions): Promise<LaunchTemplateResponse>

[src]

Launch a template.

@param projectId

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

projectsWorkerMessages(projectId: string, req: SendWorkerMessagesRequest): Promise<SendWorkerMessagesResponse>

[src]

Send a worker_message to the service.

@param projectId

The project to send the WorkerMessages to.