DefinitelyTyped/types/gapi.client.dataflow/index.d.ts

// Type definitions for non-npm package Google Google Dataflow API v1b3 1.0
// Project: https://cloud.google.com/dataflow
// Definitions by: Bolisov Alexey <https://github.com/Bolisov>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
// TypeScript Version: 2.3

// IMPORTANT
// This file was generated by https://github.com/Bolisov/google-api-typings-generator. Please do not edit it manually.
// In case of any problems please post issue to https://github.com/Bolisov/google-api-typings-generator
// Generated from: https://dataflow.googleapis.com/$discovery/rest?version=v1b3

/// <reference types="gapi.client" />

declare namespace gapi.client {
    /** Load Google Dataflow API v1b3 */
    function load(name: "dataflow", version: "v1b3"): PromiseLike<void>;
    function load(name: "dataflow", version: "v1b3", callback: () => any): void;

    const projects: dataflow.ProjectsResource;

    namespace dataflow {
        interface ApproximateProgress {
            /** Obsolete. */
            percentComplete?: number;
            /** Obsolete. */
            position?: Position;
            /** Obsolete. */
            remainingTime?: string;
        }
        interface ApproximateReportedProgress {
            /**
             * Total amount of parallelism in the portion of input of this task that has
             * already been consumed and is no longer active. In the first two examples
             * above (see remaining_parallelism), the value should be 29 or 2
             * respectively.  The sum of remaining_parallelism and consumed_parallelism
             * should equal the total amount of parallelism in this work item.  If
             * specified, must be finite.
             */
            consumedParallelism?: ReportedParallelism;
            /**
             * Completion as fraction of the input consumed, from 0.0 (beginning, nothing
             * consumed), to 1.0 (end of the input, entire input consumed).
             */
            fractionConsumed?: number;
            /** A Position within the work to represent a progress. */
            position?: Position;
            /**
             * Total amount of parallelism in the input of this task that remains,
             * (i.e. can be delegated to this task and any new tasks via dynamic
             * splitting). Always at least 1 for non-finished work items and 0 for
             * finished.
             *
             * "Amount of parallelism" refers to how many non-empty parts of the input
             * can be read in parallel. This does not necessarily equal number
             * of records. An input that can be read in parallel down to the
             * individual records is called "perfectly splittable".
             * An example of non-perfectly parallelizable input is a block-compressed
             * file format where a block of records has to be read as a whole,
             * but different blocks can be read in parallel.
             *
             * Examples:
             * &#42; If we are processing record #30 (starting at 1) out of 50 in a perfectly
             * splittable 50-record input, this value should be 21 (20 remaining + 1
             * current).
             * &#42; If we are reading through block 3 in a block-compressed file consisting
             * of 5 blocks, this value should be 3 (since blocks 4 and 5 can be
             * processed in parallel by new tasks via dynamic splitting and the current
             * task remains processing block 3).
             * &#42; If we are reading through the last block in a block-compressed file,
             * or reading or processing the last record in a perfectly splittable
             * input, this value should be 1, because apart from the current task, no
             * additional remainder can be split off.
             */
            remainingParallelism?: ReportedParallelism;
        }
        interface ApproximateSplitRequest {
            /**
             * A fraction at which to split the work item, from 0.0 (beginning of the
             * input) to 1.0 (end of the input).
             */
            fractionConsumed?: number;
            /** A Position at which to split the work item. */
            position?: Position;
        }
        interface AutoscalingEvent {
            /** The current number of workers the job has. */
            currentNumWorkers?: string;
            /**
             * A message describing why the system decided to adjust the current
             * number of workers, why it failed, or why the system decided to
             * not make any changes to the number of workers.
             */
            description?: StructuredMessage;
            /** The type of autoscaling event to report. */
            eventType?: string;
            /** The target number of workers the worker pool wants to resize to use. */
            targetNumWorkers?: string;
            /**
             * The time this event was emitted to indicate a new target or current
             * num_workers value.
             */
            time?: string;
        }
        interface AutoscalingSettings {
            /** The algorithm to use for autoscaling. */
            algorithm?: string;
            /** The maximum number of workers to cap scaling at. */
            maxNumWorkers?: number;
        }
        interface CPUTime {
            /**
             * Average CPU utilization rate (% non-idle cpu / second) since previous
             * sample.
             */
            rate?: number;
            /** Timestamp of the measurement. */
            timestamp?: string;
            /**
             * Total active CPU time across all cores (ie., non-idle) in milliseconds
             * since start-up.
             */
            totalMs?: string;
        }
        interface ComponentSource {
            /** Dataflow service generated name for this source. */
            name?: string;
            /**
             * User name for the original user transform or collection with which this
             * source is most closely associated.
             */
            originalTransformOrCollection?: string;
            /** Human-readable name for this transform; may be user or system generated. */
            userName?: string;
        }
        interface ComponentTransform {
            /** Dataflow service generated name for this source. */
            name?: string;
            /**
             * User name for the original user transform with which this transform is
             * most closely associated.
             */
            originalTransform?: string;
            /** Human-readable name for this transform; may be user or system generated. */
            userName?: string;
        }
        interface ComputationTopology {
            /** The ID of the computation. */
            computationId?: string;
            /** The inputs to the computation. */
            inputs?: StreamLocation[];
            /** The key ranges processed by the computation. */
            keyRanges?: KeyRangeLocation[];
            /** The outputs from the computation. */
            outputs?: StreamLocation[];
            /** The state family values. */
            stateFamilies?: StateFamilyConfig[];
            /** The system stage name. */
            systemStageName?: string;
        }
        interface ConcatPosition {
            /** Index of the inner source. */
            index?: number;
            /** Position within the inner source. */
            position?: Position;
        }
        interface CounterMetadata {
            /** Human-readable description of the counter semantics. */
            description?: string;
            /** Counter aggregation kind. */
            kind?: string;
            /** A string referring to the unit type. */
            otherUnits?: string;
            /** System defined Units, see above enum. */
            standardUnits?: string;
        }
        interface CounterStructuredName {
            /** Name of the optimized step being executed by the workers. */
            componentStepName?: string;
            /** Name of the stage. An execution step contains multiple component steps. */
            executionStepName?: string;
            /**
             * Counter name. Not necessarily globally-unique, but unique within the
             * context of the other fields.
             * Required.
             */
            name?: string;
            /** One of the standard Origins defined above. */
            origin?: string;
            /** A string containing a more specific namespace of the counter's origin. */
            originNamespace?: string;
            /** The GroupByKey step name from the original graph. */
            originalShuffleStepName?: string;
            /**
             * System generated name of the original step in the user's graph, before
             * optimization.
             */
            originalStepName?: string;
            /** Portion of this counter, either key or value. */
            portion?: string;
            /**
             * ID of a side input being read from/written to. Side inputs are identified
             * by a pair of (reader, input_index). The reader is usually equal to the
             * original name, but it may be different, if a ParDo emits it's Iterator /
             * Map side input object.
             */
            sideInput?: SideInputId;
            /** ID of a particular worker. */
            workerId?: string;
        }
        interface CounterStructuredNameAndMetadata {
            /** Metadata associated with a counter */
            metadata?: CounterMetadata;
            /** Structured name of the counter. */
            name?: CounterStructuredName;
        }
        interface CounterUpdate {
            /** Boolean value for And, Or. */
            boolean?: boolean;
            /**
             * True if this counter is reported as the total cumulative aggregate
             * value accumulated since the worker started working on this WorkItem.
             * By default this is false, indicating that this counter is reported
             * as a delta.
             */
            cumulative?: boolean;
            /** Distribution data */
            distribution?: DistributionUpdate;
            /** Floating point value for Sum, Max, Min. */
            floatingPoint?: number;
            /** List of floating point numbers, for Set. */
            floatingPointList?: FloatingPointList;
            /** Floating point mean aggregation value for Mean. */
            floatingPointMean?: FloatingPointMean;
            /** Integer value for Sum, Max, Min. */
            integer?: SplitInt64;
            /** List of integers, for Set. */
            integerList?: IntegerList;
            /** Integer mean aggregation value for Mean. */
            integerMean?: IntegerMean;
            /** Value for internally-defined counters used by the Dataflow service. */
            internal?: any;
            /** Counter name and aggregation type. */
            nameAndKind?: NameAndKind;
            /**
             * The service-generated short identifier for this counter.
             * The short_id -> (name, metadata) mapping is constant for the lifetime of
             * a job.
             */
            shortId?: string;
            /** List of strings, for Set. */
            stringList?: StringList;
            /** Counter structured name and metadata. */
            structuredNameAndMetadata?: CounterStructuredNameAndMetadata;
        }
        interface CreateJobFromTemplateRequest {
            /** The runtime environment for the job. */
            environment?: RuntimeEnvironment;
            /**
             * Required. A Cloud Storage path to the template from which to
             * create the job.
             * Must be a valid Cloud Storage URL, beginning with `gs://`.
             */
            gcsPath?: string;
            /** Required. The job name to use for the created job. */
            jobName?: string;
            /** The location to which to direct the request. */
            location?: string;
            /** The runtime parameters to pass to the job. */
            parameters?: Record<string, string>;
        }
        interface CustomSourceLocation {
            /** Whether this source is stateful. */
            stateful?: boolean;
        }
        interface DataDiskAssignment {
            /**
             * Mounted data disks. The order is important a data disk's 0-based index in
             * this list defines which persistent directory the disk is mounted to, for
             * example the list of { "myproject-1014-104817-4c2-harness-0-disk-0" },
             * { "myproject-1014-104817-4c2-harness-0-disk-1" }.
             */
            dataDisks?: string[];
            /**
             * VM instance name the data disks mounted to, for example
             * "myproject-1014-104817-4c2-harness-0".
             */
            vmInstance?: string;
        }
        interface DerivedSource {
            /** What source to base the produced source on (if any). */
            derivationMode?: string;
            /** Specification of the source. */
            source?: Source;
        }
        interface Disk {
            /**
             * Disk storage type, as defined by Google Compute Engine.  This
             * must be a disk type appropriate to the project and zone in which
             * the workers will run.  If unknown or unspecified, the service
             * will attempt to choose a reasonable default.
             *
             * For example, the standard persistent disk type is a resource name
             * typically ending in "pd-standard".  If SSD persistent disks are
             * available, the resource name typically ends with "pd-ssd".  The
             * actual valid values are defined the Google Compute Engine API,
             * not by the Cloud Dataflow API; consult the Google Compute Engine
             * documentation for more information about determining the set of
             * available disk types for a particular project and zone.
             *
             * Google Compute Engine Disk types are local to a particular
             * project in a particular zone, and so the resource name will
             * typically look something like this:
             *
             * compute.googleapis.com/projects/project-id/zones/zone/diskTypes/pd-standard
             */
            diskType?: string;
            /** Directory in a VM where disk is mounted. */
            mountPoint?: string;
            /**
             * Size of disk in GB.  If zero or unspecified, the service will
             * attempt to choose a reasonable default.
             */
            sizeGb?: number;
        }
        interface DisplayData {
            /** Contains value if the data is of a boolean type. */
            boolValue?: boolean;
            /** Contains value if the data is of duration type. */
            durationValue?: string;
            /** Contains value if the data is of float type. */
            floatValue?: number;
            /** Contains value if the data is of int64 type. */
            int64Value?: string;
            /** Contains value if the data is of java class type. */
            javaClassValue?: string;
            /**
             * The key identifying the display data.
             * This is intended to be used as a label for the display data
             * when viewed in a dax monitoring system.
             */
            key?: string;
            /** An optional label to display in a dax UI for the element. */
            label?: string;
            /**
             * The namespace for the key. This is usually a class name or programming
             * language namespace (i.e. python module) which defines the display data.
             * This allows a dax monitoring system to specially handle the data
             * and perform custom rendering.
             */
            namespace?: string;
            /**
             * A possible additional shorter value to display.
             * For example a java_class_name_value of com.mypackage.MyDoFn
             * will be stored with MyDoFn as the short_str_value and
             * com.mypackage.MyDoFn as the java_class_name value.
             * short_str_value can be displayed and java_class_name_value
             * will be displayed as a tooltip.
             */
            shortStrValue?: string;
            /** Contains value if the data is of string type. */
            strValue?: string;
            /** Contains value if the data is of timestamp type. */
            timestampValue?: string;
            /** An optional full URL. */
            url?: string;
        }
        interface DistributionUpdate {
            /** The count of the number of elements present in the distribution. */
            count?: SplitInt64;
            /** (Optional) Histogram of value counts for the distribution. */
            histogram?: Histogram;
            /** The maximum value present in the distribution. */
            max?: SplitInt64;
            /** The minimum value present in the distribution. */
            min?: SplitInt64;
            /**
             * Use an int64 since we'd prefer the added precision. If overflow is a common
             * problem we can detect it and use an additional int64 or a double.
             */
            sum?: SplitInt64;
            /** Use a double since the sum of squares is likely to overflow int64. */
            sumOfSquares?: number;
        }
        interface DynamicSourceSplit {
            /**
             * Primary part (continued to be processed by worker).
             * Specified relative to the previously-current source.
             * Becomes current.
             */
            primary?: DerivedSource;
            /**
             * Residual part (returned to the pool of work).
             * Specified relative to the previously-current source.
             */
            residual?: DerivedSource;
        }
        interface Environment {
            /**
             * The type of cluster manager API to use.  If unknown or
             * unspecified, the service will attempt to choose a reasonable
             * default.  This should be in the form of the API service name,
             * e.g. "compute.googleapis.com".
             */
            clusterManagerApiService?: string;
            /**
             * The dataset for the current project where various workflow
             * related tables are stored.
             *
             * The supported resource type is:
             *
             * Google BigQuery:
             * bigquery.googleapis.com/{dataset}
             */
            dataset?: string;
            /** The list of experiments to enable. */
            experiments?: string[];
            /** Experimental settings. */
            internalExperiments?: Record<string, any>;
            /**
             * The Cloud Dataflow SDK pipeline options specified by the user. These
             * options are passed through the service and are used to recreate the
             * SDK pipeline options on the worker in a language agnostic and platform
             * independent way.
             */
            sdkPipelineOptions?: Record<string, any>;
            /** Identity to run virtual machines as. Defaults to the default account. */
            serviceAccountEmail?: string;
            /**
             * The prefix of the resources the system should use for temporary
             * storage.  The system will append the suffix "/temp-{JOBNAME} to
             * this resource prefix, where {JOBNAME} is the value of the
             * job_name field.  The resulting bucket and object prefix is used
             * as the prefix of the resources used to store temporary data
             * needed during the job execution.  NOTE: This will override the
             * value in taskrunner_settings.
             * The supported resource type is:
             *
             * Google Cloud Storage:
             *
             * storage.googleapis.com/{bucket}/{object}
             * bucket.storage.googleapis.com/{object}
             */
            tempStoragePrefix?: string;
            /** A description of the process that generated the request. */
            userAgent?: Record<string, any>;
            /**
             * A structure describing which components and their versions of the service
             * are required in order to run the job.
             */
            version?: Record<string, any>;
            /**
             * The worker pools. At least one "harness" worker pool must be
             * specified in order for the job to have workers.
             */
            workerPools?: WorkerPool[];
        }
        interface ExecutionStageState {
            /** The time at which the stage transitioned to this state. */
            currentStateTime?: string;
            /** The name of the execution stage. */
            executionStageName?: string;
            /** Executions stage states allow the same set of values as JobState. */
            executionStageState?: string;
        }
        interface ExecutionStageSummary {
            /** Collections produced and consumed by component transforms of this stage. */
            componentSource?: ComponentSource[];
            /** Transforms that comprise this execution stage. */
            componentTransform?: ComponentTransform[];
            /** Dataflow service generated id for this stage. */
            id?: string;
            /** Input sources for this stage. */
            inputSource?: StageSource[];
            /** Type of tranform this stage is executing. */
            kind?: string;
            /** Dataflow service generated name for this stage. */
            name?: string;
            /** Output sources for this stage. */
            outputSource?: StageSource[];
        }
        interface FailedLocation {
            /** The name of the failed location. */
            name?: string;
        }
        interface FlattenInstruction {
            /** Describes the inputs to the flatten instruction. */
            inputs?: InstructionInput[];
        }
        interface FloatingPointList {
            /** Elements of the list. */
            elements?: number[];
        }
        interface FloatingPointMean {
            /** The number of values being aggregated. */
            count?: SplitInt64;
            /** The sum of all values being aggregated. */
            sum?: number;
        }
        interface GetDebugConfigRequest {
            /**
             * The internal component id for which debug configuration is
             * requested.
             */
            componentId?: string;
            /** The location which contains the job specified by job_id. */
            location?: string;
            /** The worker id, i.e., VM hostname. */
            workerId?: string;
        }
        interface GetDebugConfigResponse {
            /** The encoded debug configuration for the requested component. */
            config?: string;
        }
        interface GetTemplateResponse {
            /**
             * The template metadata describing the template name, available
             * parameters, etc.
             */
            metadata?: TemplateMetadata;
            /**
             * The status of the get template request. Any problems with the
             * request will be indicated in the error_details.
             */
            status?: Status;
        }
        interface Histogram {
            /**
             * Counts of values in each bucket. For efficiency, prefix and trailing
             * buckets with count = 0 are elided. Buckets can store the full range of
             * values of an unsigned long, with ULLONG_MAX falling into the 59th bucket
             * with range [1e19, 2e19).
             */
            bucketCounts?: string[];
            /**
             * Starting index of first stored bucket. The non-inclusive upper-bound of
             * the ith bucket is given by:
             * pow(10,(i-first_bucket_offset)/3) &#42; (1,2,5)[(i-first_bucket_offset)%3]
             */
            firstBucketOffset?: number;
        }
        interface InstructionInput {
            /** The output index (origin zero) within the producer. */
            outputNum?: number;
            /**
             * The index (origin zero) of the parallel instruction that produces
             * the output to be consumed by this input.  This index is relative
             * to the list of instructions in this input's instruction's
             * containing MapTask.
             */
            producerInstructionIndex?: number;
        }
        interface InstructionOutput {
            /** The codec to use to encode data being written via this output. */
            codec?: Record<string, any>;
            /** The user-provided name of this output. */
            name?: string;
            /**
             * For system-generated byte and mean byte metrics, certain instructions
             * should only report the key size.
             */
            onlyCountKeyBytes?: boolean;
            /**
             * For system-generated byte and mean byte metrics, certain instructions
             * should only report the value size.
             */
            onlyCountValueBytes?: boolean;
            /**
             * System-defined name for this output in the original workflow graph.
             * Outputs that do not contribute to an original instruction do not set this.
             */
            originalName?: string;
            /**
             * System-defined name of this output.
             * Unique across the workflow.
             */
            systemName?: string;
        }
        interface IntegerList {
            /** Elements of the list. */
            elements?: SplitInt64[];
        }
        interface IntegerMean {
            /** The number of values being aggregated. */
            count?: SplitInt64;
            /** The sum of all values being aggregated. */
            sum?: SplitInt64;
        }
        interface Job {
            /**
             * The client's unique identifier of the job, re-used across retried attempts.
             * If this field is set, the service will ensure its uniqueness.
             * The request to create a job will fail if the service has knowledge of a
             * previously submitted job with the same client's ID and job name.
             * The caller may use this field to ensure idempotence of job
             * creation across retried attempts to create a job.
             * By default, the field is empty and, in that case, the service ignores it.
             */
            clientRequestId?: string;
            /**
             * The timestamp when the job was initially created. Immutable and set by the
             * Cloud Dataflow service.
             */
            createTime?: string;
            /**
             * The current state of the job.
             *
             * Jobs are created in the `JOB_STATE_STOPPED` state unless otherwise
             * specified.
             *
             * A job in the `JOB_STATE_RUNNING` state may asynchronously enter a
             * terminal state. After a job has reached a terminal state, no
             * further state updates may be made.
             *
             * This field may be mutated by the Cloud Dataflow service;
             * callers cannot mutate it.
             */
            currentState?: string;
            /** The timestamp associated with the current state. */
            currentStateTime?: string;
            /** The environment for the job. */
            environment?: Environment;
            /** Deprecated. */
            executionInfo?: JobExecutionInfo;
            /**
             * The unique ID of this job.
             *
             * This field is set by the Cloud Dataflow service when the Job is
             * created, and is immutable for the life of the job.
             */
            id?: string;
            /**
             * User-defined labels for this job.
             *
             * The labels map can contain no more than 64 entries.  Entries of the labels
             * map are UTF8 strings that comply with the following restrictions:
             *
             * &#42; Keys must conform to regexp:  \p{Ll}\p{Lo}{0,62}
             * &#42; Values must conform to regexp:  [\p{Ll}\p{Lo}\p{N}_-]{0,63}
             * &#42; Both keys and values are additionally constrained to be <= 128 bytes in
             * size.
             */
            labels?: Record<string, string>;
            /** The location that contains this job. */
            location?: string;
            /**
             * The user-specified Cloud Dataflow job name.
             *
             * Only one Job with a given name may exist in a project at any
             * given time. If a caller attempts to create a Job with the same
             * name as an already-existing Job, the attempt returns the
             * existing Job.
             *
             * The name must match the regular expression
             * `[a-z]([-a-z0-9]{0,38}[a-z0-9])?`
             */
            name?: string;
            /**
             * Preliminary field: The format of this data may change at any time.
             * A description of the user pipeline and stages through which it is executed.
             * Created by Cloud Dataflow service.  Only retrieved with
             * JOB_VIEW_DESCRIPTION or JOB_VIEW_ALL.
             */
            pipelineDescription?: PipelineDescription;
            /** The ID of the Cloud Platform project that the job belongs to. */
            projectId?: string;
            /**
             * If this job is an update of an existing job, this field is the job ID
             * of the job it replaced.
             *
             * When sending a `CreateJobRequest`, you can update a job by specifying it
             * here. The job named here is stopped, and its intermediate state is
             * transferred to this job.
             */
            replaceJobId?: string;
            /**
             * If another job is an update of this job (and thus, this job is in
             * `JOB_STATE_UPDATED`), this field contains the ID of that job.
             */
            replacedByJobId?: string;
            /**
             * The job's requested state.
             *
             * `UpdateJob` may be used to switch between the `JOB_STATE_STOPPED` and
             * `JOB_STATE_RUNNING` states, by setting requested_state.  `UpdateJob` may
             * also be used to directly set a job's requested state to
             * `JOB_STATE_CANCELLED` or `JOB_STATE_DONE`, irrevocably terminating the
             * job if it has not already reached a terminal state.
             */
            requestedState?: string;
            /**
             * This field may be mutated by the Cloud Dataflow service;
             * callers cannot mutate it.
             */
            stageStates?: ExecutionStageState[];
            /** The top-level steps that constitute the entire job. */
            steps?: Step[];
            /**
             * A set of files the system should be aware of that are used
             * for temporary storage. These temporary files will be
             * removed on job completion.
             * No duplicates are allowed.
             * No file patterns are supported.
             *
             * The supported files are:
             *
             * Google Cloud Storage:
             *
             * storage.googleapis.com/{bucket}/{object}
             * bucket.storage.googleapis.com/{object}
             */
            tempFiles?: string[];
            /**
             * The map of transform name prefixes of the job to be replaced to the
             * corresponding name prefixes of the new job.
             */
            transformNameMapping?: Record<string, string>;
            /** The type of Cloud Dataflow job. */
            type?: string;
        }
        interface JobExecutionInfo {
            /** A mapping from each stage to the information about that stage. */
            stages?: Record<string, JobExecutionStageInfo>;
        }
        interface JobExecutionStageInfo {
            /**
             * The steps associated with the execution stage.
             * Note that stages may have several steps, and that a given step
             * might be run by more than one stage.
             */
            stepName?: string[];
        }
        interface JobMessage {
            /** Deprecated. */
            id?: string;
            /** Importance level of the message. */
            messageImportance?: string;
            /** The text of the message. */
            messageText?: string;
            /** The timestamp of the message. */
            time?: string;
        }
        interface JobMetrics {
            /** Timestamp as of which metric values are current. */
            metricTime?: string;
            /** All metrics for this job. */
            metrics?: MetricUpdate[];
        }
        interface KeyRangeDataDiskAssignment {
            /**
             * The name of the data disk where data for this range is stored.
             * This name is local to the Google Cloud Platform project and uniquely
             * identifies the disk within that project, for example
             * "myproject-1014-104817-4c2-harness-0-disk-1".
             */
            dataDisk?: string;
            /** The end (exclusive) of the key range. */
            end?: string;
            /** The start (inclusive) of the key range. */
            start?: string;
        }
        interface KeyRangeLocation {
            /**
             * The name of the data disk where data for this range is stored.
             * This name is local to the Google Cloud Platform project and uniquely
             * identifies the disk within that project, for example
             * "myproject-1014-104817-4c2-harness-0-disk-1".
             */
            dataDisk?: string;
            /**
             * The physical location of this range assignment to be used for
             * streaming computation cross-worker message delivery.
             */
            deliveryEndpoint?: string;
            /**
             * DEPRECATED. The location of the persistent state for this range, as a
             * persistent directory in the worker local filesystem.
             */
            deprecatedPersistentDirectory?: string;
            /** The end (exclusive) of the key range. */
            end?: string;
            /** The start (inclusive) of the key range. */
            start?: string;
        }
        interface LaunchTemplateParameters {
            /** The runtime environment for the job. */
            environment?: RuntimeEnvironment;
            /** Required. The job name to use for the created job. */
            jobName?: string;
            /** The runtime parameters to pass to the job. */
            parameters?: Record<string, string>;
        }
        interface LaunchTemplateResponse {
            /**
             * The job that was launched, if the request was not a dry run and
             * the job was successfully launched.
             */
            job?: Job;
        }
        interface LeaseWorkItemRequest {
            /** The current timestamp at the worker. */
            currentWorkerTime?: string;
            /** The location which contains the WorkItem's job. */
            location?: string;
            /** The initial lease period. */
            requestedLeaseDuration?: string;
            /** Filter for WorkItem type. */
            workItemTypes?: string[];
            /**
             * Worker capabilities. WorkItems might be limited to workers with specific
             * capabilities.
             */
            workerCapabilities?: string[];
            /**
             * Identifies the worker leasing work -- typically the ID of the
             * virtual machine running the worker.
             */
            workerId?: string;
        }
        interface LeaseWorkItemResponse {
            /** A list of the leased WorkItems. */
            workItems?: WorkItem[];
        }
        interface ListJobMessagesResponse {
            /** Autoscaling events in ascending timestamp order. */
            autoscalingEvents?: AutoscalingEvent[];
            /** Messages in ascending timestamp order. */
            jobMessages?: JobMessage[];
            /** The token to obtain the next page of results if there are more. */
            nextPageToken?: string;
        }
        interface ListJobsResponse {
            /** Zero or more messages describing locations that failed to respond. */
            failedLocation?: FailedLocation[];
            /** A subset of the requested job information. */
            jobs?: Job[];
            /** Set if there may be more results than fit in this response. */
            nextPageToken?: string;
        }
        interface MapTask {
            /** The instructions in the MapTask. */
            instructions?: ParallelInstruction[];
            /**
             * System-defined name of the stage containing this MapTask.
             * Unique across the workflow.
             */
            stageName?: string;
            /**
             * System-defined name of this MapTask.
             * Unique across the workflow.
             */
            systemName?: string;
        }
        interface MetricShortId {
            /**
             * The index of the corresponding metric in
             * the ReportWorkItemStatusRequest. Required.
             */
            metricIndex?: number;
            /** The service-generated short identifier for the metric. */
            shortId?: string;
        }
        interface MetricStructuredName {
            /**
             * Zero or more labeled fields which identify the part of the job this
             * metric is associated with, such as the name of a step or collection.
             *
             * For example, built-in counters associated with steps will have
             * context['step'] = <step-name>. Counters associated with PCollections
             * in the SDK will have context['pcollection'] = <pcollection-name>.
             */
            context?: Record<string, string>;
            /** Worker-defined metric name. */
            name?: string;
            /**
             * Origin (namespace) of metric name. May be blank for user-define metrics;
             * will be "dataflow" for metrics defined by the Dataflow service or SDK.
             */
            origin?: string;
        }
        interface MetricUpdate {
            /**
             * True if this metric is reported as the total cumulative aggregate
             * value accumulated since the worker started working on this WorkItem.
             * By default this is false, indicating that this metric is reported
             * as a delta that is not associated with any WorkItem.
             */
            cumulative?: boolean;
            /** A struct value describing properties of a distribution of numeric values. */
            distribution?: any;
            /**
             * Worker-computed aggregate value for internal use by the Dataflow
             * service.
             */
            internal?: any;
            /**
             * Metric aggregation kind.  The possible metric aggregation kinds are
             * "Sum", "Max", "Min", "Mean", "Set", "And", "Or", and "Distribution".
             * The specified aggregation kind is case-insensitive.
             *
             * If omitted, this is not an aggregated value but instead
             * a single metric sample value.
             */
            kind?: string;
            /**
             * Worker-computed aggregate value for the "Mean" aggregation kind.
             * This holds the count of the aggregated values and is used in combination
             * with mean_sum above to obtain the actual mean aggregate value.
             * The only possible value type is Long.
             */
            meanCount?: any;
            /**
             * Worker-computed aggregate value for the "Mean" aggregation kind.
             * This holds the sum of the aggregated values and is used in combination
             * with mean_count below to obtain the actual mean aggregate value.
             * The only possible value types are Long and Double.
             */
            meanSum?: any;
            /** Name of the metric. */
            name?: MetricStructuredName;
            /**
             * Worker-computed aggregate value for aggregation kinds "Sum", "Max", "Min",
             * "And", and "Or".  The possible value types are Long, Double, and Boolean.
             */
            scalar?: any;
            /**
             * Worker-computed aggregate value for the "Set" aggregation kind.  The only
             * possible value type is a list of Values whose type can be Long, Double,
             * or String, according to the metric's type.  All Values in the list must
             * be of the same type.
             */
            set?: any;
            /**
             * Timestamp associated with the metric value. Optional when workers are
             * reporting work progress; it will be filled in responses from the
             * metrics API.
             */
            updateTime?: string;
        }
        interface MountedDataDisk {
            /**
             * The name of the data disk.
             * This name is local to the Google Cloud Platform project and uniquely
             * identifies the disk within that project, for example
             * "myproject-1014-104817-4c2-harness-0-disk-1".
             */
            dataDisk?: string;
        }
        interface MultiOutputInfo {
            /**
             * The id of the tag the user code will emit to this output by; this
             * should correspond to the tag of some SideInputInfo.
             */
            tag?: string;
        }
        interface NameAndKind {
            /** Counter aggregation kind. */
            kind?: string;
            /** Name of the counter. */
            name?: string;
        }
        interface Package {
            /**
             * The resource to read the package from. The supported resource type is:
             *
             * Google Cloud Storage:
             *
             * storage.googleapis.com/{bucket}
             * bucket.storage.googleapis.com/
             */
            location?: string;
            /** The name of the package. */
            name?: string;
        }
        interface ParDoInstruction {
            /** The input. */
            input?: InstructionInput;
            /** Information about each of the outputs, if user_fn is a  MultiDoFn. */
            multiOutputInfos?: MultiOutputInfo[];
            /** The number of outputs. */
            numOutputs?: number;
            /** Zero or more side inputs. */
            sideInputs?: SideInputInfo[];
            /** The user function to invoke. */
            userFn?: Record<string, any>;
        }
        interface ParallelInstruction {
            /** Additional information for Flatten instructions. */
            flatten?: FlattenInstruction;
            /** User-provided name of this operation. */
            name?: string;
            /** System-defined name for the operation in the original workflow graph. */
            originalName?: string;
            /** Describes the outputs of the instruction. */
            outputs?: InstructionOutput[];
            /** Additional information for ParDo instructions. */
            parDo?: ParDoInstruction;
            /** Additional information for PartialGroupByKey instructions. */
            partialGroupByKey?: PartialGroupByKeyInstruction;
            /** Additional information for Read instructions. */
            read?: ReadInstruction;
            /**
             * System-defined name of this operation.
             * Unique across the workflow.
             */
            systemName?: string;
            /** Additional information for Write instructions. */
            write?: WriteInstruction;
        }
        interface Parameter {
            /** Key or name for this parameter. */
            key?: string;
            /** Value for this parameter. */
            value?: any;
        }
        interface ParameterMetadata {
            /** Required. The help text to display for the parameter. */
            helpText?: string;
            /** Optional. Whether the parameter is optional. Defaults to false. */
            isOptional?: boolean;
            /** Required. The label to display for the parameter. */
            label?: string;
            /** Required. The name of the parameter. */
            name?: string;
            /** Optional. Regexes that the parameter must match. */
            regexes?: string[];
        }
        interface PartialGroupByKeyInstruction {
            /** Describes the input to the partial group-by-key instruction. */
            input?: InstructionInput;
            /** The codec to use for interpreting an element in the input PTable. */
            inputElementCodec?: Record<string, any>;
            /**
             * If this instruction includes a combining function this is the name of the
             * intermediate store between the GBK and the CombineValues.
             */
            originalCombineValuesInputStoreName?: string;
            /**
             * If this instruction includes a combining function, this is the name of the
             * CombineValues instruction lifted into this instruction.
             */
            originalCombineValuesStepName?: string;
            /** Zero or more side inputs. */
            sideInputs?: SideInputInfo[];
            /** The value combining function to invoke. */
            valueCombiningFn?: Record<string, any>;
        }
        interface PipelineDescription {
            /** Pipeline level display data. */
            displayData?: DisplayData[];
            /** Description of each stage of execution of the pipeline. */
            executionPipelineStage?: ExecutionStageSummary[];
            /** Description of each transform in the pipeline and collections between them. */
            originalPipelineTransform?: TransformSummary[];
        }
        interface Position {
            /** Position is a byte offset. */
            byteOffset?: string;
            /** CloudPosition is a concat position. */
            concatPosition?: ConcatPosition;
            /**
             * Position is past all other positions. Also useful for the end
             * position of an unbounded range.
             */
            end?: boolean;
            /** Position is a string key, ordered lexicographically. */
            key?: string;
            /** Position is a record index. */
            recordIndex?: string;
            /**
             * CloudPosition is a base64 encoded BatchShufflePosition (with FIXED
             * sharding).
             */
            shufflePosition?: string;
        }
        interface PubsubLocation {
            /** Indicates whether the pipeline allows late-arriving data. */
            dropLateData?: boolean;
            /**
             * If set, contains a pubsub label from which to extract record ids.
             * If left empty, record deduplication will be strictly best effort.
             */
            idLabel?: string;
            /**
             * A pubsub subscription, in the form of
             * "pubsub.googleapis.com/subscriptions/<project-id>/<subscription-name>"
             */
            subscription?: string;
            /**
             * If set, contains a pubsub label from which to extract record timestamps.
             * If left empty, record timestamps will be generated upon arrival.
             */
            timestampLabel?: string;
            /**
             * A pubsub topic, in the form of
             * "pubsub.googleapis.com/topics/<project-id>/<topic-name>"
             */
            topic?: string;
            /**
             * If set, specifies the pubsub subscription that will be used for tracking
             * custom time timestamps for watermark estimation.
             */
            trackingSubscription?: string;
            /** If true, then the client has requested to get pubsub attributes. */
            withAttributes?: boolean;
        }
        interface ReadInstruction {
            /** The source to read from. */
            source?: Source;
        }
        interface ReportWorkItemStatusRequest {
            /** The current timestamp at the worker. */
            currentWorkerTime?: string;
            /** The location which contains the WorkItem's job. */
            location?: string;
            /**
             * The order is unimportant, except that the order of the
             * WorkItemServiceState messages in the ReportWorkItemStatusResponse
             * corresponds to the order of WorkItemStatus messages here.
             */
            workItemStatuses?: WorkItemStatus[];
            /**
             * The ID of the worker reporting the WorkItem status.  If this
             * does not match the ID of the worker which the Dataflow service
             * believes currently has the lease on the WorkItem, the report
             * will be dropped (with an error response).
             */
            workerId?: string;
        }
        interface ReportWorkItemStatusResponse {
            /**
             * A set of messages indicating the service-side state for each
             * WorkItem whose status was reported, in the same order as the
             * WorkItemStatus messages in the ReportWorkItemStatusRequest which
             * resulting in this response.
             */
            workItemServiceStates?: WorkItemServiceState[];
        }
        interface ReportedParallelism {
            /**
             * Specifies whether the parallelism is infinite. If true, "value" is
             * ignored.
             * Infinite parallelism means the service will assume that the work item
             * can always be split into more non-empty work items by dynamic splitting.
             * This is a work-around for lack of support for infinity by the current
             * JSON-based Java RPC stack.
             */
            isInfinite?: boolean;
            /** Specifies the level of parallelism in case it is finite. */
            value?: number;
        }
        interface ResourceUtilizationReport {
            /** CPU utilization samples. */
            cpuTime?: CPUTime[];
        }
        interface RuntimeEnvironment {
            /**
             * Whether to bypass the safety checks for the job's temporary directory.
             * Use with caution.
             */
            bypassTempDirValidation?: boolean;
            /**
             * The machine type to use for the job. Defaults to the value from the
             * template if not specified.
             */
            machineType?: string;
            /**
             * The maximum number of Google Compute Engine instances to be made
             * available to your pipeline during execution, from 1 to 1000.
             */
            maxWorkers?: number;
            /** The email address of the service account to run the job as. */
            serviceAccountEmail?: string;
            /**
             * The Cloud Storage path to use for temporary files.
             * Must be a valid Cloud Storage URL, beginning with `gs://`.
             */
            tempLocation?: string;
            /**
             * The Compute Engine [availability
             * zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones)
             * for launching worker instances to run your pipeline.
             */
            zone?: string;
        }
        interface SendDebugCaptureRequest {
            /** The internal component id for which debug information is sent. */
            componentId?: string;
            /** The encoded debug information. */
            data?: string;
            /** The location which contains the job specified by job_id. */
            location?: string;
            /** The worker id, i.e., VM hostname. */
            workerId?: string;
        }
        interface SendWorkerMessagesRequest {
            /** The location which contains the job */
            location?: string;
            /** The WorkerMessages to send. */
            workerMessages?: WorkerMessage[];
        }
        interface SendWorkerMessagesResponse {
            /** The servers response to the worker messages. */
            workerMessageResponses?: WorkerMessageResponse[];
        }
        interface SeqMapTask {
            /** Information about each of the inputs. */
            inputs?: SideInputInfo[];
            /** The user-provided name of the SeqDo operation. */
            name?: string;
            /** Information about each of the outputs. */
            outputInfos?: SeqMapTaskOutputInfo[];
            /**
             * System-defined name of the stage containing the SeqDo operation.
             * Unique across the workflow.
             */
            stageName?: string;
            /**
             * System-defined name of the SeqDo operation.
             * Unique across the workflow.
             */
            systemName?: string;
            /** The user function to invoke. */
            userFn?: Record<string, any>;
        }
        interface SeqMapTaskOutputInfo {
            /** The sink to write the output value to. */
            sink?: Sink;
            /** The id of the TupleTag the user code will tag the output value by. */
            tag?: string;
        }
        interface ShellTask {
            /** The shell command to run. */
            command?: string;
            /** Exit code for the task. */
            exitCode?: number;
        }
        interface SideInputId {
            /** The step that receives and usually consumes this side input. */
            declaringStepName?: string;
            /** The index of the side input, from the list of non_parallel_inputs. */
            inputIndex?: number;
        }
        interface SideInputInfo {
            /** How to interpret the source element(s) as a side input value. */
            kind?: Record<string, any>;
            /**
             * The source(s) to read element(s) from to get the value of this side input.
             * If more than one source, then the elements are taken from the
             * sources, in the specified order if order matters.
             * At least one source is required.
             */
            sources?: Source[];
            /**
             * The id of the tag the user code will access this side input by;
             * this should correspond to the tag of some MultiOutputInfo.
             */
            tag?: string;
        }
        interface Sink {
            /** The codec to use to encode data written to the sink. */
            codec?: Record<string, any>;
            /** The sink to write to, plus its parameters. */
            spec?: Record<string, any>;
        }
        interface Source {
            /**
             * While splitting, sources may specify the produced bundles
             * as differences against another source, in order to save backend-side
             * memory and allow bigger jobs. For details, see SourceSplitRequest.
             * To support this use case, the full set of parameters of the source
             * is logically obtained by taking the latest explicitly specified value
             * of each parameter in the order:
             * base_specs (later items win), spec (overrides anything in base_specs).
             */
            baseSpecs?: Array<Record<string, any>>;
            /** The codec to use to decode data read from the source. */
            codec?: Record<string, any>;
            /**
             * Setting this value to true hints to the framework that the source
             * doesn't need splitting, and using SourceSplitRequest on it would
             * yield SOURCE_SPLIT_OUTCOME_USE_CURRENT.
             *
             * E.g. a file splitter may set this to true when splitting a single file
             * into a set of byte ranges of appropriate size, and set this
             * to false when splitting a filepattern into individual files.
             * However, for efficiency, a file splitter may decide to produce
             * file subranges directly from the filepattern to avoid a splitting
             * round-trip.
             *
             * See SourceSplitRequest for an overview of the splitting process.
             *
             * This field is meaningful only in the Source objects populated
             * by the user (e.g. when filling in a DerivedSource).
             * Source objects supplied by the framework to the user don't have
             * this field populated.
             */
            doesNotNeedSplitting?: boolean;
            /**
             * Optionally, metadata for this source can be supplied right away,
             * avoiding a SourceGetMetadataOperation roundtrip
             * (see SourceOperationRequest).
             *
             * This field is meaningful only in the Source objects populated
             * by the user (e.g. when filling in a DerivedSource).
             * Source objects supplied by the framework to the user don't have
             * this field populated.
             */
            metadata?: SourceMetadata;
            /** The source to read from, plus its parameters. */
            spec?: Record<string, any>;
        }
        interface SourceFork {
            /** DEPRECATED */
            primary?: SourceSplitShard;
            /** DEPRECATED */
            primarySource?: DerivedSource;
            /** DEPRECATED */
            residual?: SourceSplitShard;
            /** DEPRECATED */
            residualSource?: DerivedSource;
        }
        interface SourceGetMetadataRequest {
            /** Specification of the source whose metadata should be computed. */
            source?: Source;
        }
        interface SourceGetMetadataResponse {
            /** The computed metadata. */
            metadata?: SourceMetadata;
        }
        interface SourceMetadata {
            /**
             * An estimate of the total size (in bytes) of the data that would be
             * read from this source.  This estimate is in terms of external storage
             * size, before any decompression or other processing done by the reader.
             */
            estimatedSizeBytes?: string;
            /**
             * Specifies that the size of this source is known to be infinite
             * (this is a streaming source).
             */
            infinite?: boolean;
            /**
             * Whether this source is known to produce key/value pairs with
             * the (encoded) keys in lexicographically sorted order.
             */
            producesSortedKeys?: boolean;
        }
        interface SourceOperationRequest {
            /** Information about a request to get metadata about a source. */
            getMetadata?: SourceGetMetadataRequest;
            /** Information about a request to split a source. */
            split?: SourceSplitRequest;
        }
        interface SourceOperationResponse {
            /** A response to a request to get metadata about a source. */
            getMetadata?: SourceGetMetadataResponse;
            /** A response to a request to split a source. */
            split?: SourceSplitResponse;
        }
        interface SourceSplitOptions {
            /**
             * The source should be split into a set of bundles where the estimated size
             * of each is approximately this many bytes.
             */
            desiredBundleSizeBytes?: string;
            /** DEPRECATED in favor of desired_bundle_size_bytes. */
            desiredShardSizeBytes?: string;
        }
        interface SourceSplitRequest {
            /** Hints for tuning the splitting process. */
            options?: SourceSplitOptions;
            /** Specification of the source to be split. */
            source?: Source;
        }
        interface SourceSplitResponse {
            /**
             * If outcome is SPLITTING_HAPPENED, then this is a list of bundles
             * into which the source was split. Otherwise this field is ignored.
             * This list can be empty, which means the source represents an empty input.
             */
            bundles?: DerivedSource[];
            /**
             * Indicates whether splitting happened and produced a list of bundles.
             * If this is USE_CURRENT_SOURCE_AS_IS, the current source should
             * be processed "as is" without splitting. "bundles" is ignored in this case.
             * If this is SPLITTING_HAPPENED, then "bundles" contains a list of
             * bundles into which the source was split.
             */
            outcome?: string;
            /** DEPRECATED in favor of bundles. */
            shards?: SourceSplitShard[];
        }
        interface SourceSplitShard {
            /** DEPRECATED */
            derivationMode?: string;
            /** DEPRECATED */
            source?: Source;
        }
        interface SplitInt64 {
            /** The high order bits, including the sign: n >> 32. */
            highBits?: number;
            /** The low order bits: n & 0xffffffff. */
            lowBits?: number;
        }
        interface StageSource {
            /** Dataflow service generated name for this source. */
            name?: string;
            /**
             * User name for the original user transform or collection with which this
             * source is most closely associated.
             */
            originalTransformOrCollection?: string;
            /** Size of the source, if measurable. */
            sizeBytes?: string;
            /** Human-readable name for this source; may be user or system generated. */
            userName?: string;
        }
        interface StateFamilyConfig {
            /** If true, this family corresponds to a read operation. */
            isRead?: boolean;
            /** The state family value. */
            stateFamily?: string;
        }
        interface Status {
            /** The status code, which should be an enum value of google.rpc.Code. */
            code?: number;
            /**
             * A list of messages that carry the error details.  There is a common set of
             * message types for APIs to use.
             */
            details?: Array<Record<string, any>>;
            /**
             * A developer-facing error message, which should be in English. Any
             * user-facing error message should be localized and sent in the
             * google.rpc.Status.details field, or localized by the client.
             */
            message?: string;
        }
        interface Step {
            /** The kind of step in the Cloud Dataflow job. */
            kind?: string;
            /**
             * The name that identifies the step. This must be unique for each
             * step with respect to all other steps in the Cloud Dataflow job.
             */
            name?: string;
            /**
             * Named properties associated with the step. Each kind of
             * predefined step has its own required set of properties.
             * Must be provided on Create.  Only retrieved with JOB_VIEW_ALL.
             */
            properties?: Record<string, any>;
        }
        interface StreamLocation {
            /** The stream is a custom source. */
            customSourceLocation?: CustomSourceLocation;
            /** The stream is a pubsub stream. */
            pubsubLocation?: PubsubLocation;
            /** The stream is a streaming side input. */
            sideInputLocation?: StreamingSideInputLocation;
            /**
             * The stream is part of another computation within the current
             * streaming Dataflow job.
             */
            streamingStageLocation?: StreamingStageLocation;
        }
        interface StreamingComputationConfig {
            /** Unique identifier for this computation. */
            computationId?: string;
            /** Instructions that comprise the computation. */
            instructions?: ParallelInstruction[];
            /** Stage name of this computation. */
            stageName?: string;
            /** System defined name for this computation. */
            systemName?: string;
        }
        interface StreamingComputationRanges {
            /** The ID of the computation. */
            computationId?: string;
            /** Data disk assignments for ranges from this computation. */
            rangeAssignments?: KeyRangeDataDiskAssignment[];
        }
        interface StreamingComputationTask {
            /** Contains ranges of a streaming computation this task should apply to. */
            computationRanges?: StreamingComputationRanges[];
            /** Describes the set of data disks this task should apply to. */
            dataDisks?: MountedDataDisk[];
            /** A type of streaming computation task. */
            taskType?: string;
        }
        interface StreamingConfigTask {
            /** Set of computation configuration information. */
            streamingComputationConfigs?: StreamingComputationConfig[];
            /** Map from user step names to state families. */
            userStepToStateFamilyNameMap?: Record<string, string>;
            /**
             * If present, the worker must use this endpoint to communicate with Windmill
             * Service dispatchers, otherwise the worker must continue to use whatever
             * endpoint it had been using.
             */
            windmillServiceEndpoint?: string;
            /**
             * If present, the worker must use this port to communicate with Windmill
             * Service dispatchers. Only applicable when windmill_service_endpoint is
             * specified.
             */
            windmillServicePort?: string;
        }
        interface StreamingSetupTask {
            /** The user has requested drain. */
            drain?: boolean;
            /**
             * The TCP port on which the worker should listen for messages from
             * other streaming computation workers.
             */
            receiveWorkPort?: number;
            /** The global topology of the streaming Dataflow job. */
            streamingComputationTopology?: TopologyConfig;
            /**
             * The TCP port used by the worker to communicate with the Dataflow
             * worker harness.
             */
            workerHarnessPort?: number;
        }
        interface StreamingSideInputLocation {
            /** Identifies the state family where this side input is stored. */
            stateFamily?: string;
            /** Identifies the particular side input within the streaming Dataflow job. */
            tag?: string;
        }
        interface StreamingStageLocation {
            /**
             * Identifies the particular stream within the streaming Dataflow
             * job.
             */
            streamId?: string;
        }
        interface StringList {
            /** Elements of the list. */
            elements?: string[];
        }
        interface StructuredMessage {
            /**
             * Idenfier for this message type.  Used by external systems to
             * internationalize or personalize message.
             */
            messageKey?: string;
            /** Human-readable version of message. */
            messageText?: string;
            /** The structured data associated with this message. */
            parameters?: Parameter[];
        }
        interface TaskRunnerSettings {
            /** Whether to also send taskrunner log info to stderr. */
            alsologtostderr?: boolean;
            /** The location on the worker for task-specific subdirectories. */
            baseTaskDir?: string;
            /**
             * The base URL for the taskrunner to use when accessing Google Cloud APIs.
             *
             * When workers access Google Cloud APIs, they logically do so via
             * relative URLs.  If this field is specified, it supplies the base
             * URL to use for resolving these relative URLs.  The normative
             * algorithm used is defined by RFC 1808, "Relative Uniform Resource
             * Locators".
             *
             * If not specified, the default value is "http://www.googleapis.com/"
             */
            baseUrl?: string;
            /** The file to store preprocessing commands in. */
            commandlinesFileName?: string;
            /** Whether to continue taskrunner if an exception is hit. */
            continueOnException?: boolean;
            /** The API version of endpoint, e.g. "v1b3" */
            dataflowApiVersion?: string;
            /** The command to launch the worker harness. */
            harnessCommand?: string;
            /** The suggested backend language. */
            languageHint?: string;
            /** The directory on the VM to store logs. */
            logDir?: string;
            /**
             * Whether to send taskrunner log info to Google Compute Engine VM serial
             * console.
             */
            logToSerialconsole?: boolean;
            /**
             * Indicates where to put logs.  If this is not specified, the logs
             * will not be uploaded.
             *
             * The supported resource type is:
             *
             * Google Cloud Storage:
             * storage.googleapis.com/{bucket}/{object}
             * bucket.storage.googleapis.com/{object}
             */
            logUploadLocation?: string;
            /**
             * The OAuth2 scopes to be requested by the taskrunner in order to
             * access the Cloud Dataflow API.
             */
            oauthScopes?: string[];
            /** The settings to pass to the parallel worker harness. */
            parallelWorkerSettings?: WorkerSettings;
            /** The streaming worker main class name. */
            streamingWorkerMainClass?: string;
            /**
             * The UNIX group ID on the worker VM to use for tasks launched by
             * taskrunner; e.g. "wheel".
             */
            taskGroup?: string;
            /**
             * The UNIX user ID on the worker VM to use for tasks launched by
             * taskrunner; e.g. "root".
             */
            taskUser?: string;
            /**
             * The prefix of the resources the taskrunner should use for
             * temporary storage.
             *
             * The supported resource type is:
             *
             * Google Cloud Storage:
             * storage.googleapis.com/{bucket}/{object}
             * bucket.storage.googleapis.com/{object}
             */
            tempStoragePrefix?: string;
            /** The ID string of the VM. */
            vmId?: string;
            /** The file to store the workflow in. */
            workflowFileName?: string;
        }
        interface TemplateMetadata {
            /** Optional. A description of the template. */
            description?: string;
            /** Required. The name of the template. */
            name?: string;
            /** The parameters for the template. */
            parameters?: ParameterMetadata[];
        }
        interface TopologyConfig {
            /** The computations associated with a streaming Dataflow job. */
            computations?: ComputationTopology[];
            /** The disks assigned to a streaming Dataflow job. */
            dataDiskAssignments?: DataDiskAssignment[];
            /** The size (in bits) of keys that will be assigned to source messages. */
            forwardingKeyBits?: number;
            /** Version number for persistent state. */
            persistentStateVersion?: number;
            /** Maps user stage names to stable computation names. */
            userStageToComputationNameMap?: Record<string, string>;
        }
        interface TransformSummary {
            /** Transform-specific display data. */
            displayData?: DisplayData[];
            /** SDK generated id of this transform instance. */
            id?: string;
            /** User names for all collection inputs to this transform. */
            inputCollectionName?: string[];
            /** Type of transform. */
            kind?: string;
            /** User provided name for this transform instance. */
            name?: string;
            /** User  names for all collection outputs to this transform. */
            outputCollectionName?: string[];
        }
        interface WorkItem {
            /** Work item-specific configuration as an opaque blob. */
            configuration?: string;
            /** Identifies this WorkItem. */
            id?: string;
            /** The initial index to use when reporting the status of the WorkItem. */
            initialReportIndex?: string;
            /** Identifies the workflow job this WorkItem belongs to. */
            jobId?: string;
            /** Time when the lease on this Work will expire. */
            leaseExpireTime?: string;
            /** Additional information for MapTask WorkItems. */
            mapTask?: MapTask;
            /**
             * Any required packages that need to be fetched in order to execute
             * this WorkItem.
             */
            packages?: Package[];
            /** Identifies the cloud project this WorkItem belongs to. */
            projectId?: string;
            /** Recommended reporting interval. */
            reportStatusInterval?: string;
            /** Additional information for SeqMapTask WorkItems. */
            seqMapTask?: SeqMapTask;
            /** Additional information for ShellTask WorkItems. */
            shellTask?: ShellTask;
            /** Additional information for source operation WorkItems. */
            sourceOperationTask?: SourceOperationRequest;
            /** Additional information for StreamingComputationTask WorkItems. */
            streamingComputationTask?: StreamingComputationTask;
            /** Additional information for StreamingConfigTask WorkItems. */
            streamingConfigTask?: StreamingConfigTask;
            /** Additional information for StreamingSetupTask WorkItems. */
            streamingSetupTask?: StreamingSetupTask;
        }
        interface WorkItemServiceState {
            /**
             * Other data returned by the service, specific to the particular
             * worker harness.
             */
            harnessData?: Record<string, any>;
            /** Time at which the current lease will expire. */
            leaseExpireTime?: string;
            /**
             * The short ids that workers should use in subsequent metric updates.
             * Workers should strive to use short ids whenever possible, but it is ok
             * to request the short_id again if a worker lost track of it
             * (e.g. if the worker is recovering from a crash).
             * NOTE: it is possible that the response may have short ids for a subset
             * of the metrics.
             */
            metricShortId?: MetricShortId[];
            /**
             * The index value to use for the next report sent by the worker.
             * Note: If the report call fails for whatever reason, the worker should
             * reuse this index for subsequent report attempts.
             */
            nextReportIndex?: string;
            /** New recommended reporting interval. */
            reportStatusInterval?: string;
            /**
             * The progress point in the WorkItem where the Dataflow service
             * suggests that the worker truncate the task.
             */
            splitRequest?: ApproximateSplitRequest;
            /** DEPRECATED in favor of split_request. */
            suggestedStopPoint?: ApproximateProgress;
            /** Obsolete, always empty. */
            suggestedStopPosition?: Position;
        }
        interface WorkItemStatus {
            /** True if the WorkItem was completed (successfully or unsuccessfully). */
            completed?: boolean;
            /** Worker output counters for this WorkItem. */
            counterUpdates?: CounterUpdate[];
            /** See documentation of stop_position. */
            dynamicSourceSplit?: DynamicSourceSplit;
            /**
             * Specifies errors which occurred during processing.  If errors are
             * provided, and completed = true, then the WorkItem is considered
             * to have failed.
             */
            errors?: Status[];
            /** DEPRECATED in favor of counter_updates. */
            metricUpdates?: MetricUpdate[];
            /** DEPRECATED in favor of reported_progress. */
            progress?: ApproximateProgress;
            /**
             * The report index.  When a WorkItem is leased, the lease will
             * contain an initial report index.  When a WorkItem's status is
             * reported to the system, the report should be sent with
             * that report index, and the response will contain the index the
             * worker should use for the next report.  Reports received with
             * unexpected index values will be rejected by the service.
             *
             * In order to preserve idempotency, the worker should not alter the
             * contents of a report, even if the worker must submit the same
             * report multiple times before getting back a response.  The worker
             * should not submit a subsequent report until the response for the
             * previous report had been received from the service.
             */
            reportIndex?: string;
            /** The worker's progress through this WorkItem. */
            reportedProgress?: ApproximateReportedProgress;
            /** Amount of time the worker requests for its lease. */
            requestedLeaseDuration?: string;
            /** DEPRECATED in favor of dynamic_source_split. */
            sourceFork?: SourceFork;
            /**
             * If the work item represented a SourceOperationRequest, and the work
             * is completed, contains the result of the operation.
             */
            sourceOperationResponse?: SourceOperationResponse;
            /**
             * A worker may split an active map task in two parts, "primary" and
             * "residual", continuing to process the primary part and returning the
             * residual part into the pool of available work.
             * This event is called a "dynamic split" and is critical to the dynamic
             * work rebalancing feature. The two obtained sub-tasks are called
             * "parts" of the split.
             * The parts, if concatenated, must represent the same input as would
             * be read by the current task if the split did not happen.
             * The exact way in which the original task is decomposed into the two
             * parts is specified either as a position demarcating them
             * (stop_position), or explicitly as two DerivedSources, if this
             * task consumes a user-defined source type (dynamic_source_split).
             *
             * The "current" task is adjusted as a result of the split: after a task
             * with range [A, B) sends a stop_position update at C, its range is
             * considered to be [A, C), e.g.:
             * &#42; Progress should be interpreted relative to the new range, e.g.
             * "75% completed" means "75% of [A, C) completed"
             * &#42; The worker should interpret proposed_stop_position relative to the
             * new range, e.g. "split at 68%" should be interpreted as
             * "split at 68% of [A, C)".
             * &#42; If the worker chooses to split again using stop_position, only
             * stop_positions in [A, C) will be accepted.
             * &#42; Etc.
             * dynamic_source_split has similar semantics: e.g., if a task with
             * source S splits using dynamic_source_split into {P, R}
             * (where P and R must be together equivalent to S), then subsequent
             * progress and proposed_stop_position should be interpreted relative
             * to P, and in a potential subsequent dynamic_source_split into {P', R'},
             * P' and R' must be together equivalent to P, etc.
             */
            stopPosition?: Position;
            /** Total time the worker spent being throttled by external systems. */
            totalThrottlerWaitTimeSeconds?: number;
            /** Identifies the WorkItem. */
            workItemId?: string;
        }
        interface WorkerHealthReport {
            /**
             * The pods running on the worker. See:
             * http://kubernetes.io/v1.1/docs/api-reference/v1/definitions.html#_v1_pod
             *
             * This field is used by the worker to send the status of the indvidual
             * containers running on each worker.
             */
            pods?: Array<Record<string, any>>;
            /**
             * The interval at which the worker is sending health reports.
             * The default value of 0 should be interpreted as the field is not being
             * explicitly set by the worker.
             */
            reportInterval?: string;
            /** Whether the VM is healthy. */
            vmIsHealthy?: boolean;
            /** The time the VM was booted. */
            vmStartupTime?: string;
        }
        interface WorkerHealthReportResponse {
            /**
             * A positive value indicates the worker should change its reporting interval
             * to the specified value.
             *
             * The default value of zero means no change in report rate is requested by
             * the server.
             */
            reportInterval?: string;
        }
        interface WorkerMessage {
            /**
             * Labels are used to group WorkerMessages.
             * For example, a worker_message about a particular container
             * might have the labels:
             * { "JOB_ID": "2015-04-22",
             * "WORKER_ID": "wordcount-vm-2015…"
             * "CONTAINER_TYPE": "worker",
             * "CONTAINER_ID": "ac1234def"}
             * Label tags typically correspond to Label enum values. However, for ease
             * of development other strings can be used as tags. LABEL_UNSPECIFIED should
             * not be used here.
             */
            labels?: Record<string, string>;
            /** The timestamp of the worker_message. */
            time?: string;
            /** The health of a worker. */
            workerHealthReport?: WorkerHealthReport;
            /** A worker message code. */
            workerMessageCode?: WorkerMessageCode;
            /** Resource metrics reported by workers. */
            workerMetrics?: ResourceUtilizationReport;
            /** Shutdown notice by workers. */
            workerShutdownNotice?: WorkerShutdownNotice;
        }
        interface WorkerMessageCode {
            /**
             * The code is a string intended for consumption by a machine that identifies
             * the type of message being sent.
             * Examples:
             * 1. "HARNESS_STARTED" might be used to indicate the worker harness has
             * started.
             * 2. "GCS_DOWNLOAD_ERROR" might be used to indicate an error downloading
             * a GCS file as part of the boot process of one of the worker containers.
             *
             * This is a string and not an enum to make it easy to add new codes without
             * waiting for an API change.
             */
            code?: string;
            /**
             * Parameters contains specific information about the code.
             *
             * This is a struct to allow parameters of different types.
             *
             * Examples:
             * 1. For a "HARNESS_STARTED" message parameters might provide the name
             * of the worker and additional data like timing information.
             * 2. For a "GCS_DOWNLOAD_ERROR" parameters might contain fields listing
             * the GCS objects being downloaded and fields containing errors.
             *
             * In general complex data structures should be avoided. If a worker
             * needs to send a specific and complicated data structure then please
             * consider defining a new proto and adding it to the data oneof in
             * WorkerMessageResponse.
             *
             * Conventions:
             * Parameters should only be used for information that isn't typically passed
             * as a label.
             * hostname and other worker identifiers should almost always be passed
             * as labels since they will be included on most messages.
             */
            parameters?: Record<string, any>;
        }
        interface WorkerMessageResponse {
            /** The service's response to a worker's health report. */
            workerHealthReportResponse?: WorkerHealthReportResponse;
            /** Service's response to reporting worker metrics (currently empty). */
            workerMetricsResponse?: any;
            /** Service's response to shutdown notice (currently empty). */
            workerShutdownNoticeResponse?: any;
        }
        interface WorkerPool {
            /** Settings for autoscaling of this WorkerPool. */
            autoscalingSettings?: AutoscalingSettings;
            /** Data disks that are used by a VM in this workflow. */
            dataDisks?: Disk[];
            /**
             * The default package set to install.  This allows the service to
             * select a default set of packages which are useful to worker
             * harnesses written in a particular language.
             */
            defaultPackageSet?: string;
            /**
             * Size of root disk for VMs, in GB.  If zero or unspecified, the service will
             * attempt to choose a reasonable default.
             */
            diskSizeGb?: number;
            /** Fully qualified source image for disks. */
            diskSourceImage?: string;
            /**
             * Type of root disk for VMs.  If empty or unspecified, the service will
             * attempt to choose a reasonable default.
             */
            diskType?: string;
            /** Configuration for VM IPs. */
            ipConfiguration?: string;
            /**
             * The kind of the worker pool; currently only `harness` and `shuffle`
             * are supported.
             */
            kind?: string;
            /**
             * Machine type (e.g. "n1-standard-1").  If empty or unspecified, the
             * service will attempt to choose a reasonable default.
             */
            machineType?: string;
            /** Metadata to set on the Google Compute Engine VMs. */
            metadata?: Record<string, string>;
            /**
             * Network to which VMs will be assigned.  If empty or unspecified,
             * the service will use the network "default".
             */
            network?: string;
            /**
             * The number of threads per worker harness. If empty or unspecified, the
             * service will choose a number of threads (according to the number of cores
             * on the selected machine type for batch, or 1 by convention for streaming).
             */
            numThreadsPerWorker?: number;
            /**
             * Number of Google Compute Engine workers in this pool needed to
             * execute the job.  If zero or unspecified, the service will
             * attempt to choose a reasonable default.
             */
            numWorkers?: number;
            /**
             * The action to take on host maintenance, as defined by the Google
             * Compute Engine API.
             */
            onHostMaintenance?: string;
            /** Packages to be installed on workers. */
            packages?: Package[];
            /** Extra arguments for this worker pool. */
            poolArgs?: Record<string, any>;
            /**
             * Subnetwork to which VMs will be assigned, if desired.  Expected to be of
             * the form "regions/REGION/subnetworks/SUBNETWORK".
             */
            subnetwork?: string;
            /**
             * Settings passed through to Google Compute Engine workers when
             * using the standard Dataflow task runner.  Users should ignore
             * this field.
             */
            taskrunnerSettings?: TaskRunnerSettings;
            /**
             * Sets the policy for determining when to turndown worker pool.
             * Allowed values are: `TEARDOWN_ALWAYS`, `TEARDOWN_ON_SUCCESS`, and
             * `TEARDOWN_NEVER`.
             * `TEARDOWN_ALWAYS` means workers are always torn down regardless of whether
             * the job succeeds. `TEARDOWN_ON_SUCCESS` means workers are torn down
             * if the job succeeds. `TEARDOWN_NEVER` means the workers are never torn
             * down.
             *
             * If the workers are not torn down by the service, they will
             * continue to run and use Google Compute Engine VM resources in the
             * user's project until they are explicitly terminated by the user.
             * Because of this, Google recommends using the `TEARDOWN_ALWAYS`
             * policy except for small, manually supervised test jobs.
             *
             * If unknown or unspecified, the service will attempt to choose a reasonable
             * default.
             */
            teardownPolicy?: string;
            /**
             * Required. Docker container image that executes the Cloud Dataflow worker
             * harness, residing in Google Container Registry.
             */
            workerHarnessContainerImage?: string;
            /**
             * Zone to run the worker pools in.  If empty or unspecified, the service
             * will attempt to choose a reasonable default.
             */
            zone?: string;
        }
        interface WorkerSettings {
            /**
             * The base URL for accessing Google Cloud APIs.
             *
             * When workers access Google Cloud APIs, they logically do so via
             * relative URLs.  If this field is specified, it supplies the base
             * URL to use for resolving these relative URLs.  The normative
             * algorithm used is defined by RFC 1808, "Relative Uniform Resource
             * Locators".
             *
             * If not specified, the default value is "http://www.googleapis.com/"
             */
            baseUrl?: string;
            /** Whether to send work progress updates to the service. */
            reportingEnabled?: boolean;
            /**
             * The Cloud Dataflow service path relative to the root URL, for example,
             * "dataflow/v1b3/projects".
             */
            servicePath?: string;
            /**
             * The Shuffle service path relative to the root URL, for example,
             * "shuffle/v1beta1".
             */
            shuffleServicePath?: string;
            /**
             * The prefix of the resources the system should use for temporary
             * storage.
             *
             * The supported resource type is:
             *
             * Google Cloud Storage:
             *
             * storage.googleapis.com/{bucket}/{object}
             * bucket.storage.googleapis.com/{object}
             */
            tempStoragePrefix?: string;
            /** The ID of the worker running this pipeline. */
            workerId?: string;
        }
        interface WorkerShutdownNotice {
            /**
             * The reason for the worker shutdown.
             * Current possible values are:
             * "UNKNOWN": shutdown reason is unknown.
             * "PREEMPTION": shutdown reason is preemption.
             * Other possible reasons may be added in the future.
             */
            reason?: string;
        }
        interface WriteInstruction {
            /** The input. */
            input?: InstructionInput;
            /** The sink to write to. */
            sink?: Sink;
        }
        interface DebugResource {
            /** Get encoded debug configuration for component. Not cacheable. */
            getConfig(request: {
                /** V1 error format. */
                "$.xgafv"?: string;
                /** OAuth access token. */
                access_token?: string;
                /** Data format for response. */
                alt?: string;
                /** OAuth bearer token. */
                bearer_token?: string;
                /** JSONP */
                callback?: string;
                /** Selector specifying which fields to include in a partial response. */
                fields?: string;
                /** The job id. */
                jobId: string;
                /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
                key?: string;
                /** OAuth 2.0 token for the current user. */
                oauth_token?: string;
                /** Pretty-print response. */
                pp?: boolean;
                /** Returns response with indentations and line breaks. */
                prettyPrint?: boolean;
                /** The project id. */
                projectId: string;
                /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
                quotaUser?: string;
                /** Legacy upload protocol for media (e.g. "media", "multipart"). */
                uploadType?: string;
                /** Upload protocol for media (e.g. "raw", "multipart"). */
                upload_protocol?: string;
            }): Request<GetDebugConfigResponse>;
            /** Send encoded debug capture data for component. */
            sendCapture(request: {
                /** V1 error format. */
                "$.xgafv"?: string;
                /** OAuth access token. */
                access_token?: string;
                /** Data format for response. */
                alt?: string;
                /** OAuth bearer token. */
                bearer_token?: string;
                /** JSONP */
                callback?: string;
                /** Selector specifying which fields to include in a partial response. */
                fields?: string;
                /** The job id. */
                jobId: string;
                /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
                key?: string;
                /** OAuth 2.0 token for the current user. */
                oauth_token?: string;
                /** Pretty-print response. */
                pp?: boolean;
                /** Returns response with indentations and line breaks. */
                prettyPrint?: boolean;
                /** The project id. */
                projectId: string;
                /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
                quotaUser?: string;
                /** Legacy upload protocol for media (e.g. "media", "multipart"). */
                uploadType?: string;
                /** Upload protocol for media (e.g. "raw", "multipart"). */
                upload_protocol?: string;
            }): Request<{}>;
        }
        interface MessagesResource {
            /** Request the job status. */
            list(request: {
                /** V1 error format. */
                "$.xgafv"?: string;
                /** OAuth access token. */
                access_token?: string;
                /** Data format for response. */
                alt?: string;
                /** OAuth bearer token. */
                bearer_token?: string;
                /** JSONP */
                callback?: string;
                /**
                 * Return only messages with timestamps < end_time. The default is now
                 * (i.e. return up to the latest messages available).
                 */
                endTime?: string;
                /** Selector specifying which fields to include in a partial response. */
                fields?: string;
                /** The job to get messages about. */
                jobId: string;
                /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
                key?: string;
                /** The location which contains the job specified by job_id. */
                location?: string;
                /** Filter to only get messages with importance >= level */
                minimumImportance?: string;
                /** OAuth 2.0 token for the current user. */
                oauth_token?: string;
                /**
                 * If specified, determines the maximum number of messages to
                 * return.  If unspecified, the service may choose an appropriate
                 * default, or may return an arbitrarily large number of results.
                 */
                pageSize?: number;
                /**
                 * If supplied, this should be the value of next_page_token returned
                 * by an earlier call. This will cause the next page of results to
                 * be returned.
                 */
                pageToken?: string;
                /** Pretty-print response. */
                pp?: boolean;
                /** Returns response with indentations and line breaks. */
                prettyPrint?: boolean;
                /** A project id. */
                projectId: string;
                /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
                quotaUser?: string;
                /**
                 * If specified, return only messages with timestamps >= start_time.
                 * The default is the job creation time (i.e. beginning of messages).
                 */
                startTime?: string;
                /** Legacy upload protocol for media (e.g. "media", "multipart"). */
                uploadType?: string;
                /** Upload protocol for media (e.g. "raw", "multipart"). */
                upload_protocol?: string;
            }): Request<ListJobMessagesResponse>;
        }
        interface WorkItemsResource {
            /** Leases a dataflow WorkItem to run. */
            lease(request: {
                /** V1 error format. */
                "$.xgafv"?: string;
                /** OAuth access token. */
                access_token?: string;
                /** Data format for response. */
                alt?: string;
                /** OAuth bearer token. */
                bearer_token?: string;
                /** JSONP */
                callback?: string;
                /** Selector specifying which fields to include in a partial response. */
                fields?: string;
                /** Identifies the workflow job this worker belongs to. */
                jobId: string;
                /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
                key?: string;
                /** OAuth 2.0 token for the current user. */
                oauth_token?: string;
                /** Pretty-print response. */
                pp?: boolean;
                /** Returns response with indentations and line breaks. */
                prettyPrint?: boolean;
                /** Identifies the project this worker belongs to. */
                projectId: string;
                /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
                quotaUser?: string;
                /** Legacy upload protocol for media (e.g. "media", "multipart"). */
                uploadType?: string;
                /** Upload protocol for media (e.g. "raw", "multipart"). */
                upload_protocol?: string;
            }): Request<LeaseWorkItemResponse>;
            /** Reports the status of dataflow WorkItems leased by a worker. */
            reportStatus(request: {
                /** V1 error format. */
                "$.xgafv"?: string;
                /** OAuth access token. */
                access_token?: string;
                /** Data format for response. */
                alt?: string;
                /** OAuth bearer token. */
                bearer_token?: string;
                /** JSONP */
                callback?: string;
                /** Selector specifying which fields to include in a partial response. */
                fields?: string;
                /** The job which the WorkItem is part of. */
                jobId: string;
                /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
                key?: string;
                /** OAuth 2.0 token for the current user. */
                oauth_token?: string;
                /** Pretty-print response. */
                pp?: boolean;
                /** Returns response with indentations and line breaks. */
                prettyPrint?: boolean;
                /** The project which owns the WorkItem's job. */
                projectId: string;
                /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
                quotaUser?: string;
                /** Legacy upload protocol for media (e.g. "media", "multipart"). */
                uploadType?: string;
                /** Upload protocol for media (e.g. "raw", "multipart"). */
                upload_protocol?: string;
            }): Request<ReportWorkItemStatusResponse>;
        }
        interface JobsResource {
            /** List the jobs of a project across all regions. */
            aggregated(request: {
                /** V1 error format. */
                "$.xgafv"?: string;
                /** OAuth access token. */
                access_token?: string;
                /** Data format for response. */
                alt?: string;
                /** OAuth bearer token. */
                bearer_token?: string;
                /** JSONP */
                callback?: string;
                /** Selector specifying which fields to include in a partial response. */
                fields?: string;
                /** The kind of filter to use. */
                filter?: string;
                /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
                key?: string;
                /** The location that contains this job. */
                location?: string;
                /** OAuth 2.0 token for the current user. */
                oauth_token?: string;
                /**
                 * If there are many jobs, limit response to at most this many.
                 * The actual number of jobs returned will be the lesser of max_responses
                 * and an unspecified server-defined limit.
                 */
                pageSize?: number;
                /**
                 * Set this to the 'next_page_token' field of a previous response
                 * to request additional results in a long list.
                 */
                pageToken?: string;
                /** Pretty-print response. */
                pp?: boolean;
                /** Returns response with indentations and line breaks. */
                prettyPrint?: boolean;
                /** The project which owns the jobs. */
                projectId: string;
                /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
                quotaUser?: string;
                /** Legacy upload protocol for media (e.g. "media", "multipart"). */
                uploadType?: string;
                /** Upload protocol for media (e.g. "raw", "multipart"). */
                upload_protocol?: string;
                /** Level of information requested in response. Default is `JOB_VIEW_SUMMARY`. */
                view?: string;
            }): Request<ListJobsResponse>;
            /** Creates a Cloud Dataflow job. */
            create(request: {
                /** V1 error format. */
                "$.xgafv"?: string;
                /** OAuth access token. */
                access_token?: string;
                /** Data format for response. */
                alt?: string;
                /** OAuth bearer token. */
                bearer_token?: string;
                /** JSONP */
                callback?: string;
                /** Selector specifying which fields to include in a partial response. */
                fields?: string;
                /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
                key?: string;
                /** The location that contains this job. */
                location?: string;
                /** OAuth 2.0 token for the current user. */
                oauth_token?: string;
                /** Pretty-print response. */
                pp?: boolean;
                /** Returns response with indentations and line breaks. */
                prettyPrint?: boolean;
                /** The ID of the Cloud Platform project that the job belongs to. */
                projectId: string;
                /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
                quotaUser?: string;
                /** Deprecated. This field is now in the Job message. */
                replaceJobId?: string;
                /** Legacy upload protocol for media (e.g. "media", "multipart"). */
                uploadType?: string;
                /** Upload protocol for media (e.g. "raw", "multipart"). */
                upload_protocol?: string;
                /** The level of information requested in response. */
                view?: string;
            }): Request<Job>;
            /** Gets the state of the specified Cloud Dataflow job. */
            get(request: {
                /** V1 error format. */
                "$.xgafv"?: string;
                /** OAuth access token. */
                access_token?: string;
                /** Data format for response. */
                alt?: string;
                /** OAuth bearer token. */
                bearer_token?: string;
                /** JSONP */
                callback?: string;
                /** Selector specifying which fields to include in a partial response. */
                fields?: string;
                /** The job ID. */
                jobId: string;
                /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
                key?: string;
                /** The location that contains this job. */
                location?: string;
                /** OAuth 2.0 token for the current user. */
                oauth_token?: string;
                /** Pretty-print response. */
                pp?: boolean;
                /** Returns response with indentations and line breaks. */
                prettyPrint?: boolean;
                /** The ID of the Cloud Platform project that the job belongs to. */
                projectId: string;
                /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
                quotaUser?: string;
                /** Legacy upload protocol for media (e.g. "media", "multipart"). */
                uploadType?: string;
                /** Upload protocol for media (e.g. "raw", "multipart"). */
                upload_protocol?: string;
                /** The level of information requested in response. */
                view?: string;
            }): Request<Job>;
            /** Request the job status. */
            getMetrics(request: {
                /** V1 error format. */
                "$.xgafv"?: string;
                /** OAuth access token. */
                access_token?: string;
                /** Data format for response. */
                alt?: string;
                /** OAuth bearer token. */
                bearer_token?: string;
                /** JSONP */
                callback?: string;
                /** Selector specifying which fields to include in a partial response. */
                fields?: string;
                /** The job to get messages for. */
                jobId: string;
                /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
                key?: string;
                /** The location which contains the job specified by job_id. */
                location?: string;
                /** OAuth 2.0 token for the current user. */
                oauth_token?: string;
                /** Pretty-print response. */
                pp?: boolean;
                /** Returns response with indentations and line breaks. */
                prettyPrint?: boolean;
                /** A project id. */
                projectId: string;
                /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
                quotaUser?: string;
                /**
                 * Return only metric data that has changed since this time.
                 * Default is to return all information about all metrics for the job.
                 */
                startTime?: string;
                /** Legacy upload protocol for media (e.g. "media", "multipart"). */
                uploadType?: string;
                /** Upload protocol for media (e.g. "raw", "multipart"). */
                upload_protocol?: string;
            }): Request<JobMetrics>;
            /** List the jobs of a project in a given region. */
            list(request: {
                /** V1 error format. */
                "$.xgafv"?: string;
                /** OAuth access token. */
                access_token?: string;
                /** Data format for response. */
                alt?: string;
                /** OAuth bearer token. */
                bearer_token?: string;
                /** JSONP */
                callback?: string;
                /** Selector specifying which fields to include in a partial response. */
                fields?: string;
                /** The kind of filter to use. */
                filter?: string;
                /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
                key?: string;
                /** The location that contains this job. */
                location?: string;
                /** OAuth 2.0 token for the current user. */
                oauth_token?: string;
                /**
                 * If there are many jobs, limit response to at most this many.
                 * The actual number of jobs returned will be the lesser of max_responses
                 * and an unspecified server-defined limit.
                 */
                pageSize?: number;
                /**
                 * Set this to the 'next_page_token' field of a previous response
                 * to request additional results in a long list.
                 */
                pageToken?: string;
                /** Pretty-print response. */
                pp?: boolean;
                /** Returns response with indentations and line breaks. */
                prettyPrint?: boolean;
                /** The project which owns the jobs. */
                projectId: string;
                /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
                quotaUser?: string;
                /** Legacy upload protocol for media (e.g. "media", "multipart"). */
                uploadType?: string;
                /** Upload protocol for media (e.g. "raw", "multipart"). */
                upload_protocol?: string;
                /** Level of information requested in response. Default is `JOB_VIEW_SUMMARY`. */
                view?: string;
            }): Request<ListJobsResponse>;
            /** Updates the state of an existing Cloud Dataflow job. */
            update(request: {
                /** V1 error format. */
                "$.xgafv"?: string;
                /** OAuth access token. */
                access_token?: string;
                /** Data format for response. */
                alt?: string;
                /** OAuth bearer token. */
                bearer_token?: string;
                /** JSONP */
                callback?: string;
                /** Selector specifying which fields to include in a partial response. */
                fields?: string;
                /** The job ID. */
                jobId: string;
                /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
                key?: string;
                /** The location that contains this job. */
                location?: string;
                /** OAuth 2.0 token for the current user. */
                oauth_token?: string;
                /** Pretty-print response. */
                pp?: boolean;
                /** Returns response with indentations and line breaks. */
                prettyPrint?: boolean;
                /** The ID of the Cloud Platform project that the job belongs to. */
                projectId: string;
                /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
                quotaUser?: string;
                /** Legacy upload protocol for media (e.g. "media", "multipart"). */
                uploadType?: string;
                /** Upload protocol for media (e.g. "raw", "multipart"). */
                upload_protocol?: string;
            }): Request<Job>;
            debug: DebugResource;
            messages: MessagesResource;
            workItems: WorkItemsResource;
        }
        interface DebugResource {
            /** Get encoded debug configuration for component. Not cacheable. */
            getConfig(request: {
                /** V1 error format. */
                "$.xgafv"?: string;
                /** OAuth access token. */
                access_token?: string;
                /** Data format for response. */
                alt?: string;
                /** OAuth bearer token. */
                bearer_token?: string;
                /** JSONP */
                callback?: string;
                /** Selector specifying which fields to include in a partial response. */
                fields?: string;
                /** The job id. */
                jobId: string;
                /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
                key?: string;
                /** The location which contains the job specified by job_id. */
                location: string;
                /** OAuth 2.0 token for the current user. */
                oauth_token?: string;
                /** Pretty-print response. */
                pp?: boolean;
                /** Returns response with indentations and line breaks. */
                prettyPrint?: boolean;
                /** The project id. */
                projectId: string;
                /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
                quotaUser?: string;
                /** Legacy upload protocol for media (e.g. "media", "multipart"). */
                uploadType?: string;
                /** Upload protocol for media (e.g. "raw", "multipart"). */
                upload_protocol?: string;
            }): Request<GetDebugConfigResponse>;
            /** Send encoded debug capture data for component. */
            sendCapture(request: {
                /** V1 error format. */
                "$.xgafv"?: string;
                /** OAuth access token. */
                access_token?: string;
                /** Data format for response. */
                alt?: string;
                /** OAuth bearer token. */
                bearer_token?: string;
                /** JSONP */
                callback?: string;
                /** Selector specifying which fields to include in a partial response. */
                fields?: string;
                /** The job id. */
                jobId: string;
                /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
                key?: string;
                /** The location which contains the job specified by job_id. */
                location: string;
                /** OAuth 2.0 token for the current user. */
                oauth_token?: string;
                /** Pretty-print response. */
                pp?: boolean;
                /** Returns response with indentations and line breaks. */
                prettyPrint?: boolean;
                /** The project id. */
                projectId: string;
                /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
                quotaUser?: string;
                /** Legacy upload protocol for media (e.g. "media", "multipart"). */
                uploadType?: string;
                /** Upload protocol for media (e.g. "raw", "multipart"). */
                upload_protocol?: string;
            }): Request<{}>;
        }
        interface MessagesResource {
            /** Request the job status. */
            list(request: {
                /** V1 error format. */
                "$.xgafv"?: string;
                /** OAuth access token. */
                access_token?: string;
                /** Data format for response. */
                alt?: string;
                /** OAuth bearer token. */
                bearer_token?: string;
                /** JSONP */
                callback?: string;
                /**
                 * Return only messages with timestamps < end_time. The default is now
                 * (i.e. return up to the latest messages available).
                 */
                endTime?: string;
                /** Selector specifying which fields to include in a partial response. */
                fields?: string;
                /** The job to get messages about. */
                jobId: string;
                /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
                key?: string;
                /** The location which contains the job specified by job_id. */
                location: string;
                /** Filter to only get messages with importance >= level */
                minimumImportance?: string;
                /** OAuth 2.0 token for the current user. */
                oauth_token?: string;
                /**
                 * If specified, determines the maximum number of messages to
                 * return.  If unspecified, the service may choose an appropriate
                 * default, or may return an arbitrarily large number of results.
                 */
                pageSize?: number;
                /**
                 * If supplied, this should be the value of next_page_token returned
                 * by an earlier call. This will cause the next page of results to
                 * be returned.
                 */
                pageToken?: string;
                /** Pretty-print response. */
                pp?: boolean;
                /** Returns response with indentations and line breaks. */
                prettyPrint?: boolean;
                /** A project id. */
                projectId: string;
                /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
                quotaUser?: string;
                /**
                 * If specified, return only messages with timestamps >= start_time.
                 * The default is the job creation time (i.e. beginning of messages).
                 */
                startTime?: string;
                /** Legacy upload protocol for media (e.g. "media", "multipart"). */
                uploadType?: string;
                /** Upload protocol for media (e.g. "raw", "multipart"). */
                upload_protocol?: string;
            }): Request<ListJobMessagesResponse>;
        }
        interface WorkItemsResource {
            /** Leases a dataflow WorkItem to run. */
            lease(request: {
                /** V1 error format. */
                "$.xgafv"?: string;
                /** OAuth access token. */
                access_token?: string;
                /** Data format for response. */
                alt?: string;
                /** OAuth bearer token. */
                bearer_token?: string;
                /** JSONP */
                callback?: string;
                /** Selector specifying which fields to include in a partial response. */
                fields?: string;
                /** Identifies the workflow job this worker belongs to. */
                jobId: string;
                /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
                key?: string;
                /** The location which contains the WorkItem's job. */
                location: string;
                /** OAuth 2.0 token for the current user. */
                oauth_token?: string;
                /** Pretty-print response. */
                pp?: boolean;
                /** Returns response with indentations and line breaks. */
                prettyPrint?: boolean;
                /** Identifies the project this worker belongs to. */
                projectId: string;
                /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
                quotaUser?: string;
                /** Legacy upload protocol for media (e.g. "media", "multipart"). */
                uploadType?: string;
                /** Upload protocol for media (e.g. "raw", "multipart"). */
                upload_protocol?: string;
            }): Request<LeaseWorkItemResponse>;
            /** Reports the status of dataflow WorkItems leased by a worker. */
            reportStatus(request: {
                /** V1 error format. */
                "$.xgafv"?: string;
                /** OAuth access token. */
                access_token?: string;
                /** Data format for response. */
                alt?: string;
                /** OAuth bearer token. */
                bearer_token?: string;
                /** JSONP */
                callback?: string;
                /** Selector specifying which fields to include in a partial response. */
                fields?: string;
                /** The job which the WorkItem is part of. */
                jobId: string;
                /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
                key?: string;
                /** The location which contains the WorkItem's job. */
                location: string;
                /** OAuth 2.0 token for the current user. */
                oauth_token?: string;
                /** Pretty-print response. */
                pp?: boolean;
                /** Returns response with indentations and line breaks. */
                prettyPrint?: boolean;
                /** The project which owns the WorkItem's job. */
                projectId: string;
                /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
                quotaUser?: string;
                /** Legacy upload protocol for media (e.g. "media", "multipart"). */
                uploadType?: string;
                /** Upload protocol for media (e.g. "raw", "multipart"). */
                upload_protocol?: string;
            }): Request<ReportWorkItemStatusResponse>;
        }
        interface JobsResource {
            /** Creates a Cloud Dataflow job. */
            create(request: {
                /** V1 error format. */
                "$.xgafv"?: string;
                /** OAuth access token. */
                access_token?: string;
                /** Data format for response. */
                alt?: string;
                /** OAuth bearer token. */
                bearer_token?: string;
                /** JSONP */
                callback?: string;
                /** Selector specifying which fields to include in a partial response. */
                fields?: string;
                /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
                key?: string;
                /** The location that contains this job. */
                location: string;
                /** OAuth 2.0 token for the current user. */
                oauth_token?: string;
                /** Pretty-print response. */
                pp?: boolean;
                /** Returns response with indentations and line breaks. */
                prettyPrint?: boolean;
                /** The ID of the Cloud Platform project that the job belongs to. */
                projectId: string;
                /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
                quotaUser?: string;
                /** Deprecated. This field is now in the Job message. */
                replaceJobId?: string;
                /** Legacy upload protocol for media (e.g. "media", "multipart"). */
                uploadType?: string;
                /** Upload protocol for media (e.g. "raw", "multipart"). */
                upload_protocol?: string;
                /** The level of information requested in response. */
                view?: string;
            }): Request<Job>;
            /** Gets the state of the specified Cloud Dataflow job. */
            get(request: {
                /** V1 error format. */
                "$.xgafv"?: string;
                /** OAuth access token. */
                access_token?: string;
                /** Data format for response. */
                alt?: string;
                /** OAuth bearer token. */
                bearer_token?: string;
                /** JSONP */
                callback?: string;
                /** Selector specifying which fields to include in a partial response. */
                fields?: string;
                /** The job ID. */
                jobId: string;
                /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
                key?: string;
                /** The location that contains this job. */
                location: string;
                /** OAuth 2.0 token for the current user. */
                oauth_token?: string;
                /** Pretty-print response. */
                pp?: boolean;
                /** Returns response with indentations and line breaks. */
                prettyPrint?: boolean;
                /** The ID of the Cloud Platform project that the job belongs to. */
                projectId: string;
                /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
                quotaUser?: string;
                /** Legacy upload protocol for media (e.g. "media", "multipart"). */
                uploadType?: string;
                /** Upload protocol for media (e.g. "raw", "multipart"). */
                upload_protocol?: string;
                /** The level of information requested in response. */
                view?: string;
            }): Request<Job>;
            /** Request the job status. */
            getMetrics(request: {
                /** V1 error format. */
                "$.xgafv"?: string;
                /** OAuth access token. */
                access_token?: string;
                /** Data format for response. */
                alt?: string;
                /** OAuth bearer token. */
                bearer_token?: string;
                /** JSONP */
                callback?: string;
                /** Selector specifying which fields to include in a partial response. */
                fields?: string;
                /** The job to get messages for. */
                jobId: string;
                /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
                key?: string;
                /** The location which contains the job specified by job_id. */
                location: string;
                /** OAuth 2.0 token for the current user. */
                oauth_token?: string;
                /** Pretty-print response. */
                pp?: boolean;
                /** Returns response with indentations and line breaks. */
                prettyPrint?: boolean;
                /** A project id. */
                projectId: string;
                /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
                quotaUser?: string;
                /**
                 * Return only metric data that has changed since this time.
                 * Default is to return all information about all metrics for the job.
                 */
                startTime?: string;
                /** Legacy upload protocol for media (e.g. "media", "multipart"). */
                uploadType?: string;
                /** Upload protocol for media (e.g. "raw", "multipart"). */
                upload_protocol?: string;
            }): Request<JobMetrics>;
            /** List the jobs of a project in a given region. */
            list(request: {
                /** V1 error format. */
                "$.xgafv"?: string;
                /** OAuth access token. */
                access_token?: string;
                /** Data format for response. */
                alt?: string;
                /** OAuth bearer token. */
                bearer_token?: string;
                /** JSONP */
                callback?: string;
                /** Selector specifying which fields to include in a partial response. */
                fields?: string;
                /** The kind of filter to use. */
                filter?: string;
                /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
                key?: string;
                /** The location that contains this job. */
                location: string;
                /** OAuth 2.0 token for the current user. */
                oauth_token?: string;
                /**
                 * If there are many jobs, limit response to at most this many.
                 * The actual number of jobs returned will be the lesser of max_responses
                 * and an unspecified server-defined limit.
                 */
                pageSize?: number;
                /**
                 * Set this to the 'next_page_token' field of a previous response
                 * to request additional results in a long list.
                 */
                pageToken?: string;
                /** Pretty-print response. */
                pp?: boolean;
                /** Returns response with indentations and line breaks. */
                prettyPrint?: boolean;
                /** The project which owns the jobs. */
                projectId: string;
                /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
                quotaUser?: string;
                /** Legacy upload protocol for media (e.g. "media", "multipart"). */
                uploadType?: string;
                /** Upload protocol for media (e.g. "raw", "multipart"). */
                upload_protocol?: string;
                /** Level of information requested in response. Default is `JOB_VIEW_SUMMARY`. */
                view?: string;
            }): Request<ListJobsResponse>;
            /** Updates the state of an existing Cloud Dataflow job. */
            update(request: {
                /** V1 error format. */
                "$.xgafv"?: string;
                /** OAuth access token. */
                access_token?: string;
                /** Data format for response. */
                alt?: string;
                /** OAuth bearer token. */
                bearer_token?: string;
                /** JSONP */
                callback?: string;
                /** Selector specifying which fields to include in a partial response. */
                fields?: string;
                /** The job ID. */
                jobId: string;
                /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
                key?: string;
                /** The location that contains this job. */
                location: string;
                /** OAuth 2.0 token for the current user. */
                oauth_token?: string;
                /** Pretty-print response. */
                pp?: boolean;
                /** Returns response with indentations and line breaks. */
                prettyPrint?: boolean;
                /** The ID of the Cloud Platform project that the job belongs to. */
                projectId: string;
                /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
                quotaUser?: string;
                /** Legacy upload protocol for media (e.g. "media", "multipart"). */
                uploadType?: string;
                /** Upload protocol for media (e.g. "raw", "multipart"). */
                upload_protocol?: string;
            }): Request<Job>;
            debug: DebugResource;
            messages: MessagesResource;
            workItems: WorkItemsResource;
        }
        interface TemplatesResource {
            /** Creates a Cloud Dataflow job from a template. */
            create(request: {
                /** V1 error format. */
                "$.xgafv"?: string;
                /** OAuth access token. */
                access_token?: string;
                /** Data format for response. */
                alt?: string;
                /** OAuth bearer token. */
                bearer_token?: string;
                /** JSONP */
                callback?: string;
                /** Selector specifying which fields to include in a partial response. */
                fields?: string;
                /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
                key?: string;
                /** The location to which to direct the request. */
                location: string;
                /** OAuth 2.0 token for the current user. */
                oauth_token?: string;
                /** Pretty-print response. */
                pp?: boolean;
                /** Returns response with indentations and line breaks. */
                prettyPrint?: boolean;
                /** Required. The ID of the Cloud Platform project that the job belongs to. */
                projectId: string;
                /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
                quotaUser?: string;
                /** Legacy upload protocol for media (e.g. "media", "multipart"). */
                uploadType?: string;
                /** Upload protocol for media (e.g. "raw", "multipart"). */
                upload_protocol?: string;
            }): Request<Job>;
            /** Get the template associated with a template. */
            get(request: {
                /** V1 error format. */
                "$.xgafv"?: string;
                /** OAuth access token. */
                access_token?: string;
                /** Data format for response. */
                alt?: string;
                /** OAuth bearer token. */
                bearer_token?: string;
                /** JSONP */
                callback?: string;
                /** Selector specifying which fields to include in a partial response. */
                fields?: string;
                /**
                 * Required. A Cloud Storage path to the template from which to
                 * create the job.
                 * Must be a valid Cloud Storage URL, beginning with `gs://`.
                 */
                gcsPath?: string;
                /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
                key?: string;
                /** The location to which to direct the request. */
                location: string;
                /** OAuth 2.0 token for the current user. */
                oauth_token?: string;
                /** Pretty-print response. */
                pp?: boolean;
                /** Returns response with indentations and line breaks. */
                prettyPrint?: boolean;
                /** Required. The ID of the Cloud Platform project that the job belongs to. */
                projectId: string;
                /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
                quotaUser?: string;
                /** Legacy upload protocol for media (e.g. "media", "multipart"). */
                uploadType?: string;
                /** Upload protocol for media (e.g. "raw", "multipart"). */
                upload_protocol?: string;
                /** The view to retrieve. Defaults to METADATA_ONLY. */
                view?: string;
            }): Request<GetTemplateResponse>;
            /** Launch a template. */
            launch(request: {
                /** V1 error format. */
                "$.xgafv"?: string;
                /** OAuth access token. */
                access_token?: string;
                /** Data format for response. */
                alt?: string;
                /** OAuth bearer token. */
                bearer_token?: string;
                /** JSONP */
                callback?: string;
                /** Selector specifying which fields to include in a partial response. */
                fields?: string;
                /**
                 * Required. A Cloud Storage path to the template from which to create
                 * the job.
                 * Must be valid Cloud Storage URL, beginning with 'gs://'.
                 */
                gcsPath?: string;
                /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
                key?: string;
                /** The location to which to direct the request. */
                location: string;
                /** OAuth 2.0 token for the current user. */
                oauth_token?: string;
                /** Pretty-print response. */
                pp?: boolean;
                /** Returns response with indentations and line breaks. */
                prettyPrint?: boolean;
                /** Required. The ID of the Cloud Platform project that the job belongs to. */
                projectId: string;
                /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
                quotaUser?: string;
                /** Legacy upload protocol for media (e.g. "media", "multipart"). */
                uploadType?: string;
                /** Upload protocol for media (e.g. "raw", "multipart"). */
                upload_protocol?: string;
                /**
                 * If true, the request is validated but not actually executed.
                 * Defaults to false.
                 */
                validateOnly?: boolean;
            }): Request<LaunchTemplateResponse>;
        }
        interface LocationsResource {
            /** Send a worker_message to the service. */
            workerMessages(request: {
                /** V1 error format. */
                "$.xgafv"?: string;
                /** OAuth access token. */
                access_token?: string;
                /** Data format for response. */
                alt?: string;
                /** OAuth bearer token. */
                bearer_token?: string;
                /** JSONP */
                callback?: string;
                /** Selector specifying which fields to include in a partial response. */
                fields?: string;
                /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
                key?: string;
                /** The location which contains the job */
                location: string;
                /** OAuth 2.0 token for the current user. */
                oauth_token?: string;
                /** Pretty-print response. */
                pp?: boolean;
                /** Returns response with indentations and line breaks. */
                prettyPrint?: boolean;
                /** The project to send the WorkerMessages to. */
                projectId: string;
                /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
                quotaUser?: string;
                /** Legacy upload protocol for media (e.g. "media", "multipart"). */
                uploadType?: string;
                /** Upload protocol for media (e.g. "raw", "multipart"). */
                upload_protocol?: string;
            }): Request<SendWorkerMessagesResponse>;
            jobs: JobsResource;
            templates: TemplatesResource;
        }
        interface TemplatesResource {
            /** Creates a Cloud Dataflow job from a template. */
            create(request: {
                /** V1 error format. */
                "$.xgafv"?: string;
                /** OAuth access token. */
                access_token?: string;
                /** Data format for response. */
                alt?: string;
                /** OAuth bearer token. */
                bearer_token?: string;
                /** JSONP */
                callback?: string;
                /** Selector specifying which fields to include in a partial response. */
                fields?: string;
                /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
                key?: string;
                /** OAuth 2.0 token for the current user. */
                oauth_token?: string;
                /** Pretty-print response. */
                pp?: boolean;
                /** Returns response with indentations and line breaks. */
                prettyPrint?: boolean;
                /** Required. The ID of the Cloud Platform project that the job belongs to. */
                projectId: string;
                /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
                quotaUser?: string;
                /** Legacy upload protocol for media (e.g. "media", "multipart"). */
                uploadType?: string;
                /** Upload protocol for media (e.g. "raw", "multipart"). */
                upload_protocol?: string;
            }): Request<Job>;
            /** Get the template associated with a template. */
            get(request: {
                /** V1 error format. */
                "$.xgafv"?: string;
                /** OAuth access token. */
                access_token?: string;
                /** Data format for response. */
                alt?: string;
                /** OAuth bearer token. */
                bearer_token?: string;
                /** JSONP */
                callback?: string;
                /** Selector specifying which fields to include in a partial response. */
                fields?: string;
                /**
                 * Required. A Cloud Storage path to the template from which to
                 * create the job.
                 * Must be a valid Cloud Storage URL, beginning with `gs://`.
                 */
                gcsPath?: string;
                /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
                key?: string;
                /** The location to which to direct the request. */
                location?: string;
                /** OAuth 2.0 token for the current user. */
                oauth_token?: string;
                /** Pretty-print response. */
                pp?: boolean;
                /** Returns response with indentations and line breaks. */
                prettyPrint?: boolean;
                /** Required. The ID of the Cloud Platform project that the job belongs to. */
                projectId: string;
                /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
                quotaUser?: string;
                /** Legacy upload protocol for media (e.g. "media", "multipart"). */
                uploadType?: string;
                /** Upload protocol for media (e.g. "raw", "multipart"). */
                upload_protocol?: string;
                /** The view to retrieve. Defaults to METADATA_ONLY. */
                view?: string;
            }): Request<GetTemplateResponse>;
            /** Launch a template. */
            launch(request: {
                /** V1 error format. */
                "$.xgafv"?: string;
                /** OAuth access token. */
                access_token?: string;
                /** Data format for response. */
                alt?: string;
                /** OAuth bearer token. */
                bearer_token?: string;
                /** JSONP */
                callback?: string;
                /** Selector specifying which fields to include in a partial response. */
                fields?: string;
                /**
                 * Required. A Cloud Storage path to the template from which to create
                 * the job.
                 * Must be valid Cloud Storage URL, beginning with 'gs://'.
                 */
                gcsPath?: string;
                /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
                key?: string;
                /** The location to which to direct the request. */
                location?: string;
                /** OAuth 2.0 token for the current user. */
                oauth_token?: string;
                /** Pretty-print response. */
                pp?: boolean;
                /** Returns response with indentations and line breaks. */
                prettyPrint?: boolean;
                /** Required. The ID of the Cloud Platform project that the job belongs to. */
                projectId: string;
                /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
                quotaUser?: string;
                /** Legacy upload protocol for media (e.g. "media", "multipart"). */
                uploadType?: string;
                /** Upload protocol for media (e.g. "raw", "multipart"). */
                upload_protocol?: string;
                /**
                 * If true, the request is validated but not actually executed.
                 * Defaults to false.
                 */
                validateOnly?: boolean;
            }): Request<LaunchTemplateResponse>;
        }
        interface ProjectsResource {
            /** Send a worker_message to the service. */
            workerMessages(request: {
                /** V1 error format. */
                "$.xgafv"?: string;
                /** OAuth access token. */
                access_token?: string;
                /** Data format for response. */
                alt?: string;
                /** OAuth bearer token. */
                bearer_token?: string;
                /** JSONP */
                callback?: string;
                /** Selector specifying which fields to include in a partial response. */
                fields?: string;
                /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
                key?: string;
                /** OAuth 2.0 token for the current user. */
                oauth_token?: string;
                /** Pretty-print response. */
                pp?: boolean;
                /** Returns response with indentations and line breaks. */
                prettyPrint?: boolean;
                /** The project to send the WorkerMessages to. */
                projectId: string;
                /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
                quotaUser?: string;
                /** Legacy upload protocol for media (e.g. "media", "multipart"). */
                uploadType?: string;
                /** Upload protocol for media (e.g. "raw", "multipart"). */
                upload_protocol?: string;
            }): Request<SendWorkerMessagesResponse>;
            jobs: JobsResource;
            locations: LocationsResource;
            templates: TemplatesResource;
        }
    }
}