Package dataflow

import "google.golang.org/api/dataflow/v1b3"
...
ctx := context.Background()
dataflowService, err := dataflow.NewService(ctx)

dataflowService, err := dataflow.NewService(ctx, option.WithScopes(dataflow.ComputeReadonlyScope))

dataflowService, err := dataflow.NewService(ctx, option.WithAPIKey("AIza..."))

config := &oauth2.Config{...}
// ...
token, err := config.Exchange(ctx, ...)
dataflowService, err := dataflow.NewService(ctx, option.WithTokenSource(config.TokenSource(ctx, token)))

Constants

OAuth2 scopes used by this API.

const (
    // See, edit, configure, and delete your Google Cloud data and see the email
    // address for your Google Account.
    CloudPlatformScope = "https://www.googleapis.com/auth/cloud-platform"

    // View and manage your Google Compute Engine resources
    ComputeScope = "https://www.googleapis.com/auth/compute"

    // View your Google Compute Engine resources
    ComputeReadonlyScope = "https://www.googleapis.com/auth/compute.readonly"
)

type ApproximateProgress ¶

ApproximateProgress: Obsolete in favor of ApproximateReportedProgress and ApproximateSplitRequest.

type ApproximateProgress struct {
    // PercentComplete: Obsolete.
    PercentComplete float64 `json:"percentComplete,omitempty"`
    // Position: Obsolete.
    Position *Position `json:"position,omitempty"`
    // RemainingTime: Obsolete.
    RemainingTime string `json:"remainingTime,omitempty"`
    // ForceSendFields is a list of field names (e.g. "PercentComplete") to
    // unconditionally include in API requests. By default, fields with empty or
    // default values are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "PercentComplete") to include in
    // API requests with the JSON null value. By default, fields with empty values
    // are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*ApproximateProgress) MarshalJSON ¶

func (s *ApproximateProgress) MarshalJSON() ([]byte, error)

func (*ApproximateProgress) UnmarshalJSON ¶

func (s *ApproximateProgress) UnmarshalJSON(data []byte) error

type ApproximateReportedProgress ¶

ApproximateReportedProgress: A progress measurement of a WorkItem by a worker.

type ApproximateReportedProgress struct {
    // ConsumedParallelism: 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 `json:"consumedParallelism,omitempty"`
    // FractionConsumed: Completion as fraction of the input consumed, from 0.0
    // (beginning, nothing consumed), to 1.0 (end of the input, entire input
    // consumed).
    FractionConsumed float64 `json:"fractionConsumed,omitempty"`
    // Position: A Position within the work to represent a progress.
    Position *Position `json:"position,omitempty"`
    // RemainingParallelism: 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: * 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). * 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). * 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 `json:"remainingParallelism,omitempty"`
    // ForceSendFields is a list of field names (e.g. "ConsumedParallelism") to
    // unconditionally include in API requests. By default, fields with empty or
    // default values are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "ConsumedParallelism") to include
    // in API requests with the JSON null value. By default, fields with empty
    // values are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*ApproximateReportedProgress) MarshalJSON ¶

func (s *ApproximateReportedProgress) MarshalJSON() ([]byte, error)

func (*ApproximateReportedProgress) UnmarshalJSON ¶

func (s *ApproximateReportedProgress) UnmarshalJSON(data []byte) error

type ApproximateSplitRequest ¶

ApproximateSplitRequest: A suggestion by the service to the worker to dynamically split the WorkItem.

type ApproximateSplitRequest struct {
    // FractionConsumed: A fraction at which to split the work item, from 0.0
    // (beginning of the input) to 1.0 (end of the input).
    FractionConsumed float64 `json:"fractionConsumed,omitempty"`
    // FractionOfRemainder: The fraction of the remainder of work to split the work
    // item at, from 0.0 (split at the current position) to 1.0 (end of the input).
    FractionOfRemainder float64 `json:"fractionOfRemainder,omitempty"`
    // Position: A Position at which to split the work item.
    Position *Position `json:"position,omitempty"`
    // ForceSendFields is a list of field names (e.g. "FractionConsumed") to
    // unconditionally include in API requests. By default, fields with empty or
    // default values are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "FractionConsumed") to include in
    // API requests with the JSON null value. By default, fields with empty values
    // are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*ApproximateSplitRequest) MarshalJSON ¶

func (s *ApproximateSplitRequest) MarshalJSON() ([]byte, error)

func (*ApproximateSplitRequest) UnmarshalJSON ¶

func (s *ApproximateSplitRequest) UnmarshalJSON(data []byte) error

type AutoscalingEvent ¶

AutoscalingEvent: A structured message reporting an autoscaling decision made by the Dataflow service.

type AutoscalingEvent struct {
    // CurrentNumWorkers: The current number of workers the job has.
    CurrentNumWorkers int64 `json:"currentNumWorkers,omitempty,string"`
    // Description: 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 `json:"description,omitempty"`
    // EventType: The type of autoscaling event to report.
    //
    // Possible values:
    //   "TYPE_UNKNOWN" - Default type for the enum. Value should never be
    // returned.
    //   "TARGET_NUM_WORKERS_CHANGED" - The TARGET_NUM_WORKERS_CHANGED type should
    // be used when the target worker pool size has changed at the start of an
    // actuation. An event should always be specified as TARGET_NUM_WORKERS_CHANGED
    // if it reflects a change in the target_num_workers.
    //   "CURRENT_NUM_WORKERS_CHANGED" - The CURRENT_NUM_WORKERS_CHANGED type
    // should be used when actual worker pool size has been changed, but the
    // target_num_workers has not changed.
    //   "ACTUATION_FAILURE" - The ACTUATION_FAILURE type should be used when we
    // want to report an error to the user indicating why the current number of
    // workers in the pool could not be changed. Displayed in the current status
    // and history widgets.
    //   "NO_CHANGE" - Used when we want to report to the user a reason why we are
    // not currently adjusting the number of workers. Should specify both
    // target_num_workers, current_num_workers and a decision_message.
    EventType string `json:"eventType,omitempty"`
    // TargetNumWorkers: The target number of workers the worker pool wants to
    // resize to use.
    TargetNumWorkers int64 `json:"targetNumWorkers,omitempty,string"`
    // Time: The time this event was emitted to indicate a new target or current
    // num_workers value.
    Time string `json:"time,omitempty"`
    // WorkerPool: A short and friendly name for the worker pool this event refers
    // to.
    WorkerPool string `json:"workerPool,omitempty"`
    // ForceSendFields is a list of field names (e.g. "CurrentNumWorkers") to
    // unconditionally include in API requests. By default, fields with empty or
    // default values are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "CurrentNumWorkers") to include in
    // API requests with the JSON null value. By default, fields with empty values
    // are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*AutoscalingEvent) MarshalJSON ¶

func (s *AutoscalingEvent) MarshalJSON() ([]byte, error)

type AutoscalingSettings ¶

AutoscalingSettings: Settings for WorkerPool autoscaling.

type AutoscalingSettings struct {
    // Algorithm: The algorithm to use for autoscaling.
    //
    // Possible values:
    //   "AUTOSCALING_ALGORITHM_UNKNOWN" - The algorithm is unknown, or
    // unspecified.
    //   "AUTOSCALING_ALGORITHM_NONE" - Disable autoscaling.
    //   "AUTOSCALING_ALGORITHM_BASIC" - Increase worker count over time to reduce
    // job execution time.
    Algorithm string `json:"algorithm,omitempty"`
    // MaxNumWorkers: The maximum number of workers to cap scaling at.
    MaxNumWorkers int64 `json:"maxNumWorkers,omitempty"`
    // ForceSendFields is a list of field names (e.g. "Algorithm") to
    // unconditionally include in API requests. By default, fields with empty or
    // default values are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "Algorithm") to include in API
    // requests with the JSON null value. By default, fields with empty values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*AutoscalingSettings) MarshalJSON ¶

func (s *AutoscalingSettings) MarshalJSON() ([]byte, error)

type Base2Exponent ¶

Base2Exponent: Exponential buckets where the growth factor between buckets is `2**(2**-scale)`. e.g. for `scale=1` growth factor is `2**(2**(-1))=sqrt(2)`. `n` buckets will have the following boundaries. - 0th: [0, gf) - i in [1, n-1]: [gf^(i), gf^(i+1))

type Base2Exponent struct {
    // NumberOfBuckets: Must be greater than 0.
    NumberOfBuckets int64 `json:"numberOfBuckets,omitempty"`
    // Scale: Must be between -3 and 3. This forces the growth factor of the bucket
    // boundaries to be between `2^(1/8)` and `256`.
    Scale int64 `json:"scale,omitempty"`
    // ForceSendFields is a list of field names (e.g. "NumberOfBuckets") to
    // unconditionally include in API requests. By default, fields with empty or
    // default values are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "NumberOfBuckets") to include in
    // API requests with the JSON null value. By default, fields with empty values
    // are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*Base2Exponent) MarshalJSON ¶

func (s *Base2Exponent) MarshalJSON() ([]byte, error)

type BigQueryIODetails ¶

BigQueryIODetails: Metadata for a BigQuery connector used by the job.

type BigQueryIODetails struct {
    // Dataset: Dataset accessed in the connection.
    Dataset string `json:"dataset,omitempty"`
    // ProjectId: Project accessed in the connection.
    ProjectId string `json:"projectId,omitempty"`
    // Query: Query used to access data in the connection.
    Query string `json:"query,omitempty"`
    // Table: Table accessed in the connection.
    Table string `json:"table,omitempty"`
    // ForceSendFields is a list of field names (e.g. "Dataset") to unconditionally
    // include in API requests. By default, fields with empty or default values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "Dataset") to include in API
    // requests with the JSON null value. By default, fields with empty values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*BigQueryIODetails) MarshalJSON ¶

func (s *BigQueryIODetails) MarshalJSON() ([]byte, error)

type BigTableIODetails ¶

BigTableIODetails: Metadata for a Cloud Bigtable connector used by the job.

type BigTableIODetails struct {
    // InstanceId: InstanceId accessed in the connection.
    InstanceId string `json:"instanceId,omitempty"`
    // ProjectId: ProjectId accessed in the connection.
    ProjectId string `json:"projectId,omitempty"`
    // TableId: TableId accessed in the connection.
    TableId string `json:"tableId,omitempty"`
    // ForceSendFields is a list of field names (e.g. "InstanceId") to
    // unconditionally include in API requests. By default, fields with empty or
    // default values are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "InstanceId") to include in API
    // requests with the JSON null value. By default, fields with empty values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*BigTableIODetails) MarshalJSON ¶

func (s *BigTableIODetails) MarshalJSON() ([]byte, error)

type BucketOptions ¶

BucketOptions: `BucketOptions` describes the bucket boundaries used in the histogram.

type BucketOptions struct {
    // Exponential: Bucket boundaries grow exponentially.
    Exponential *Base2Exponent `json:"exponential,omitempty"`
    // Linear: Bucket boundaries grow linearly.
    Linear *Linear `json:"linear,omitempty"`
    // ForceSendFields is a list of field names (e.g. "Exponential") to
    // unconditionally include in API requests. By default, fields with empty or
    // default values are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "Exponential") to include in API
    // requests with the JSON null value. By default, fields with empty values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*BucketOptions) MarshalJSON ¶

func (s *BucketOptions) MarshalJSON() ([]byte, error)

type CPUTime ¶

CPUTime: Modeled after information exposed by /proc/stat.

type CPUTime struct {
    // Rate: Average CPU utilization rate (% non-idle cpu / second) since previous
    // sample.
    Rate float64 `json:"rate,omitempty"`
    // Timestamp: Timestamp of the measurement.
    Timestamp string `json:"timestamp,omitempty"`
    // TotalMs: Total active CPU time across all cores (ie., non-idle) in
    // milliseconds since start-up.
    TotalMs uint64 `json:"totalMs,omitempty,string"`
    // ForceSendFields is a list of field names (e.g. "Rate") to unconditionally
    // include in API requests. By default, fields with empty or default values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "Rate") to include in API requests
    // with the JSON null value. By default, fields with empty values are omitted
    // from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*CPUTime) MarshalJSON ¶

func (s *CPUTime) MarshalJSON() ([]byte, error)

func (*CPUTime) UnmarshalJSON ¶

func (s *CPUTime) UnmarshalJSON(data []byte) error

type ComponentSource ¶

ComponentSource: Description of an interstitial value between transforms in an execution stage.

type ComponentSource struct {
    // Name: Dataflow service generated name for this source.
    Name string `json:"name,omitempty"`
    // OriginalTransformOrCollection: User name for the original user transform or
    // collection with which this source is most closely associated.
    OriginalTransformOrCollection string `json:"originalTransformOrCollection,omitempty"`
    // UserName: Human-readable name for this transform; may be user or system
    // generated.
    UserName string `json:"userName,omitempty"`
    // ForceSendFields is a list of field names (e.g. "Name") to unconditionally
    // include in API requests. By default, fields with empty or default values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "Name") to include in API requests
    // with the JSON null value. By default, fields with empty values are omitted
    // from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*ComponentSource) MarshalJSON ¶

func (s *ComponentSource) MarshalJSON() ([]byte, error)

type ComponentTransform ¶

ComponentTransform: Description of a transform executed as part of an execution stage.

type ComponentTransform struct {
    // Name: Dataflow service generated name for this source.
    Name string `json:"name,omitempty"`
    // OriginalTransform: User name for the original user transform with which this
    // transform is most closely associated.
    OriginalTransform string `json:"originalTransform,omitempty"`
    // UserName: Human-readable name for this transform; may be user or system
    // generated.
    UserName string `json:"userName,omitempty"`
    // ForceSendFields is a list of field names (e.g. "Name") to unconditionally
    // include in API requests. By default, fields with empty or default values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "Name") to include in API requests
    // with the JSON null value. By default, fields with empty values are omitted
    // from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*ComponentTransform) MarshalJSON ¶

func (s *ComponentTransform) MarshalJSON() ([]byte, error)

type ComputationTopology ¶

ComputationTopology: All configuration data for a particular Computation.

type ComputationTopology struct {
    // ComputationId: The ID of the computation.
    ComputationId string `json:"computationId,omitempty"`
    // Inputs: The inputs to the computation.
    Inputs []*StreamLocation `json:"inputs,omitempty"`
    // KeyRanges: The key ranges processed by the computation.
    KeyRanges []*KeyRangeLocation `json:"keyRanges,omitempty"`
    // Outputs: The outputs from the computation.
    Outputs []*StreamLocation `json:"outputs,omitempty"`
    // StateFamilies: The state family values.
    StateFamilies []*StateFamilyConfig `json:"stateFamilies,omitempty"`
    // SystemStageName: The system stage name.
    SystemStageName string `json:"systemStageName,omitempty"`
    // ForceSendFields is a list of field names (e.g. "ComputationId") to
    // unconditionally include in API requests. By default, fields with empty or
    // default values are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "ComputationId") to include in API
    // requests with the JSON null value. By default, fields with empty values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*ComputationTopology) MarshalJSON ¶

func (s *ComputationTopology) MarshalJSON() ([]byte, error)

type ConcatPosition ¶

ConcatPosition: A position that encapsulates an inner position and an index for the inner position. A ConcatPosition can be used by a reader of a source that encapsulates a set of other sources.

type ConcatPosition struct {
    // Index: Index of the inner source.
    Index int64 `json:"index,omitempty"`
    // Position: Position within the inner source.
    Position *Position `json:"position,omitempty"`
    // ForceSendFields is a list of field names (e.g. "Index") to unconditionally
    // include in API requests. By default, fields with empty or default values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "Index") to include in API
    // requests with the JSON null value. By default, fields with empty values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*ConcatPosition) MarshalJSON ¶

func (s *ConcatPosition) MarshalJSON() ([]byte, error)

type ContainerSpec ¶

ContainerSpec: Container Spec.

type ContainerSpec struct {
    // DefaultEnvironment: Default runtime environment for the job.
    DefaultEnvironment *FlexTemplateRuntimeEnvironment `json:"defaultEnvironment,omitempty"`
    // Image: Name of the docker container image. E.g., gcr.io/project/some-image
    Image string `json:"image,omitempty"`
    // ImageRepositoryCertPath: Cloud Storage path to self-signed certificate of
    // private registry.
    ImageRepositoryCertPath string `json:"imageRepositoryCertPath,omitempty"`
    // ImageRepositoryPasswordSecretId: Secret Manager secret id for password to
    // authenticate to private registry.
    ImageRepositoryPasswordSecretId string `json:"imageRepositoryPasswordSecretId,omitempty"`
    // ImageRepositoryUsernameSecretId: Secret Manager secret id for username to
    // authenticate to private registry.
    ImageRepositoryUsernameSecretId string `json:"imageRepositoryUsernameSecretId,omitempty"`
    // Metadata: Metadata describing a template including description and
    // validation rules.
    Metadata *TemplateMetadata `json:"metadata,omitempty"`
    // SdkInfo: Required. SDK info of the Flex Template.
    SdkInfo *SDKInfo `json:"sdkInfo,omitempty"`
    // ForceSendFields is a list of field names (e.g. "DefaultEnvironment") to
    // unconditionally include in API requests. By default, fields with empty or
    // default values are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "DefaultEnvironment") to include
    // in API requests with the JSON null value. By default, fields with empty
    // values are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*ContainerSpec) MarshalJSON ¶

func (s *ContainerSpec) MarshalJSON() ([]byte, error)

type CounterMetadata ¶

CounterMetadata: CounterMetadata includes all static non-name non-value counter attributes.

type CounterMetadata struct {
    // Description: Human-readable description of the counter semantics.
    Description string `json:"description,omitempty"`
    // Kind: Counter aggregation kind.
    //
    // Possible values:
    //   "INVALID" - Counter aggregation kind was not set.
    //   "SUM" - Aggregated value is the sum of all contributed values.
    //   "MAX" - Aggregated value is the max of all contributed values.
    //   "MIN" - Aggregated value is the min of all contributed values.
    //   "MEAN" - Aggregated value is the mean of all contributed values.
    //   "OR" - Aggregated value represents the logical 'or' of all contributed
    // values.
    //   "AND" - Aggregated value represents the logical 'and' of all contributed
    // values.
    //   "SET" - Aggregated value is a set of unique contributed values.
    //   "DISTRIBUTION" - Aggregated value captures statistics about a
    // distribution.
    //   "LATEST_VALUE" - Aggregated value tracks the latest value of a variable.
    Kind string `json:"kind,omitempty"`
    // OtherUnits: A string referring to the unit type.
    OtherUnits string `json:"otherUnits,omitempty"`
    // StandardUnits: System defined Units, see above enum.
    //
    // Possible values:
    //   "BYTES" - Counter returns a value in bytes.
    //   "BYTES_PER_SEC" - Counter returns a value in bytes per second.
    //   "MILLISECONDS" - Counter returns a value in milliseconds.
    //   "MICROSECONDS" - Counter returns a value in microseconds.
    //   "NANOSECONDS" - Counter returns a value in nanoseconds.
    //   "TIMESTAMP_MSEC" - Counter returns a timestamp in milliseconds.
    //   "TIMESTAMP_USEC" - Counter returns a timestamp in microseconds.
    //   "TIMESTAMP_NSEC" - Counter returns a timestamp in nanoseconds.
    StandardUnits string `json:"standardUnits,omitempty"`
    // ForceSendFields is a list of field names (e.g. "Description") to
    // unconditionally include in API requests. By default, fields with empty or
    // default values are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "Description") to include in API
    // requests with the JSON null value. By default, fields with empty values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*CounterMetadata) MarshalJSON ¶

func (s *CounterMetadata) MarshalJSON() ([]byte, error)

type CounterStructuredName ¶

CounterStructuredName: Identifies a counter within a per-job namespace. Counters whose structured names are the same get merged into a single value for the job.

type CounterStructuredName struct {
    // ComponentStepName: Name of the optimized step being executed by the workers.
    ComponentStepName string `json:"componentStepName,omitempty"`
    // ExecutionStepName: Name of the stage. An execution step contains multiple
    // component steps.
    ExecutionStepName string `json:"executionStepName,omitempty"`
    // InputIndex: Index of an input collection that's being read from/written to
    // as a side input. The index identifies a step's side inputs starting by 1
    // (e.g. the first side input has input_index 1, the third has input_index 3).
    // Side inputs are identified by a pair of (original_step_name, input_index).
    // This field helps uniquely identify them.
    InputIndex int64 `json:"inputIndex,omitempty"`
    // Name: Counter name. Not necessarily globally-unique, but unique within the
    // context of the other fields. Required.
    Name string `json:"name,omitempty"`
    // Origin: One of the standard Origins defined above.
    //
    // Possible values:
    //   "SYSTEM" - Counter was created by the Dataflow system.
    //   "USER" - Counter was created by the user.
    Origin string `json:"origin,omitempty"`
    // OriginNamespace: A string containing a more specific namespace of the
    // counter's origin.
    OriginNamespace string `json:"originNamespace,omitempty"`
    // OriginalRequestingStepName: The step name requesting an operation, such as
    // GBK. I.e. the ParDo causing a read/write from shuffle to occur, or a read
    // from side inputs.
    OriginalRequestingStepName string `json:"originalRequestingStepName,omitempty"`
    // OriginalStepName: System generated name of the original step in the user's
    // graph, before optimization.
    OriginalStepName string `json:"originalStepName,omitempty"`
    // Portion: Portion of this counter, either key or value.
    //
    // Possible values:
    //   "ALL" - Counter portion has not been set.
    //   "KEY" - Counter reports a key.
    //   "VALUE" - Counter reports a value.
    Portion string `json:"portion,omitempty"`
    // WorkerId: ID of a particular worker.
    WorkerId string `json:"workerId,omitempty"`
    // ForceSendFields is a list of field names (e.g. "ComponentStepName") to
    // unconditionally include in API requests. By default, fields with empty or
    // default values are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "ComponentStepName") to include in
    // API requests with the JSON null value. By default, fields with empty values
    // are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*CounterStructuredName) MarshalJSON ¶

func (s *CounterStructuredName) MarshalJSON() ([]byte, error)

type CounterStructuredNameAndMetadata ¶

CounterStructuredNameAndMetadata: A single message which encapsulates structured name and metadata for a given counter.

type CounterStructuredNameAndMetadata struct {
    // Metadata: Metadata associated with a counter
    Metadata *CounterMetadata `json:"metadata,omitempty"`
    // Name: Structured name of the counter.
    Name *CounterStructuredName `json:"name,omitempty"`
    // ForceSendFields is a list of field names (e.g. "Metadata") to
    // unconditionally include in API requests. By default, fields with empty or
    // default values are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "Metadata") to include in API
    // requests with the JSON null value. By default, fields with empty values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*CounterStructuredNameAndMetadata) MarshalJSON ¶

func (s *CounterStructuredNameAndMetadata) MarshalJSON() ([]byte, error)

type CounterUpdate ¶

CounterUpdate: An update to a Counter sent from a worker.

type CounterUpdate struct {
    // Boolean: Boolean value for And, Or.
    Boolean bool `json:"boolean,omitempty"`
    // Cumulative: 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 bool `json:"cumulative,omitempty"`
    // Distribution: Distribution data
    Distribution *DistributionUpdate `json:"distribution,omitempty"`
    // FloatingPoint: Floating point value for Sum, Max, Min.
    FloatingPoint float64 `json:"floatingPoint,omitempty"`
    // FloatingPointList: List of floating point numbers, for Set.
    FloatingPointList *FloatingPointList `json:"floatingPointList,omitempty"`
    // FloatingPointMean: Floating point mean aggregation value for Mean.
    FloatingPointMean *FloatingPointMean `json:"floatingPointMean,omitempty"`
    // Integer: Integer value for Sum, Max, Min.
    Integer *SplitInt64 `json:"integer,omitempty"`
    // IntegerGauge: Gauge data
    IntegerGauge *IntegerGauge `json:"integerGauge,omitempty"`
    // IntegerList: List of integers, for Set.
    IntegerList *IntegerList `json:"integerList,omitempty"`
    // IntegerMean: Integer mean aggregation value for Mean.
    IntegerMean *IntegerMean `json:"integerMean,omitempty"`
    // Internal: Value for internally-defined counters used by the Dataflow
    // service.
    Internal interface{} `json:"internal,omitempty"`
    // NameAndKind: Counter name and aggregation type.
    NameAndKind *NameAndKind `json:"nameAndKind,omitempty"`
    // ShortId: The service-generated short identifier for this counter. The
    // short_id -> (name, metadata) mapping is constant for the lifetime of a job.
    ShortId int64 `json:"shortId,omitempty,string"`
    // StringList: List of strings, for Set.
    StringList *StringList `json:"stringList,omitempty"`
    // StructuredNameAndMetadata: Counter structured name and metadata.
    StructuredNameAndMetadata *CounterStructuredNameAndMetadata `json:"structuredNameAndMetadata,omitempty"`
    // ForceSendFields is a list of field names (e.g. "Boolean") to unconditionally
    // include in API requests. By default, fields with empty or default values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "Boolean") to include in API
    // requests with the JSON null value. By default, fields with empty values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*CounterUpdate) MarshalJSON ¶

func (s *CounterUpdate) MarshalJSON() ([]byte, error)

func (*CounterUpdate) UnmarshalJSON ¶

func (s *CounterUpdate) UnmarshalJSON(data []byte) error

type CreateJobFromTemplateRequest ¶

CreateJobFromTemplateRequest: A request to create a Cloud Dataflow job from a template.

type CreateJobFromTemplateRequest struct {
    // Environment: The runtime environment for the job.
    Environment *RuntimeEnvironment `json:"environment,omitempty"`
    // GcsPath: 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 `json:"gcsPath,omitempty"`
    // JobName: Required. The job name to use for the created job.
    JobName string `json:"jobName,omitempty"`
    // Location: The [regional endpoint]
    // (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) to
    // which to direct the request.
    Location string `json:"location,omitempty"`
    // Parameters: The runtime parameters to pass to the job.
    Parameters map[string]string `json:"parameters,omitempty"`
    // ForceSendFields is a list of field names (e.g. "Environment") to
    // unconditionally include in API requests. By default, fields with empty or
    // default values are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "Environment") to include in API
    // requests with the JSON null value. By default, fields with empty values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*CreateJobFromTemplateRequest) MarshalJSON ¶

func (s *CreateJobFromTemplateRequest) MarshalJSON() ([]byte, error)

type CustomSourceLocation ¶

CustomSourceLocation: Identifies the location of a custom souce.

type CustomSourceLocation struct {
    // Stateful: Whether this source is stateful.
    Stateful bool `json:"stateful,omitempty"`
    // ForceSendFields is a list of field names (e.g. "Stateful") to
    // unconditionally include in API requests. By default, fields with empty or
    // default values are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "Stateful") to include in API
    // requests with the JSON null value. By default, fields with empty values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*CustomSourceLocation) MarshalJSON ¶

func (s *CustomSourceLocation) MarshalJSON() ([]byte, error)

type DataDiskAssignment ¶

DataDiskAssignment: Data disk assignment for a given VM instance.

type DataDiskAssignment struct {
    // DataDisks: 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 `json:"dataDisks,omitempty"`
    // VmInstance: VM instance name the data disks mounted to, for example
    // "myproject-1014-104817-4c2-harness-0".
    VmInstance string `json:"vmInstance,omitempty"`
    // ForceSendFields is a list of field names (e.g. "DataDisks") to
    // unconditionally include in API requests. By default, fields with empty or
    // default values are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "DataDisks") to include in API
    // requests with the JSON null value. By default, fields with empty values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*DataDiskAssignment) MarshalJSON ¶

func (s *DataDiskAssignment) MarshalJSON() ([]byte, error)

type DataSamplingConfig ¶

DataSamplingConfig: Configuration options for sampling elements.

type DataSamplingConfig struct {
    // Behaviors: List of given sampling behaviors to enable. For example,
    // specifying behaviors = [ALWAYS_ON] samples in-flight elements but does not
    // sample exceptions. Can be used to specify multiple behaviors like, behaviors
    // = [ALWAYS_ON, EXCEPTIONS] for specifying periodic sampling and exception
    // sampling. If DISABLED is in the list, then sampling will be disabled and
    // ignore the other given behaviors. Ordering does not matter.
    //
    // Possible values:
    //   "DATA_SAMPLING_BEHAVIOR_UNSPECIFIED" - If given, has no effect on sampling
    // behavior. Used as an unknown or unset sentinel value.
    //   "DISABLED" - When given, disables element sampling. Has same behavior as
    // not setting the behavior.
    //   "ALWAYS_ON" - When given, enables sampling in-flight from all
    // PCollections.
    //   "EXCEPTIONS" - When given, enables sampling input elements when a
    // user-defined DoFn causes an exception.
    Behaviors []string `json:"behaviors,omitempty"`
    // ForceSendFields is a list of field names (e.g. "Behaviors") to
    // unconditionally include in API requests. By default, fields with empty or
    // default values are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "Behaviors") to include in API
    // requests with the JSON null value. By default, fields with empty values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*DataSamplingConfig) MarshalJSON ¶

func (s *DataSamplingConfig) MarshalJSON() ([]byte, error)

type DataSamplingReport ¶

DataSamplingReport: Contains per-worker telemetry about the data sampling feature.

type DataSamplingReport struct {
    // BytesWrittenDelta: Optional. Delta of bytes written to file from previous
    // report.
    BytesWrittenDelta int64 `json:"bytesWrittenDelta,omitempty,string"`
    // ElementsSampledBytes: Optional. Delta of bytes sampled from previous report.
    ElementsSampledBytes int64 `json:"elementsSampledBytes,omitempty,string"`
    // ElementsSampledCount: Optional. Delta of number of elements sampled from
    // previous report.
    ElementsSampledCount int64 `json:"elementsSampledCount,omitempty,string"`
    // ExceptionsSampledCount: Optional. Delta of number of samples taken from user
    // code exceptions from previous report.
    ExceptionsSampledCount int64 `json:"exceptionsSampledCount,omitempty,string"`
    // PcollectionsSampledCount: Optional. Delta of number of PCollections sampled
    // from previous report.
    PcollectionsSampledCount int64 `json:"pcollectionsSampledCount,omitempty,string"`
    // PersistenceErrorsCount: Optional. Delta of errors counts from persisting the
    // samples from previous report.
    PersistenceErrorsCount int64 `json:"persistenceErrorsCount,omitempty,string"`
    // TranslationErrorsCount: Optional. Delta of errors counts from retrieving, or
    // translating the samples from previous report.
    TranslationErrorsCount int64 `json:"translationErrorsCount,omitempty,string"`
    // ForceSendFields is a list of field names (e.g. "BytesWrittenDelta") to
    // unconditionally include in API requests. By default, fields with empty or
    // default values are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "BytesWrittenDelta") to include in
    // API requests with the JSON null value. By default, fields with empty values
    // are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*DataSamplingReport) MarshalJSON ¶

func (s *DataSamplingReport) MarshalJSON() ([]byte, error)

type DataflowHistogramValue ¶

DataflowHistogramValue: Summary statistics for a population of values. HistogramValue contains a sequence of buckets and gives a count of values that fall into each bucket. Bucket boundares are defined by a formula and bucket widths are either fixed or exponentially increasing.

type DataflowHistogramValue struct {
    // BucketCounts: Optional. The number of values in each bucket of the
    // histogram, as described in `bucket_options`. `bucket_counts` should contain
    // N values, where N is the number of buckets specified in `bucket_options`. If
    // `bucket_counts` has fewer than N values, the remaining values are assumed to
    // be 0.
    BucketCounts googleapi.Int64s `json:"bucketCounts,omitempty"`
    // BucketOptions: Describes the bucket boundaries used in the histogram.
    BucketOptions *BucketOptions `json:"bucketOptions,omitempty"`
    // Count: Number of values recorded in this histogram.
    Count int64 `json:"count,omitempty,string"`
    // OutlierStats: Statistics on the values recorded in the histogram that fall
    // out of the bucket boundaries.
    OutlierStats *OutlierStats `json:"outlierStats,omitempty"`
    // ForceSendFields is a list of field names (e.g. "BucketCounts") to
    // unconditionally include in API requests. By default, fields with empty or
    // default values are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "BucketCounts") to include in API
    // requests with the JSON null value. By default, fields with empty values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*DataflowHistogramValue) MarshalJSON ¶

func (s *DataflowHistogramValue) MarshalJSON() ([]byte, error)

type DatastoreIODetails ¶

DatastoreIODetails: Metadata for a Datastore connector used by the job.

type DatastoreIODetails struct {
    // Namespace: Namespace used in the connection.
    Namespace string `json:"namespace,omitempty"`
    // ProjectId: ProjectId accessed in the connection.
    ProjectId string `json:"projectId,omitempty"`
    // ForceSendFields is a list of field names (e.g. "Namespace") to
    // unconditionally include in API requests. By default, fields with empty or
    // default values are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "Namespace") to include in API
    // requests with the JSON null value. By default, fields with empty values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*DatastoreIODetails) MarshalJSON ¶

func (s *DatastoreIODetails) MarshalJSON() ([]byte, error)

type DebugOptions ¶

DebugOptions: Describes any options that have an effect on the debugging of pipelines.

type DebugOptions struct {
    // DataSampling: Configuration options for sampling elements from a running
    // pipeline.
    DataSampling *DataSamplingConfig `json:"dataSampling,omitempty"`
    // EnableHotKeyLogging: When true, enables the logging of the literal hot key
    // to the user's Cloud Logging.
    EnableHotKeyLogging bool `json:"enableHotKeyLogging,omitempty"`
    // ForceSendFields is a list of field names (e.g. "DataSampling") to
    // unconditionally include in API requests. By default, fields with empty or
    // default values are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "DataSampling") to include in API
    // requests with the JSON null value. By default, fields with empty values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*DebugOptions) MarshalJSON ¶

func (s *DebugOptions) MarshalJSON() ([]byte, error)

type DeleteSnapshotResponse ¶

DeleteSnapshotResponse: Response from deleting a snapshot.

type DeleteSnapshotResponse struct {
    // ServerResponse contains the HTTP response code and headers from the server.
    googleapi.ServerResponse `json:"-"`
}

type DerivedSource ¶

DerivedSource: Specification of one of the bundles produced as a result of splitting a Source (e.g. when executing a SourceSplitRequest, or when splitting an active task using WorkItemStatus.dynamic_source_split), relative to the source being split.

type DerivedSource struct {
    // DerivationMode: What source to base the produced source on (if any).
    //
    // Possible values:
    //   "SOURCE_DERIVATION_MODE_UNKNOWN" - The source derivation is unknown, or
    // unspecified.
    //   "SOURCE_DERIVATION_MODE_INDEPENDENT" - Produce a completely independent
    // Source with no base.
    //   "SOURCE_DERIVATION_MODE_CHILD_OF_CURRENT" - Produce a Source based on the
    // Source being split.
    //   "SOURCE_DERIVATION_MODE_SIBLING_OF_CURRENT" - Produce a Source based on
    // the base of the Source being split.
    DerivationMode string `json:"derivationMode,omitempty"`
    // Source: Specification of the source.
    Source *Source `json:"source,omitempty"`
    // ForceSendFields is a list of field names (e.g. "DerivationMode") to
    // unconditionally include in API requests. By default, fields with empty or
    // default values are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "DerivationMode") to include in
    // API requests with the JSON null value. By default, fields with empty values
    // are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*DerivedSource) MarshalJSON ¶

func (s *DerivedSource) MarshalJSON() ([]byte, error)

type Disk ¶

Disk: Describes the data disk used by a workflow job.

type Disk struct {
    // DiskType: 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 `json:"diskType,omitempty"`
    // MountPoint: Directory in a VM where disk is mounted.
    MountPoint string `json:"mountPoint,omitempty"`
    // SizeGb: Size of disk in GB. If zero or unspecified, the service will attempt
    // to choose a reasonable default.
    SizeGb int64 `json:"sizeGb,omitempty"`
    // ForceSendFields is a list of field names (e.g. "DiskType") to
    // unconditionally include in API requests. By default, fields with empty or
    // default values are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "DiskType") to include in API
    // requests with the JSON null value. By default, fields with empty values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*Disk) MarshalJSON ¶

func (s *Disk) MarshalJSON() ([]byte, error)

type DisplayData ¶

DisplayData: Data provided with a pipeline or transform to provide descriptive info.

type DisplayData struct {
    // BoolValue: Contains value if the data is of a boolean type.
    BoolValue bool `json:"boolValue,omitempty"`
    // DurationValue: Contains value if the data is of duration type.
    DurationValue string `json:"durationValue,omitempty"`
    // FloatValue: Contains value if the data is of float type.
    FloatValue float64 `json:"floatValue,omitempty"`
    // Int64Value: Contains value if the data is of int64 type.
    Int64Value int64 `json:"int64Value,omitempty,string"`
    // JavaClassValue: Contains value if the data is of java class type.
    JavaClassValue string `json:"javaClassValue,omitempty"`
    // Key: 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 `json:"key,omitempty"`
    // Label: An optional label to display in a dax UI for the element.
    Label string `json:"label,omitempty"`
    // Namespace: 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 `json:"namespace,omitempty"`
    // ShortStrValue: 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 `json:"shortStrValue,omitempty"`
    // StrValue: Contains value if the data is of string type.
    StrValue string `json:"strValue,omitempty"`
    // TimestampValue: Contains value if the data is of timestamp type.
    TimestampValue string `json:"timestampValue,omitempty"`
    // Url: An optional full URL.
    Url string `json:"url,omitempty"`
    // ForceSendFields is a list of field names (e.g. "BoolValue") to
    // unconditionally include in API requests. By default, fields with empty or
    // default values are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "BoolValue") to include in API
    // requests with the JSON null value. By default, fields with empty values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*DisplayData) MarshalJSON ¶

func (s *DisplayData) MarshalJSON() ([]byte, error)

func (*DisplayData) UnmarshalJSON ¶

func (s *DisplayData) UnmarshalJSON(data []byte) error

type DistributionUpdate ¶

DistributionUpdate: A metric value representing a distribution.

type DistributionUpdate struct {
    // Count: The count of the number of elements present in the distribution.
    Count *SplitInt64 `json:"count,omitempty"`
    // Histogram: (Optional) Histogram of value counts for the distribution.
    Histogram *Histogram `json:"histogram,omitempty"`
    // Max: The maximum value present in the distribution.
    Max *SplitInt64 `json:"max,omitempty"`
    // Min: The minimum value present in the distribution.
    Min *SplitInt64 `json:"min,omitempty"`
    // Sum: 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 `json:"sum,omitempty"`
    // SumOfSquares: Use a double since the sum of squares is likely to overflow
    // int64.
    SumOfSquares float64 `json:"sumOfSquares,omitempty"`
    // ForceSendFields is a list of field names (e.g. "Count") to unconditionally
    // include in API requests. By default, fields with empty or default values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "Count") to include in API
    // requests with the JSON null value. By default, fields with empty values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*DistributionUpdate) MarshalJSON ¶

func (s *DistributionUpdate) MarshalJSON() ([]byte, error)

func (*DistributionUpdate) UnmarshalJSON ¶

func (s *DistributionUpdate) UnmarshalJSON(data []byte) error

type DynamicSourceSplit ¶

DynamicSourceSplit: When a task splits using WorkItemStatus.dynamic_source_split, this message describes the two parts of the split relative to the description of the current task's input.

type DynamicSourceSplit struct {
    // Primary: Primary part (continued to be processed by worker). Specified
    // relative to the previously-current source. Becomes current.
    Primary *DerivedSource `json:"primary,omitempty"`
    // Residual: Residual part (returned to the pool of work). Specified relative
    // to the previously-current source.
    Residual *DerivedSource `json:"residual,omitempty"`
    // ForceSendFields is a list of field names (e.g. "Primary") to unconditionally
    // include in API requests. By default, fields with empty or default values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "Primary") to include in API
    // requests with the JSON null value. By default, fields with empty values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*DynamicSourceSplit) MarshalJSON ¶

func (s *DynamicSourceSplit) MarshalJSON() ([]byte, error)

type Environment ¶

Environment: Describes the environment in which a Dataflow Job runs.

type Environment struct {
    // ClusterManagerApiService: 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 `json:"clusterManagerApiService,omitempty"`
    // Dataset: 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 `json:"dataset,omitempty"`
    // DebugOptions: Any debugging options to be supplied to the job.
    DebugOptions *DebugOptions `json:"debugOptions,omitempty"`
    // Experiments: The list of experiments to enable. This field should be used
    // for SDK related experiments and not for service related experiments. The
    // proper field for service related experiments is service_options.
    Experiments []string `json:"experiments,omitempty"`
    // FlexResourceSchedulingGoal: Which Flexible Resource Scheduling mode to run
    // in.
    //
    // Possible values:
    //   "FLEXRS_UNSPECIFIED" - Run in the default mode.
    //   "FLEXRS_SPEED_OPTIMIZED" - Optimize for lower execution time.
    //   "FLEXRS_COST_OPTIMIZED" - Optimize for lower cost.
    FlexResourceSchedulingGoal string `json:"flexResourceSchedulingGoal,omitempty"`
    // InternalExperiments: Experimental settings.
    InternalExperiments googleapi.RawMessage `json:"internalExperiments,omitempty"`
    // SdkPipelineOptions: 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 googleapi.RawMessage `json:"sdkPipelineOptions,omitempty"`
    // ServiceAccountEmail: Identity to run virtual machines as. Defaults to the
    // default account.
    ServiceAccountEmail string `json:"serviceAccountEmail,omitempty"`
    // ServiceKmsKeyName: If set, contains the Cloud KMS key identifier used to
    // encrypt data at rest, AKA a Customer Managed Encryption Key (CMEK). Format:
    // projects/PROJECT_ID/locations/LOCATION/keyRings/KEY_RING/cryptoKeys/KEY
    ServiceKmsKeyName string `json:"serviceKmsKeyName,omitempty"`
    // ServiceOptions: Optional. The list of service options to enable. This field
    // should be used for service related experiments only. These experiments, when
    // graduating to GA, should be replaced by dedicated fields or become default
    // (i.e. always on).
    ServiceOptions []string `json:"serviceOptions,omitempty"`
    // ShuffleMode: Output only. The shuffle mode used for the job.
    //
    // Possible values:
    //   "SHUFFLE_MODE_UNSPECIFIED" - Shuffle mode information is not available.
    //   "VM_BASED" - Shuffle is done on the worker VMs.
    //   "SERVICE_BASED" - Shuffle is done on the service side.
    ShuffleMode string `json:"shuffleMode,omitempty"`
    // StreamingMode: Optional. Specifies the Streaming Engine message processing
    // guarantees. Reduces cost and latency but might result in duplicate messages
    // committed to storage. Designed to run simple mapping streaming ETL jobs at
    // the lowest cost. For example, Change Data Capture (CDC) to BigQuery is a
    // canonical use case. For more information, see Set the pipeline streaming
    // mode (https://cloud.google.com/dataflow/docs/guides/streaming-modes).
    //
    // Possible values:
    //   "STREAMING_MODE_UNSPECIFIED" - Run in the default mode.
    //   "STREAMING_MODE_EXACTLY_ONCE" - In this mode, message deduplication is
    // performed against persistent state to make sure each message is processed
    // and committed to storage exactly once.
    //   "STREAMING_MODE_AT_LEAST_ONCE" - Message deduplication is not performed.
    // Messages might be processed multiple times, and the results are applied
    // multiple times. Note: Setting this value also enables Streaming Engine and
    // Streaming Engine resource-based billing.
    StreamingMode string `json:"streamingMode,omitempty"`
    // TempStoragePrefix: 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 `json:"tempStoragePrefix,omitempty"`
    // UseStreamingEngineResourceBasedBilling: Output only. Whether the job uses
    // the Streaming Engine resource-based billing model.
    UseStreamingEngineResourceBasedBilling bool `json:"useStreamingEngineResourceBasedBilling,omitempty"`
    // UserAgent: A description of the process that generated the request.
    UserAgent googleapi.RawMessage `json:"userAgent,omitempty"`
    // Version: A structure describing which components and their versions of the
    // service are required in order to run the job.
    Version googleapi.RawMessage `json:"version,omitempty"`
    // WorkerPools: The worker pools. At least one "harness" worker pool must be
    // specified in order for the job to have workers.
    WorkerPools []*WorkerPool `json:"workerPools,omitempty"`
    // WorkerRegion: The Compute Engine region
    // (https://cloud.google.com/compute/docs/regions-zones/regions-zones) in which
    // worker processing should occur, e.g. "us-west1". Mutually exclusive with
    // worker_zone. If neither worker_region nor worker_zone is specified, default
    // to the control plane's region.
    WorkerRegion string `json:"workerRegion,omitempty"`
    // WorkerZone: The Compute Engine zone
    // (https://cloud.google.com/compute/docs/regions-zones/regions-zones) in which
    // worker processing should occur, e.g. "us-west1-a". Mutually exclusive with
    // worker_region. If neither worker_region nor worker_zone is specified, a zone
    // in the control plane's region is chosen based on available capacity.
    WorkerZone string `json:"workerZone,omitempty"`
    // ForceSendFields is a list of field names (e.g. "ClusterManagerApiService")
    // to unconditionally include in API requests. By default, fields with empty or
    // default values are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "ClusterManagerApiService") to
    // include in API requests with the JSON null value. By default, fields with
    // empty values are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*Environment) MarshalJSON ¶

func (s *Environment) MarshalJSON() ([]byte, error)

type ExecutionStageState ¶

ExecutionStageState: A message describing the state of a particular execution stage.

type ExecutionStageState struct {
    // CurrentStateTime: The time at which the stage transitioned to this state.
    CurrentStateTime string `json:"currentStateTime,omitempty"`
    // ExecutionStageName: The name of the execution stage.
    ExecutionStageName string `json:"executionStageName,omitempty"`
    // ExecutionStageState: Executions stage states allow the same set of values as
    // JobState.
    //
    // Possible values:
    //   "JOB_STATE_UNKNOWN" - The job's run state isn't specified.
    //   "JOB_STATE_STOPPED" - `JOB_STATE_STOPPED` indicates that the job has not
    // yet started to run.
    //   "JOB_STATE_RUNNING" - `JOB_STATE_RUNNING` indicates that the job is
    // currently running.
    //   "JOB_STATE_DONE" - `JOB_STATE_DONE` indicates that the job has
    // successfully completed. This is a terminal job state. This state may be set
    // by the Cloud Dataflow service, as a transition from `JOB_STATE_RUNNING`. It
    // may also be set via a Cloud Dataflow `UpdateJob` call, if the job has not
    // yet reached a terminal state.
    //   "JOB_STATE_FAILED" - `JOB_STATE_FAILED` indicates that the job has failed.
    // This is a terminal job state. This state may only be set by the Cloud
    // Dataflow service, and only as a transition from `JOB_STATE_RUNNING`.
    //   "JOB_STATE_CANCELLED" - `JOB_STATE_CANCELLED` indicates that the job has
    // been explicitly cancelled. This is a terminal job state. This state may only
    // be set via a Cloud Dataflow `UpdateJob` call, and only if the job has not
    // yet reached another terminal state.
    //   "JOB_STATE_UPDATED" - `JOB_STATE_UPDATED` indicates that the job was
    // successfully updated, meaning that this job was stopped and another job was
    // started, inheriting state from this one. This is a terminal job state. This
    // state may only be set by the Cloud Dataflow service, and only as a
    // transition from `JOB_STATE_RUNNING`.
    //   "JOB_STATE_DRAINING" - `JOB_STATE_DRAINING` indicates that the job is in
    // the process of draining. A draining job has stopped pulling from its input
    // sources and is processing any data that remains in-flight. This state may be
    // set via a Cloud Dataflow `UpdateJob` call, but only as a transition from
    // `JOB_STATE_RUNNING`. Jobs that are draining may only transition to
    // `JOB_STATE_DRAINED`, `JOB_STATE_CANCELLED`, or `JOB_STATE_FAILED`.
    //   "JOB_STATE_DRAINED" - `JOB_STATE_DRAINED` indicates that the job has been
    // drained. A drained job terminated by stopping pulling from its input sources
    // and processing any data that remained in-flight when draining was requested.
    // This state is a terminal state, may only be set by the Cloud Dataflow
    // service, and only as a transition from `JOB_STATE_DRAINING`.
    //   "JOB_STATE_PENDING" - `JOB_STATE_PENDING` indicates that the job has been
    // created but is not yet running. Jobs that are pending may only transition to
    // `JOB_STATE_RUNNING`, or `JOB_STATE_FAILED`.
    //   "JOB_STATE_CANCELLING" - `JOB_STATE_CANCELLING` indicates that the job has
    // been explicitly cancelled and is in the process of stopping. Jobs that are
    // cancelling may only transition to `JOB_STATE_CANCELLED` or
    // `JOB_STATE_FAILED`.
    //   "JOB_STATE_QUEUED" - `JOB_STATE_QUEUED` indicates that the job has been
    // created but is being delayed until launch. Jobs that are queued may only
    // transition to `JOB_STATE_PENDING` or `JOB_STATE_CANCELLED`.
    //   "JOB_STATE_RESOURCE_CLEANING_UP" - `JOB_STATE_RESOURCE_CLEANING_UP`
    // indicates that the batch job's associated resources are currently being
    // cleaned up after a successful run. Currently, this is an opt-in feature,
    // please reach out to Cloud support team if you are interested.
    ExecutionStageState string `json:"executionStageState,omitempty"`
    // ForceSendFields is a list of field names (e.g. "CurrentStateTime") to
    // unconditionally include in API requests. By default, fields with empty or
    // default values are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "CurrentStateTime") to include in
    // API requests with the JSON null value. By default, fields with empty values
    // are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*ExecutionStageState) MarshalJSON ¶

func (s *ExecutionStageState) MarshalJSON() ([]byte, error)

type ExecutionStageSummary ¶

ExecutionStageSummary: Description of the composing transforms, names/ids, and input/outputs of a stage of execution. Some composing transforms and sources may have been generated by the Dataflow service during execution planning.

type ExecutionStageSummary struct {
    // ComponentSource: Collections produced and consumed by component transforms
    // of this stage.
    ComponentSource []*ComponentSource `json:"componentSource,omitempty"`
    // ComponentTransform: Transforms that comprise this execution stage.
    ComponentTransform []*ComponentTransform `json:"componentTransform,omitempty"`
    // Id: Dataflow service generated id for this stage.
    Id string `json:"id,omitempty"`
    // InputSource: Input sources for this stage.
    InputSource []*StageSource `json:"inputSource,omitempty"`
    // Kind: Type of transform this stage is executing.
    //
    // Possible values:
    //   "UNKNOWN_KIND" - Unrecognized transform type.
    //   "PAR_DO_KIND" - ParDo transform.
    //   "GROUP_BY_KEY_KIND" - Group By Key transform.
    //   "FLATTEN_KIND" - Flatten transform.
    //   "READ_KIND" - Read transform.
    //   "WRITE_KIND" - Write transform.
    //   "CONSTANT_KIND" - Constructs from a constant value, such as with
    // Create.of.
    //   "SINGLETON_KIND" - Creates a Singleton view of a collection.
    //   "SHUFFLE_KIND" - Opening or closing a shuffle session, often as part of a
    // GroupByKey.
    Kind string `json:"kind,omitempty"`
    // Name: Dataflow service generated name for this stage.
    Name string `json:"name,omitempty"`
    // OutputSource: Output sources for this stage.
    OutputSource []*StageSource `json:"outputSource,omitempty"`
    // PrerequisiteStage: Other stages that must complete before this stage can
    // run.
    PrerequisiteStage []string `json:"prerequisiteStage,omitempty"`
    // ForceSendFields is a list of field names (e.g. "ComponentSource") to
    // unconditionally include in API requests. By default, fields with empty or
    // default values are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "ComponentSource") to include in
    // API requests with the JSON null value. By default, fields with empty values
    // are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*ExecutionStageSummary) MarshalJSON ¶

func (s *ExecutionStageSummary) MarshalJSON() ([]byte, error)

type FailedLocation ¶

FailedLocation: Indicates which [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) failed to respond to a request for data.

type FailedLocation struct {
    // Name: The name of the [regional endpoint]
    // (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that
    // failed to respond.
    Name string `json:"name,omitempty"`
    // ForceSendFields is a list of field names (e.g. "Name") to unconditionally
    // include in API requests. By default, fields with empty or default values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "Name") to include in API requests
    // with the JSON null value. By default, fields with empty values are omitted
    // from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*FailedLocation) MarshalJSON ¶

func (s *FailedLocation) MarshalJSON() ([]byte, error)

type FileIODetails ¶

FileIODetails: Metadata for a File connector used by the job.

type FileIODetails struct {
    // FilePattern: File Pattern used to access files by the connector.
    FilePattern string `json:"filePattern,omitempty"`
    // ForceSendFields is a list of field names (e.g. "FilePattern") to
    // unconditionally include in API requests. By default, fields with empty or
    // default values are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "FilePattern") to include in API
    // requests with the JSON null value. By default, fields with empty values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*FileIODetails) MarshalJSON ¶

func (s *FileIODetails) MarshalJSON() ([]byte, error)

type FlattenInstruction ¶

FlattenInstruction: An instruction that copies its inputs (zero or more) to its (single) output.

type FlattenInstruction struct {
    // Inputs: Describes the inputs to the flatten instruction.
    Inputs []*InstructionInput `json:"inputs,omitempty"`
    // ForceSendFields is a list of field names (e.g. "Inputs") to unconditionally
    // include in API requests. By default, fields with empty or default values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "Inputs") to include in API
    // requests with the JSON null value. By default, fields with empty values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*FlattenInstruction) MarshalJSON ¶

func (s *FlattenInstruction) MarshalJSON() ([]byte, error)

type FlexTemplateRuntimeEnvironment ¶

FlexTemplateRuntimeEnvironment: The environment values to be set at runtime for flex template. LINT.IfChange

type FlexTemplateRuntimeEnvironment struct {
    // AdditionalExperiments: Additional experiment flags for the job.
    AdditionalExperiments []string `json:"additionalExperiments,omitempty"`
    // AdditionalUserLabels: Additional user labels to be specified for the job.
    // Keys and values must follow the restrictions specified in the labeling
    // restrictions
    // (https://cloud.google.com/compute/docs/labeling-resources#restrictions)
    // page. An object containing a list of "key": value pairs. Example: { "name":
    // "wrench", "mass": "1kg", "count": "3" }.
    AdditionalUserLabels map[string]string `json:"additionalUserLabels,omitempty"`
    // AutoscalingAlgorithm: The algorithm to use for autoscaling
    //
    // Possible values:
    //   "AUTOSCALING_ALGORITHM_UNKNOWN" - The algorithm is unknown, or
    // unspecified.
    //   "AUTOSCALING_ALGORITHM_NONE" - Disable autoscaling.
    //   "AUTOSCALING_ALGORITHM_BASIC" - Increase worker count over time to reduce
    // job execution time.
    AutoscalingAlgorithm string `json:"autoscalingAlgorithm,omitempty"`
    // DiskSizeGb: Worker disk size, in gigabytes.
    DiskSizeGb int64 `json:"diskSizeGb,omitempty"`
    // DumpHeapOnOom: If true, when processing time is spent almost entirely on
    // garbage collection (GC), saves a heap dump before ending the thread or
    // process. If false, ends the thread or process without saving a heap dump.
    // Does not save a heap dump when the Java Virtual Machine (JVM) has an out of
    // memory error during processing. The location of the heap file is either
    // echoed back to the user, or the user is given the opportunity to download
    // the heap file.
    DumpHeapOnOom bool `json:"dumpHeapOnOom,omitempty"`
    // EnableLauncherVmSerialPortLogging: If true serial port logging will be
    // enabled for the launcher VM.
    EnableLauncherVmSerialPortLogging bool `json:"enableLauncherVmSerialPortLogging,omitempty"`
    // EnableStreamingEngine: Whether to enable Streaming Engine for the job.
    EnableStreamingEngine bool `json:"enableStreamingEngine,omitempty"`
    // FlexrsGoal: Set FlexRS goal for the job.
    // https://cloud.google.com/dataflow/docs/guides/flexrs
    //
    // Possible values:
    //   "FLEXRS_UNSPECIFIED" - Run in the default mode.
    //   "FLEXRS_SPEED_OPTIMIZED" - Optimize for lower execution time.
    //   "FLEXRS_COST_OPTIMIZED" - Optimize for lower cost.
    FlexrsGoal string `json:"flexrsGoal,omitempty"`
    // IpConfiguration: Configuration for VM IPs.
    //
    // Possible values:
    //   "WORKER_IP_UNSPECIFIED" - The configuration is unknown, or unspecified.
    //   "WORKER_IP_PUBLIC" - Workers should have public IP addresses.
    //   "WORKER_IP_PRIVATE" - Workers should have private IP addresses.
    IpConfiguration string `json:"ipConfiguration,omitempty"`
    // KmsKeyName: Name for the Cloud KMS key for the job. Key format is:
    // projects//locations//keyRings//cryptoKeys/
    KmsKeyName string `json:"kmsKeyName,omitempty"`
    // LauncherMachineType: The machine type to use for launching the job. The
    // default is n1-standard-1.
    LauncherMachineType string `json:"launcherMachineType,omitempty"`
    // MachineType: The machine type to use for the job. Defaults to the value from
    // the template if not specified.
    MachineType string `json:"machineType,omitempty"`
    // MaxWorkers: The maximum number of Google Compute Engine instances to be made
    // available to your pipeline during execution, from 1 to 1000.
    MaxWorkers int64 `json:"maxWorkers,omitempty"`
    // Network: Network to which VMs will be assigned. If empty or unspecified, the
    // service will use the network "default".
    Network string `json:"network,omitempty"`
    // NumWorkers: The initial number of Google Compute Engine instances for the
    // job.
    NumWorkers int64 `json:"numWorkers,omitempty"`
    // SaveHeapDumpsToGcsPath: Cloud Storage bucket (directory) to upload heap
    // dumps to. Enabling this field implies that `dump_heap_on_oom` is set to
    // true.
    SaveHeapDumpsToGcsPath string `json:"saveHeapDumpsToGcsPath,omitempty"`
    // SdkContainerImage: Docker registry location of container image to use for
    // the 'worker harness. Default is the container for the version of the SDK.
    // Note this field is only valid for portable pipelines.
    SdkContainerImage string `json:"sdkContainerImage,omitempty"`
    // ServiceAccountEmail: The email address of the service account to run the job
    // as.
    ServiceAccountEmail string `json:"serviceAccountEmail,omitempty"`
    // StagingLocation: The Cloud Storage path for staging local files. Must be a
    // valid Cloud Storage URL, beginning with `gs://`.
    StagingLocation string `json:"stagingLocation,omitempty"`
    // StreamingMode: Optional. Specifies the Streaming Engine message processing
    // guarantees. Reduces cost and latency but might result in duplicate messages
    // committed to storage. Designed to run simple mapping streaming ETL jobs at
    // the lowest cost. For example, Change Data Capture (CDC) to BigQuery is a
    // canonical use case. For more information, see Set the pipeline streaming
    // mode (https://cloud.google.com/dataflow/docs/guides/streaming-modes).
    //
    // Possible values:
    //   "STREAMING_MODE_UNSPECIFIED" - Run in the default mode.
    //   "STREAMING_MODE_EXACTLY_ONCE" - In this mode, message deduplication is
    // performed against persistent state to make sure each message is processed
    // and committed to storage exactly once.
    //   "STREAMING_MODE_AT_LEAST_ONCE" - Message deduplication is not performed.
    // Messages might be processed multiple times, and the results are applied
    // multiple times. Note: Setting this value also enables Streaming Engine and
    // Streaming Engine resource-based billing.
    StreamingMode string `json:"streamingMode,omitempty"`
    // Subnetwork: Subnetwork to which VMs will be assigned, if desired. You can
    // specify a subnetwork using either a complete URL or an abbreviated path.
    // Expected to be of the form
    // "https://www.googleapis.com/compute/v1/projects/HOST_PROJECT_ID/regions/REGIO
    // N/subnetworks/SUBNETWORK" or "regions/REGION/subnetworks/SUBNETWORK". If the
    // subnetwork is located in a Shared VPC network, you must use the complete
    // URL.
    Subnetwork string `json:"subnetwork,omitempty"`
    // TempLocation: The Cloud Storage path to use for temporary files. Must be a
    // valid Cloud Storage URL, beginning with `gs://`.
    TempLocation string `json:"tempLocation,omitempty"`
    // WorkerRegion: The Compute Engine region
    // (https://cloud.google.com/compute/docs/regions-zones/regions-zones) in which
    // worker processing should occur, e.g. "us-west1". Mutually exclusive with
    // worker_zone. If neither worker_region nor worker_zone is specified, default
    // to the control plane's region.
    WorkerRegion string `json:"workerRegion,omitempty"`
    // WorkerZone: The Compute Engine zone
    // (https://cloud.google.com/compute/docs/regions-zones/regions-zones) in which
    // worker processing should occur, e.g. "us-west1-a". Mutually exclusive with
    // worker_region. If neither worker_region nor worker_zone is specified, a zone
    // in the control plane's region is chosen based on available capacity. If both
    // `worker_zone` and `zone` are set, `worker_zone` takes precedence.
    WorkerZone string `json:"workerZone,omitempty"`
    // Zone: The Compute Engine availability zone
    // (https://cloud.google.com/compute/docs/regions-zones/regions-zones) for
    // launching worker instances to run your pipeline. In the future, worker_zone
    // will take precedence.
    Zone string `json:"zone,omitempty"`
    // ForceSendFields is a list of field names (e.g. "AdditionalExperiments") to
    // unconditionally include in API requests. By default, fields with empty or
    // default values are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "AdditionalExperiments") to
    // include in API requests with the JSON null value. By default, fields with
    // empty values are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*FlexTemplateRuntimeEnvironment) MarshalJSON ¶

func (s *FlexTemplateRuntimeEnvironment) MarshalJSON() ([]byte, error)

type FloatingPointList ¶

FloatingPointList: A metric value representing a list of floating point numbers.

type FloatingPointList struct {
    // Elements: Elements of the list.
    Elements []float64 `json:"elements,omitempty"`
    // ForceSendFields is a list of field names (e.g. "Elements") to
    // unconditionally include in API requests. By default, fields with empty or
    // default values are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "Elements") to include in API
    // requests with the JSON null value. By default, fields with empty values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*FloatingPointList) MarshalJSON ¶

func (s *FloatingPointList) MarshalJSON() ([]byte, error)

func (*FloatingPointList) UnmarshalJSON ¶

func (s *FloatingPointList) UnmarshalJSON(data []byte) error

type FloatingPointMean ¶

FloatingPointMean: A representation of a floating point mean metric contribution.

type FloatingPointMean struct {
    // Count: The number of values being aggregated.
    Count *SplitInt64 `json:"count,omitempty"`
    // Sum: The sum of all values being aggregated.
    Sum float64 `json:"sum,omitempty"`
    // ForceSendFields is a list of field names (e.g. "Count") to unconditionally
    // include in API requests. By default, fields with empty or default values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "Count") to include in API
    // requests with the JSON null value. By default, fields with empty values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*FloatingPointMean) MarshalJSON ¶

func (s *FloatingPointMean) MarshalJSON() ([]byte, error)

func (*FloatingPointMean) UnmarshalJSON ¶

func (s *FloatingPointMean) UnmarshalJSON(data []byte) error

type GetDebugConfigRequest ¶

GetDebugConfigRequest: Request to get updated debug configuration for component.

type GetDebugConfigRequest struct {
    // ComponentId: The internal component id for which debug configuration is
    // requested.
    ComponentId string `json:"componentId,omitempty"`
    // Location: The [regional endpoint]
    // (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that
    // contains the job specified by job_id.
    Location string `json:"location,omitempty"`
    // WorkerId: The worker id, i.e., VM hostname.
    WorkerId string `json:"workerId,omitempty"`
    // ForceSendFields is a list of field names (e.g. "ComponentId") to
    // unconditionally include in API requests. By default, fields with empty or
    // default values are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "ComponentId") to include in API
    // requests with the JSON null value. By default, fields with empty values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*GetDebugConfigRequest) MarshalJSON ¶

func (s *GetDebugConfigRequest) MarshalJSON() ([]byte, error)

type GetDebugConfigResponse ¶

GetDebugConfigResponse: Response to a get debug configuration request.

type GetDebugConfigResponse struct {
    // Config: The encoded debug configuration for the requested component.
    Config string `json:"config,omitempty"`

    // ServerResponse contains the HTTP response code and headers from the server.
    googleapi.ServerResponse `json:"-"`
    // ForceSendFields is a list of field names (e.g. "Config") to unconditionally
    // include in API requests. By default, fields with empty or default values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "Config") to include in API
    // requests with the JSON null value. By default, fields with empty values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*GetDebugConfigResponse) MarshalJSON ¶

func (s *GetDebugConfigResponse) MarshalJSON() ([]byte, error)

type GetTemplateResponse ¶

GetTemplateResponse: The response to a GetTemplate request.

type GetTemplateResponse struct {
    // Metadata: The template metadata describing the template name, available
    // parameters, etc.
    Metadata *TemplateMetadata `json:"metadata,omitempty"`
    // RuntimeMetadata: Describes the runtime metadata with SDKInfo and available
    // parameters.
    RuntimeMetadata *RuntimeMetadata `json:"runtimeMetadata,omitempty"`
    // Status: The status of the get template request. Any problems with the
    // request will be indicated in the error_details.
    Status *Status `json:"status,omitempty"`
    // TemplateType: Template Type.
    //
    // Possible values:
    //   "UNKNOWN" - Unknown Template Type.
    //   "LEGACY" - Legacy Template.
    //   "FLEX" - Flex Template.
    TemplateType string `json:"templateType,omitempty"`

    // ServerResponse contains the HTTP response code and headers from the server.
    googleapi.ServerResponse `json:"-"`
    // ForceSendFields is a list of field names (e.g. "Metadata") to
    // unconditionally include in API requests. By default, fields with empty or
    // default values are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "Metadata") to include in API
    // requests with the JSON null value. By default, fields with empty values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*GetTemplateResponse) MarshalJSON ¶

func (s *GetTemplateResponse) MarshalJSON() ([]byte, error)

type Histogram ¶

Histogram: Histogram of value counts for a distribution. Buckets have an inclusive lower bound and exclusive upper bound and use "1,2,5 bucketing": The first bucket range is from [0,1) and all subsequent bucket boundaries are powers of ten multiplied by 1, 2, or 5. Thus, bucket boundaries are 0, 1, 2, 5, 10, 20, 50, 100, 200, 500, 1000, ... Negative values are not supported.

type Histogram struct {
    // BucketCounts: 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 googleapi.Int64s `json:"bucketCounts,omitempty"`
    // FirstBucketOffset: 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)
    // * (1,2,5)[(i-first_bucket_offset)%3]
    FirstBucketOffset int64 `json:"firstBucketOffset,omitempty"`
    // ForceSendFields is a list of field names (e.g. "BucketCounts") to
    // unconditionally include in API requests. By default, fields with empty or
    // default values are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "BucketCounts") to include in API
    // requests with the JSON null value. By default, fields with empty values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*Histogram) MarshalJSON ¶

func (s *Histogram) MarshalJSON() ([]byte, error)

type HotKeyDebuggingInfo ¶

HotKeyDebuggingInfo: Information useful for debugging a hot key detection.

type HotKeyDebuggingInfo struct {
    // DetectedHotKeys: Debugging information for each detected hot key. Keyed by a
    // hash of the key.
    DetectedHotKeys map[string]HotKeyInfo `json:"detectedHotKeys,omitempty"`
    // ForceSendFields is a list of field names (e.g. "DetectedHotKeys") to
    // unconditionally include in API requests. By default, fields with empty or
    // default values are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "DetectedHotKeys") to include in
    // API requests with the JSON null value. By default, fields with empty values
    // are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*HotKeyDebuggingInfo) MarshalJSON ¶

func (s *HotKeyDebuggingInfo) MarshalJSON() ([]byte, error)

type HotKeyDetection ¶

HotKeyDetection: Proto describing a hot key detected on a given WorkItem.

type HotKeyDetection struct {
    // HotKeyAge: The age of the hot key measured from when it was first detected.
    HotKeyAge string `json:"hotKeyAge,omitempty"`
    // SystemName: System-defined name of the step containing this hot key. Unique
    // across the workflow.
    SystemName string `json:"systemName,omitempty"`
    // UserStepName: User-provided name of the step that contains this hot key.
    UserStepName string `json:"userStepName,omitempty"`
    // ForceSendFields is a list of field names (e.g. "HotKeyAge") to
    // unconditionally include in API requests. By default, fields with empty or
    // default values are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "HotKeyAge") to include in API
    // requests with the JSON null value. By default, fields with empty values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*HotKeyDetection) MarshalJSON ¶

func (s *HotKeyDetection) MarshalJSON() ([]byte, error)

type HotKeyInfo ¶

HotKeyInfo: Information about a hot key.

type HotKeyInfo struct {
    // HotKeyAge: The age of the hot key measured from when it was first detected.
    HotKeyAge string `json:"hotKeyAge,omitempty"`
    // Key: A detected hot key that is causing limited parallelism. This field will
    // be populated only if the following flag is set to true:
    // "--enable_hot_key_logging".
    Key string `json:"key,omitempty"`
    // KeyTruncated: If true, then the above key is truncated and cannot be
    // deserialized. This occurs if the key above is populated and the key size is
    // >5MB.
    KeyTruncated bool `json:"keyTruncated,omitempty"`
    // ForceSendFields is a list of field names (e.g. "HotKeyAge") to
    // unconditionally include in API requests. By default, fields with empty or
    // default values are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "HotKeyAge") to include in API
    // requests with the JSON null value. By default, fields with empty values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*HotKeyInfo) MarshalJSON ¶

func (s *HotKeyInfo) MarshalJSON() ([]byte, error)

type InstructionInput ¶

InstructionInput: An input of an instruction, as a reference to an output of a producer instruction.

type InstructionInput struct {
    // OutputNum: The output index (origin zero) within the producer.
    OutputNum int64 `json:"outputNum,omitempty"`
    // ProducerInstructionIndex: 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 int64 `json:"producerInstructionIndex,omitempty"`
    // ForceSendFields is a list of field names (e.g. "OutputNum") to
    // unconditionally include in API requests. By default, fields with empty or
    // default values are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "OutputNum") to include in API
    // requests with the JSON null value. By default, fields with empty values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*InstructionInput) MarshalJSON ¶

func (s *InstructionInput) MarshalJSON() ([]byte, error)

type InstructionOutput ¶

InstructionOutput: An output of an instruction.

type InstructionOutput struct {
    // Codec: The codec to use to encode data being written via this output.
    Codec googleapi.RawMessage `json:"codec,omitempty"`
    // Name: The user-provided name of this output.
    Name string `json:"name,omitempty"`
    // OnlyCountKeyBytes: For system-generated byte and mean byte metrics, certain
    // instructions should only report the key size.
    OnlyCountKeyBytes bool `json:"onlyCountKeyBytes,omitempty"`
    // OnlyCountValueBytes: For system-generated byte and mean byte metrics,
    // certain instructions should only report the value size.
    OnlyCountValueBytes bool `json:"onlyCountValueBytes,omitempty"`
    // OriginalName: 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 `json:"originalName,omitempty"`
    // SystemName: System-defined name of this output. Unique across the workflow.
    SystemName string `json:"systemName,omitempty"`
    // ForceSendFields is a list of field names (e.g. "Codec") to unconditionally
    // include in API requests. By default, fields with empty or default values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "Codec") to include in API
    // requests with the JSON null value. By default, fields with empty values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*InstructionOutput) MarshalJSON ¶

func (s *InstructionOutput) MarshalJSON() ([]byte, error)

type IntegerGauge ¶

IntegerGauge: A metric value representing temporal values of a variable.

type IntegerGauge struct {
    // Timestamp: The time at which this value was measured. Measured as msecs from
    // epoch.
    Timestamp string `json:"timestamp,omitempty"`
    // Value: The value of the variable represented by this gauge.
    Value *SplitInt64 `json:"value,omitempty"`
    // ForceSendFields is a list of field names (e.g. "Timestamp") to
    // unconditionally include in API requests. By default, fields with empty or
    // default values are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "Timestamp") to include in API
    // requests with the JSON null value. By default, fields with empty values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*IntegerGauge) MarshalJSON ¶

func (s *IntegerGauge) MarshalJSON() ([]byte, error)

type IntegerList ¶

IntegerList: A metric value representing a list of integers.

type IntegerList struct {
    // Elements: Elements of the list.
    Elements []*SplitInt64 `json:"elements,omitempty"`
    // ForceSendFields is a list of field names (e.g. "Elements") to
    // unconditionally include in API requests. By default, fields with empty or
    // default values are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "Elements") to include in API
    // requests with the JSON null value. By default, fields with empty values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*IntegerList) MarshalJSON ¶

func (s *IntegerList) MarshalJSON() ([]byte, error)

type IntegerMean ¶

IntegerMean: A representation of an integer mean metric contribution.

type IntegerMean struct {
    // Count: The number of values being aggregated.
    Count *SplitInt64 `json:"count,omitempty"`
    // Sum: The sum of all values being aggregated.
    Sum *SplitInt64 `json:"sum,omitempty"`
    // ForceSendFields is a list of field names (e.g. "Count") to unconditionally
    // include in API requests. By default, fields with empty or default values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "Count") to include in API
    // requests with the JSON null value. By default, fields with empty values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*IntegerMean) MarshalJSON ¶

func (s *IntegerMean) MarshalJSON() ([]byte, error)

type Job ¶

Job: Defines a job to be run by the Cloud Dataflow service. Do not enter confidential information when you supply string values using the API.

type Job struct {
    // ClientRequestId: 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 `json:"clientRequestId,omitempty"`
    // CreateTime: The timestamp when the job was initially created. Immutable and
    // set by the Cloud Dataflow service.
    CreateTime string `json:"createTime,omitempty"`
    // CreatedFromSnapshotId: If this is specified, the job's initial state is
    // populated from the given snapshot.
    CreatedFromSnapshotId string `json:"createdFromSnapshotId,omitempty"`
    // CurrentState: 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 might be mutated by the Dataflow service; callers cannot mutate it.
    //
    // Possible values:
    //   "JOB_STATE_UNKNOWN" - The job's run state isn't specified.
    //   "JOB_STATE_STOPPED" - `JOB_STATE_STOPPED` indicates that the job has not
    // yet started to run.
    //   "JOB_STATE_RUNNING" - `JOB_STATE_RUNNING` indicates that the job is
    // currently running.
    //   "JOB_STATE_DONE" - `JOB_STATE_DONE` indicates that the job has
    // successfully completed. This is a terminal job state. This state may be set
    // by the Cloud Dataflow service, as a transition from `JOB_STATE_RUNNING`. It
    // may also be set via a Cloud Dataflow `UpdateJob` call, if the job has not
    // yet reached a terminal state.
    //   "JOB_STATE_FAILED" - `JOB_STATE_FAILED` indicates that the job has failed.
    // This is a terminal job state. This state may only be set by the Cloud
    // Dataflow service, and only as a transition from `JOB_STATE_RUNNING`.
    //   "JOB_STATE_CANCELLED" - `JOB_STATE_CANCELLED` indicates that the job has
    // been explicitly cancelled. This is a terminal job state. This state may only
    // be set via a Cloud Dataflow `UpdateJob` call, and only if the job has not
    // yet reached another terminal state.
    //   "JOB_STATE_UPDATED" - `JOB_STATE_UPDATED` indicates that the job was
    // successfully updated, meaning that this job was stopped and another job was
    // started, inheriting state from this one. This is a terminal job state. This
    // state may only be set by the Cloud Dataflow service, and only as a
    // transition from `JOB_STATE_RUNNING`.
    //   "JOB_STATE_DRAINING" - `JOB_STATE_DRAINING` indicates that the job is in
    // the process of draining. A draining job has stopped pulling from its input
    // sources and is processing any data that remains in-flight. This state may be
    // set via a Cloud Dataflow `UpdateJob` call, but only as a transition from
    // `JOB_STATE_RUNNING`. Jobs that are draining may only transition to
    // `JOB_STATE_DRAINED`, `JOB_STATE_CANCELLED`, or `JOB_STATE_FAILED`.
    //   "JOB_STATE_DRAINED" - `JOB_STATE_DRAINED` indicates that the job has been
    // drained. A drained job terminated by stopping pulling from its input sources
    // and processing any data that remained in-flight when draining was requested.
    // This state is a terminal state, may only be set by the Cloud Dataflow
    // service, and only as a transition from `JOB_STATE_DRAINING`.
    //   "JOB_STATE_PENDING" - `JOB_STATE_PENDING` indicates that the job has been
    // created but is not yet running. Jobs that are pending may only transition to
    // `JOB_STATE_RUNNING`, or `JOB_STATE_FAILED`.
    //   "JOB_STATE_CANCELLING" - `JOB_STATE_CANCELLING` indicates that the job has
    // been explicitly cancelled and is in the process of stopping. Jobs that are
    // cancelling may only transition to `JOB_STATE_CANCELLED` or
    // `JOB_STATE_FAILED`.
    //   "JOB_STATE_QUEUED" - `JOB_STATE_QUEUED` indicates that the job has been
    // created but is being delayed until launch. Jobs that are queued may only
    // transition to `JOB_STATE_PENDING` or `JOB_STATE_CANCELLED`.
    //   "JOB_STATE_RESOURCE_CLEANING_UP" - `JOB_STATE_RESOURCE_CLEANING_UP`
    // indicates that the batch job's associated resources are currently being
    // cleaned up after a successful run. Currently, this is an opt-in feature,
    // please reach out to Cloud support team if you are interested.
    CurrentState string `json:"currentState,omitempty"`
    // CurrentStateTime: The timestamp associated with the current state.
    CurrentStateTime string `json:"currentStateTime,omitempty"`
    // Environment: Optional. The environment for the job.
    Environment *Environment `json:"environment,omitempty"`
    // ExecutionInfo: Deprecated.
    ExecutionInfo *JobExecutionInfo `json:"executionInfo,omitempty"`
    // Id: The unique ID of this job. This field is set by the Dataflow service
    // when the job is created, and is immutable for the life of the job.
    Id string `json:"id,omitempty"`
    // JobMetadata: This field is populated by the Dataflow service to support
    // filtering jobs by the metadata values provided here. Populated for ListJobs
    // and all GetJob views SUMMARY and higher.
    JobMetadata *JobMetadata `json:"jobMetadata,omitempty"`
    // Labels: 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: * Keys must conform to regexp:
    // \p{Ll}\p{Lo}{0,62} * Values must conform to regexp:
    // [\p{Ll}\p{Lo}\p{N}_-]{0,63} * Both keys and values are additionally
    // constrained to be <= 128 bytes in size.
    Labels map[string]string `json:"labels,omitempty"`
    // Location: The [regional endpoint]
    // (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that
    // contains this job.
    Location string `json:"location,omitempty"`
    // Name: Optional. The user-specified Dataflow job name. Only one active job
    // with a given name can exist in a project within one region at any given
    // time. Jobs in different regions can have the same name. If a caller attempts
    // to create a job with the same name as an active job that already exists, the
    // attempt returns the existing job. The name must match the regular expression
    // `[a-z]([-a-z0-9]{0,1022}[a-z0-9])?`
    Name string `json:"name,omitempty"`
    // PipelineDescription: 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 `json:"pipelineDescription,omitempty"`
    // ProjectId: The ID of the Google Cloud project that the job belongs to.
    ProjectId string `json:"projectId,omitempty"`
    // ReplaceJobId: 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 `json:"replaceJobId,omitempty"`
    // ReplacedByJobId: 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 `json:"replacedByJobId,omitempty"`
    // RequestedState: The job's requested state. Applies to `UpdateJob` requests.
    // Set `requested_state` with `UpdateJob` requests to switch between the states
    // `JOB_STATE_STOPPED` and `JOB_STATE_RUNNING`. You can also use `UpdateJob`
    // requests to change a job's state from `JOB_STATE_RUNNING` to
    // `JOB_STATE_CANCELLED`, `JOB_STATE_DONE`, or `JOB_STATE_DRAINED`. These
    // states irrevocably terminate the job if it hasn't already reached a terminal
    // state. This field has no effect on `CreateJob` requests.
    //
    // Possible values:
    //   "JOB_STATE_UNKNOWN" - The job's run state isn't specified.
    //   "JOB_STATE_STOPPED" - `JOB_STATE_STOPPED` indicates that the job has not
    // yet started to run.
    //   "JOB_STATE_RUNNING" - `JOB_STATE_RUNNING` indicates that the job is
    // currently running.
    //   "JOB_STATE_DONE" - `JOB_STATE_DONE` indicates that the job has
    // successfully completed. This is a terminal job state. This state may be set
    // by the Cloud Dataflow service, as a transition from `JOB_STATE_RUNNING`. It
    // may also be set via a Cloud Dataflow `UpdateJob` call, if the job has not
    // yet reached a terminal state.
    //   "JOB_STATE_FAILED" - `JOB_STATE_FAILED` indicates that the job has failed.
    // This is a terminal job state. This state may only be set by the Cloud
    // Dataflow service, and only as a transition from `JOB_STATE_RUNNING`.
    //   "JOB_STATE_CANCELLED" - `JOB_STATE_CANCELLED` indicates that the job has
    // been explicitly cancelled. This is a terminal job state. This state may only
    // be set via a Cloud Dataflow `UpdateJob` call, and only if the job has not
    // yet reached another terminal state.
    //   "JOB_STATE_UPDATED" - `JOB_STATE_UPDATED` indicates that the job was
    // successfully updated, meaning that this job was stopped and another job was
    // started, inheriting state from this one. This is a terminal job state. This
    // state may only be set by the Cloud Dataflow service, and only as a
    // transition from `JOB_STATE_RUNNING`.
    //   "JOB_STATE_DRAINING" - `JOB_STATE_DRAINING` indicates that the job is in
    // the process of draining. A draining job has stopped pulling from its input
    // sources and is processing any data that remains in-flight. This state may be
    // set via a Cloud Dataflow `UpdateJob` call, but only as a transition from
    // `JOB_STATE_RUNNING`. Jobs that are draining may only transition to
    // `JOB_STATE_DRAINED`, `JOB_STATE_CANCELLED`, or `JOB_STATE_FAILED`.
    //   "JOB_STATE_DRAINED" - `JOB_STATE_DRAINED` indicates that the job has been
    // drained. A drained job terminated by stopping pulling from its input sources
    // and processing any data that remained in-flight when draining was requested.
    // This state is a terminal state, may only be set by the Cloud Dataflow
    // service, and only as a transition from `JOB_STATE_DRAINING`.
    //   "JOB_STATE_PENDING" - `JOB_STATE_PENDING` indicates that the job has been
    // created but is not yet running. Jobs that are pending may only transition to
    // `JOB_STATE_RUNNING`, or `JOB_STATE_FAILED`.
    //   "JOB_STATE_CANCELLING" - `JOB_STATE_CANCELLING` indicates that the job has
    // been explicitly cancelled and is in the process of stopping. Jobs that are
    // cancelling may only transition to `JOB_STATE_CANCELLED` or
    // `JOB_STATE_FAILED`.
    //   "JOB_STATE_QUEUED" - `JOB_STATE_QUEUED` indicates that the job has been
    // created but is being delayed until launch. Jobs that are queued may only
    // transition to `JOB_STATE_PENDING` or `JOB_STATE_CANCELLED`.
    //   "JOB_STATE_RESOURCE_CLEANING_UP" - `JOB_STATE_RESOURCE_CLEANING_UP`
    // indicates that the batch job's associated resources are currently being
    // cleaned up after a successful run. Currently, this is an opt-in feature,
    // please reach out to Cloud support team if you are interested.
    RequestedState string `json:"requestedState,omitempty"`
    // RuntimeUpdatableParams: This field may ONLY be modified at runtime using the
    // projects.jobs.update method to adjust job behavior. This field has no effect
    // when specified at job creation.
    RuntimeUpdatableParams *RuntimeUpdatableParams `json:"runtimeUpdatableParams,omitempty"`
    // SatisfiesPzi: Output only. Reserved for future use. This field is set only
    // in responses from the server; it is ignored if it is set in any requests.
    SatisfiesPzi bool `json:"satisfiesPzi,omitempty"`
    // SatisfiesPzs: Reserved for future use. This field is set only in responses
    // from the server; it is ignored if it is set in any requests.
    SatisfiesPzs bool `json:"satisfiesPzs,omitempty"`
    // StageStates: This field may be mutated by the Cloud Dataflow service;
    // callers cannot mutate it.
    StageStates []*ExecutionStageState `json:"stageStates,omitempty"`
    // StartTime: The timestamp when the job was started (transitioned to
    // JOB_STATE_PENDING). Flexible resource scheduling jobs are started with some
    // delay after job creation, so start_time is unset before start and is updated
    // when the job is started by the Cloud Dataflow service. For other jobs,
    // start_time always equals to create_time and is immutable and set by the
    // Cloud Dataflow service.
    StartTime string `json:"startTime,omitempty"`
    // Steps: Exactly one of step or steps_location should be specified. The
    // top-level steps that constitute the entire job. Only retrieved with
    // JOB_VIEW_ALL.
    Steps []*Step `json:"steps,omitempty"`
    // StepsLocation: The Cloud Storage location where the steps are stored.
    StepsLocation string `json:"stepsLocation,omitempty"`
    // TempFiles: 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 `json:"tempFiles,omitempty"`
    // TransformNameMapping: The map of transform name prefixes of the job to be
    // replaced to the corresponding name prefixes of the new job.
    TransformNameMapping map[string]string `json:"transformNameMapping,omitempty"`
    // Type: Optional. The type of Dataflow job.
    //
    // Possible values:
    //   "JOB_TYPE_UNKNOWN" - The type of the job is unspecified, or unknown.
    //   "JOB_TYPE_BATCH" - A batch job with a well-defined end point: data is
    // read, data is processed, data is written, and the job is done.
    //   "JOB_TYPE_STREAMING" - A continuously streaming job with no end: data is
    // read, processed, and written continuously.
    Type string `json:"type,omitempty"`

    // ServerResponse contains the HTTP response code and headers from the server.
    googleapi.ServerResponse `json:"-"`
    // ForceSendFields is a list of field names (e.g. "ClientRequestId") to
    // unconditionally include in API requests. By default, fields with empty or
    // default values are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "ClientRequestId") to include in
    // API requests with the JSON null value. By default, fields with empty values
    // are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*Job) MarshalJSON ¶

func (s *Job) MarshalJSON() ([]byte, error)

type JobExecutionDetails ¶

JobExecutionDetails: Information about the execution of a job.

type JobExecutionDetails struct {
    // NextPageToken: If present, this response does not contain all requested
    // tasks. To obtain the next page of results, repeat the request with
    // page_token set to this value.
    NextPageToken string `json:"nextPageToken,omitempty"`
    // Stages: The stages of the job execution.
    Stages []*StageSummary `json:"stages,omitempty"`

    // ServerResponse contains the HTTP response code and headers from the server.
    googleapi.ServerResponse `json:"-"`
    // ForceSendFields is a list of field names (e.g. "NextPageToken") to
    // unconditionally include in API requests. By default, fields with empty or
    // default values are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "NextPageToken") to include in API
    // requests with the JSON null value. By default, fields with empty values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*JobExecutionDetails) MarshalJSON ¶

func (s *JobExecutionDetails) MarshalJSON() ([]byte, error)

type JobExecutionInfo ¶

JobExecutionInfo: Additional information about how a Cloud Dataflow job will be executed that isn't contained in the submitted job.

type JobExecutionInfo struct {
    // Stages: A mapping from each stage to the information about that stage.
    Stages map[string]JobExecutionStageInfo `json:"stages,omitempty"`
    // ForceSendFields is a list of field names (e.g. "Stages") to unconditionally
    // include in API requests. By default, fields with empty or default values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "Stages") to include in API
    // requests with the JSON null value. By default, fields with empty values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*JobExecutionInfo) MarshalJSON ¶

func (s *JobExecutionInfo) MarshalJSON() ([]byte, error)

type JobExecutionStageInfo ¶

JobExecutionStageInfo: Contains information about how a particular google.dataflow.v1beta3.Step will be executed.

type JobExecutionStageInfo struct {
    // StepName: 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 `json:"stepName,omitempty"`
    // ForceSendFields is a list of field names (e.g. "StepName") to
    // unconditionally include in API requests. By default, fields with empty or
    // default values are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "StepName") to include in API
    // requests with the JSON null value. By default, fields with empty values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*JobExecutionStageInfo) MarshalJSON ¶

func (s *JobExecutionStageInfo) MarshalJSON() ([]byte, error)

type JobMessage ¶

JobMessage: A particular message pertaining to a Dataflow job.

type JobMessage struct {
    // Id: Deprecated.
    Id string `json:"id,omitempty"`
    // MessageImportance: Importance level of the message.
    //
    // Possible values:
    //   "JOB_MESSAGE_IMPORTANCE_UNKNOWN" - The message importance isn't specified,
    // or is unknown.
    //   "JOB_MESSAGE_DEBUG" - The message is at the 'debug' level: typically only
    // useful for software engineers working on the code the job is running.
    // Typically, Dataflow pipeline runners do not display log messages at this
    // level by default.
    //   "JOB_MESSAGE_DETAILED" - The message is at the 'detailed' level: somewhat
    // verbose, but potentially useful to users. Typically, Dataflow pipeline
    // runners do not display log messages at this level by default. These messages
    // are displayed by default in the Dataflow monitoring UI.
    //   "JOB_MESSAGE_BASIC" - The message is at the 'basic' level: useful for
    // keeping track of the execution of a Dataflow pipeline. Typically, Dataflow
    // pipeline runners display log messages at this level by default, and these
    // messages are displayed by default in the Dataflow monitoring UI.
    //   "JOB_MESSAGE_WARNING" - The message is at the 'warning' level: indicating
    // a condition pertaining to a job which may require human intervention.
    // Typically, Dataflow pipeline runners display log messages at this level by
    // default, and these messages are displayed by default in the Dataflow
    // monitoring UI.
    //   "JOB_MESSAGE_ERROR" - The message is at the 'error' level: indicating a
    // condition preventing a job from succeeding. Typically, Dataflow pipeline
    // runners display log messages at this level by default, and these messages
    // are displayed by default in the Dataflow monitoring UI.
    MessageImportance string `json:"messageImportance,omitempty"`
    // MessageText: The text of the message.
    MessageText string `json:"messageText,omitempty"`
    // Time: The timestamp of the message.
    Time string `json:"time,omitempty"`
    // ForceSendFields is a list of field names (e.g. "Id") to unconditionally
    // include in API requests. By default, fields with empty or default values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "Id") to include in API requests
    // with the JSON null value. By default, fields with empty values are omitted
    // from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*JobMessage) MarshalJSON ¶

func (s *JobMessage) MarshalJSON() ([]byte, error)

type JobMetadata ¶

JobMetadata: Metadata available primarily for filtering jobs. Will be included in the ListJob response and Job SUMMARY view.

type JobMetadata struct {
    // BigTableDetails: Identification of a Cloud Bigtable source used in the
    // Dataflow job.
    BigTableDetails []*BigTableIODetails `json:"bigTableDetails,omitempty"`
    // BigqueryDetails: Identification of a BigQuery source used in the Dataflow
    // job.
    BigqueryDetails []*BigQueryIODetails `json:"bigqueryDetails,omitempty"`
    // DatastoreDetails: Identification of a Datastore source used in the Dataflow
    // job.
    DatastoreDetails []*DatastoreIODetails `json:"datastoreDetails,omitempty"`
    // FileDetails: Identification of a File source used in the Dataflow job.
    FileDetails []*FileIODetails `json:"fileDetails,omitempty"`
    // PubsubDetails: Identification of a Pub/Sub source used in the Dataflow job.
    PubsubDetails []*PubSubIODetails `json:"pubsubDetails,omitempty"`
    // SdkVersion: The SDK version used to run the job.
    SdkVersion *SdkVersion `json:"sdkVersion,omitempty"`
    // SpannerDetails: Identification of a Spanner source used in the Dataflow job.
    SpannerDetails []*SpannerIODetails `json:"spannerDetails,omitempty"`
    // UserDisplayProperties: List of display properties to help UI filter jobs.
    UserDisplayProperties map[string]string `json:"userDisplayProperties,omitempty"`
    // ForceSendFields is a list of field names (e.g. "BigTableDetails") to
    // unconditionally include in API requests. By default, fields with empty or
    // default values are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "BigTableDetails") to include in
    // API requests with the JSON null value. By default, fields with empty values
    // are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*JobMetadata) MarshalJSON ¶

func (s *JobMetadata) MarshalJSON() ([]byte, error)

type JobMetrics ¶

JobMetrics: JobMetrics contains a collection of metrics describing the detailed progress of a Dataflow job. Metrics correspond to user-defined and system-defined metrics in the job. For more information, see [Dataflow job metrics] (https://cloud.google.com/dataflow/docs/guides/using-monitoring-intf). This resource captures only the most recent values of each metric; time-series data can be queried for them (under the same metric names) from Cloud Monitoring.

type JobMetrics struct {
    // MetricTime: Timestamp as of which metric values are current.
    MetricTime string `json:"metricTime,omitempty"`
    // Metrics: All metrics for this job.
    Metrics []*MetricUpdate `json:"metrics,omitempty"`

    // ServerResponse contains the HTTP response code and headers from the server.
    googleapi.ServerResponse `json:"-"`
    // ForceSendFields is a list of field names (e.g. "MetricTime") to
    // unconditionally include in API requests. By default, fields with empty or
    // default values are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "MetricTime") to include in API
    // requests with the JSON null value. By default, fields with empty values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*JobMetrics) MarshalJSON ¶

func (s *JobMetrics) MarshalJSON() ([]byte, error)

type KeyRangeDataDiskAssignment ¶

KeyRangeDataDiskAssignment: Data disk assignment information for a specific key-range of a sharded computation. Currently we only support UTF-8 character splits to simplify encoding into JSON.

type KeyRangeDataDiskAssignment struct {
    // DataDisk: 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 `json:"dataDisk,omitempty"`
    // End: The end (exclusive) of the key range.
    End string `json:"end,omitempty"`
    // Start: The start (inclusive) of the key range.
    Start string `json:"start,omitempty"`
    // ForceSendFields is a list of field names (e.g. "DataDisk") to
    // unconditionally include in API requests. By default, fields with empty or
    // default values are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "DataDisk") to include in API
    // requests with the JSON null value. By default, fields with empty values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*KeyRangeDataDiskAssignment) MarshalJSON ¶

func (s *KeyRangeDataDiskAssignment) MarshalJSON() ([]byte, error)

type KeyRangeLocation ¶

KeyRangeLocation: Location information for a specific key-range of a sharded computation. Currently we only support UTF-8 character splits to simplify encoding into JSON.

type KeyRangeLocation struct {
    // DataDisk: 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 `json:"dataDisk,omitempty"`
    // DeliveryEndpoint: The physical location of this range assignment to be used
    // for streaming computation cross-worker message delivery.
    DeliveryEndpoint string `json:"deliveryEndpoint,omitempty"`
    // DeprecatedPersistentDirectory: DEPRECATED. The location of the persistent
    // state for this range, as a persistent directory in the worker local
    // filesystem.
    DeprecatedPersistentDirectory string `json:"deprecatedPersistentDirectory,omitempty"`
    // End: The end (exclusive) of the key range.
    End string `json:"end,omitempty"`
    // Start: The start (inclusive) of the key range.
    Start string `json:"start,omitempty"`
    // ForceSendFields is a list of field names (e.g. "DataDisk") to
    // unconditionally include in API requests. By default, fields with empty or
    // default values are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "DataDisk") to include in API
    // requests with the JSON null value. By default, fields with empty values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*KeyRangeLocation) MarshalJSON ¶

func (s *KeyRangeLocation) MarshalJSON() ([]byte, error)

type LaunchFlexTemplateParameter ¶

LaunchFlexTemplateParameter: Launch FlexTemplate Parameter.

type LaunchFlexTemplateParameter struct {
    // ContainerSpec: Spec about the container image to launch.
    ContainerSpec *ContainerSpec `json:"containerSpec,omitempty"`
    // ContainerSpecGcsPath: Cloud Storage path to a file with json serialized
    // ContainerSpec as content.
    ContainerSpecGcsPath string `json:"containerSpecGcsPath,omitempty"`
    // Environment: The runtime environment for the FlexTemplate job
    Environment *FlexTemplateRuntimeEnvironment `json:"environment,omitempty"`
    // JobName: Required. The job name to use for the created job. For update job
    // request, job name should be same as the existing running job.
    JobName string `json:"jobName,omitempty"`
    // LaunchOptions: Launch options for this flex template job. This is a common
    // set of options across languages and templates. This should not be used to
    // pass job parameters.
    LaunchOptions map[string]string `json:"launchOptions,omitempty"`
    // Parameters: The parameters for FlexTemplate. Ex. {"num_workers":"5"}
    Parameters map[string]string `json:"parameters,omitempty"`
    // TransformNameMappings: Use this to pass transform_name_mappings for
    // streaming update jobs. Ex:{"oldTransformName":"newTransformName",...}'
    TransformNameMappings map[string]string `json:"transformNameMappings,omitempty"`
    // Update: Set this to true if you are sending a request to update a running
    // streaming job. When set, the job name should be the same as the running job.
    Update bool `json:"update,omitempty"`
    // ForceSendFields is a list of field names (e.g. "ContainerSpec") to
    // unconditionally include in API requests. By default, fields with empty or
    // default values are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "ContainerSpec") to include in API
    // requests with the JSON null value. By default, fields with empty values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*LaunchFlexTemplateParameter) MarshalJSON ¶

func (s *LaunchFlexTemplateParameter) MarshalJSON() ([]byte, error)

type LaunchFlexTemplateRequest ¶

LaunchFlexTemplateRequest: A request to launch a Cloud Dataflow job from a FlexTemplate.

type LaunchFlexTemplateRequest struct {
    // LaunchParameter: Required. Parameter to launch a job form Flex Template.
    LaunchParameter *LaunchFlexTemplateParameter `json:"launchParameter,omitempty"`
    // ValidateOnly: If true, the request is validated but not actually executed.
    // Defaults to false.
    ValidateOnly bool `json:"validateOnly,omitempty"`
    // ForceSendFields is a list of field names (e.g. "LaunchParameter") to
    // unconditionally include in API requests. By default, fields with empty or
    // default values are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "LaunchParameter") to include in
    // API requests with the JSON null value. By default, fields with empty values
    // are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*LaunchFlexTemplateRequest) MarshalJSON ¶

func (s *LaunchFlexTemplateRequest) MarshalJSON() ([]byte, error)

type LaunchFlexTemplateResponse ¶

LaunchFlexTemplateResponse: Response to the request to launch a job from Flex Template.

type LaunchFlexTemplateResponse struct {
    // Job: The job that was launched, if the request was not a dry run and the job
    // was successfully launched.
    Job *Job `json:"job,omitempty"`

    // ServerResponse contains the HTTP response code and headers from the server.
    googleapi.ServerResponse `json:"-"`
    // ForceSendFields is a list of field names (e.g. "Job") to unconditionally
    // include in API requests. By default, fields with empty or default values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "Job") to include in API requests
    // with the JSON null value. By default, fields with empty values are omitted
    // from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*LaunchFlexTemplateResponse) MarshalJSON ¶

func (s *LaunchFlexTemplateResponse) MarshalJSON() ([]byte, error)

type LaunchTemplateParameters ¶

LaunchTemplateParameters: Parameters to provide to the template being launched. Note that the [metadata in the pipeline code] (https://cloud.google.com/dataflow/docs/guides/templates/creating-templates#metadata) determines which runtime parameters are valid.

type LaunchTemplateParameters struct {
    // Environment: The runtime environment for the job.
    Environment *RuntimeEnvironment `json:"environment,omitempty"`
    // JobName: Required. The job name to use for the created job. The name must
    // match the regular expression `[a-z]([-a-z0-9]{0,1022}[a-z0-9])?`
    JobName string `json:"jobName,omitempty"`
    // Parameters: The runtime parameters to pass to the job.
    Parameters map[string]string `json:"parameters,omitempty"`
    // TransformNameMapping: Only applicable when updating a pipeline. Map of
    // transform name prefixes of the job to be replaced to the corresponding name
    // prefixes of the new job.
    TransformNameMapping map[string]string `json:"transformNameMapping,omitempty"`
    // Update: If set, replace the existing pipeline with the name specified by
    // jobName with this pipeline, preserving state.
    Update bool `json:"update,omitempty"`
    // ForceSendFields is a list of field names (e.g. "Environment") to
    // unconditionally include in API requests. By default, fields with empty or
    // default values are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "Environment") to include in API
    // requests with the JSON null value. By default, fields with empty values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*LaunchTemplateParameters) MarshalJSON ¶

func (s *LaunchTemplateParameters) MarshalJSON() ([]byte, error)

type LaunchTemplateResponse ¶

LaunchTemplateResponse: Response to the request to launch a template.

type LaunchTemplateResponse struct {
    // Job: The job that was launched, if the request was not a dry run and the job
    // was successfully launched.
    Job *Job `json:"job,omitempty"`

    // ServerResponse contains the HTTP response code and headers from the server.
    googleapi.ServerResponse `json:"-"`
    // ForceSendFields is a list of field names (e.g. "Job") to unconditionally
    // include in API requests. By default, fields with empty or default values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "Job") to include in API requests
    // with the JSON null value. By default, fields with empty values are omitted
    // from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*LaunchTemplateResponse) MarshalJSON ¶

func (s *LaunchTemplateResponse) MarshalJSON() ([]byte, error)

type LeaseWorkItemRequest ¶

LeaseWorkItemRequest: Request to lease WorkItems.

type LeaseWorkItemRequest struct {
    // CurrentWorkerTime: The current timestamp at the worker.
    CurrentWorkerTime string `json:"currentWorkerTime,omitempty"`
    // Location: The [regional endpoint]
    // (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that
    // contains the WorkItem's job.
    Location string `json:"location,omitempty"`
    // RequestedLeaseDuration: The initial lease period.
    RequestedLeaseDuration string `json:"requestedLeaseDuration,omitempty"`
    // UnifiedWorkerRequest: Untranslated bag-of-bytes WorkRequest from
    // UnifiedWorker.
    UnifiedWorkerRequest googleapi.RawMessage `json:"unifiedWorkerRequest,omitempty"`
    // WorkItemTypes: Filter for WorkItem type.
    WorkItemTypes []string `json:"workItemTypes,omitempty"`
    // WorkerCapabilities: Worker capabilities. WorkItems might be limited to
    // workers with specific capabilities.
    WorkerCapabilities []string `json:"workerCapabilities,omitempty"`
    // WorkerId: Identifies the worker leasing work -- typically the ID of the
    // virtual machine running the worker.
    WorkerId string `json:"workerId,omitempty"`
    // ForceSendFields is a list of field names (e.g. "CurrentWorkerTime") to
    // unconditionally include in API requests. By default, fields with empty or
    // default values are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "CurrentWorkerTime") to include in
    // API requests with the JSON null value. By default, fields with empty values
    // are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*LeaseWorkItemRequest) MarshalJSON ¶

func (s *LeaseWorkItemRequest) MarshalJSON() ([]byte, error)

type LeaseWorkItemResponse ¶

LeaseWorkItemResponse: Response to a request to lease WorkItems.

type LeaseWorkItemResponse struct {
    // UnifiedWorkerResponse: Untranslated bag-of-bytes WorkResponse for
    // UnifiedWorker.
    UnifiedWorkerResponse googleapi.RawMessage `json:"unifiedWorkerResponse,omitempty"`
    // WorkItems: A list of the leased WorkItems.
    WorkItems []*WorkItem `json:"workItems,omitempty"`

    // ServerResponse contains the HTTP response code and headers from the server.
    googleapi.ServerResponse `json:"-"`
    // ForceSendFields is a list of field names (e.g. "UnifiedWorkerResponse") to
    // unconditionally include in API requests. By default, fields with empty or
    // default values are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "UnifiedWorkerResponse") to
    // include in API requests with the JSON null value. By default, fields with
    // empty values are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*LeaseWorkItemResponse) MarshalJSON ¶

func (s *LeaseWorkItemResponse) MarshalJSON() ([]byte, error)

type Linear ¶

Linear: Linear buckets with the following boundaries for indices in 0 to n-1. - i in [0, n-1]: [start + (i)*width, start + (i+1)*width)

type Linear struct {
    // NumberOfBuckets: Must be greater than 0.
    NumberOfBuckets int64 `json:"numberOfBuckets,omitempty"`
    // Start: Lower bound of the first bucket.
    Start float64 `json:"start,omitempty"`
    // Width: Distance between bucket boundaries. Must be greater than 0.
    Width float64 `json:"width,omitempty"`
    // ForceSendFields is a list of field names (e.g. "NumberOfBuckets") to
    // unconditionally include in API requests. By default, fields with empty or
    // default values are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "NumberOfBuckets") to include in
    // API requests with the JSON null value. By default, fields with empty values
    // are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*Linear) MarshalJSON ¶

func (s *Linear) MarshalJSON() ([]byte, error)

func (*Linear) UnmarshalJSON ¶

func (s *Linear) UnmarshalJSON(data []byte) error

type ListJobMessagesResponse ¶

ListJobMessagesResponse: Response to a request to list job messages.

type ListJobMessagesResponse struct {
    // AutoscalingEvents: Autoscaling events in ascending timestamp order.
    AutoscalingEvents []*AutoscalingEvent `json:"autoscalingEvents,omitempty"`
    // JobMessages: Messages in ascending timestamp order.
    JobMessages []*JobMessage `json:"jobMessages,omitempty"`
    // NextPageToken: The token to obtain the next page of results if there are
    // more.
    NextPageToken string `json:"nextPageToken,omitempty"`

    // ServerResponse contains the HTTP response code and headers from the server.
    googleapi.ServerResponse `json:"-"`
    // ForceSendFields is a list of field names (e.g. "AutoscalingEvents") to
    // unconditionally include in API requests. By default, fields with empty or
    // default values are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "AutoscalingEvents") to include in
    // API requests with the JSON null value. By default, fields with empty values
    // are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*ListJobMessagesResponse) MarshalJSON ¶

func (s *ListJobMessagesResponse) MarshalJSON() ([]byte, error)

type ListJobsResponse ¶

ListJobsResponse: Response to a request to list Cloud Dataflow jobs in a project. This might be a partial response, depending on the page size in the ListJobsRequest. However, if the project does not have any jobs, an instance of ListJobsResponse is not returned and the requests's response body is empty {}.

type ListJobsResponse struct {
    // FailedLocation: Zero or more messages describing the [regional endpoints]
    // (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that
    // failed to respond.
    FailedLocation []*FailedLocation `json:"failedLocation,omitempty"`
    // Jobs: A subset of the requested job information.
    Jobs []*Job `json:"jobs,omitempty"`
    // NextPageToken: Set if there may be more results than fit in this response.
    NextPageToken string `json:"nextPageToken,omitempty"`

    // ServerResponse contains the HTTP response code and headers from the server.
    googleapi.ServerResponse `json:"-"`
    // ForceSendFields is a list of field names (e.g. "FailedLocation") to
    // unconditionally include in API requests. By default, fields with empty or
    // default values are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "FailedLocation") to include in
    // API requests with the JSON null value. By default, fields with empty values
    // are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*ListJobsResponse) MarshalJSON ¶

func (s *ListJobsResponse) MarshalJSON() ([]byte, error)

type ListSnapshotsResponse ¶

ListSnapshotsResponse: List of snapshots.

type ListSnapshotsResponse struct {
    // Snapshots: Returned snapshots.
    Snapshots []*Snapshot `json:"snapshots,omitempty"`

    // ServerResponse contains the HTTP response code and headers from the server.
    googleapi.ServerResponse `json:"-"`
    // ForceSendFields is a list of field names (e.g. "Snapshots") to
    // unconditionally include in API requests. By default, fields with empty or
    // default values are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "Snapshots") to include in API
    // requests with the JSON null value. By default, fields with empty values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*ListSnapshotsResponse) MarshalJSON ¶

func (s *ListSnapshotsResponse) MarshalJSON() ([]byte, error)

type MapTask ¶

MapTask: MapTask consists of an ordered set of instructions, each of which describes one particular low-level operation for the worker to perform in order to accomplish the MapTask's WorkItem. Each instruction must appear in the list before any instructions which depends on its output.

type MapTask struct {
    // CounterPrefix: Counter prefix that can be used to prefix counters. Not
    // currently used in Dataflow.
    CounterPrefix string `json:"counterPrefix,omitempty"`
    // Instructions: The instructions in the MapTask.
    Instructions []*ParallelInstruction `json:"instructions,omitempty"`
    // StageName: System-defined name of the stage containing this MapTask. Unique
    // across the workflow.
    StageName string `json:"stageName,omitempty"`
    // SystemName: System-defined name of this MapTask. Unique across the workflow.
    SystemName string `json:"systemName,omitempty"`
    // ForceSendFields is a list of field names (e.g. "CounterPrefix") to
    // unconditionally include in API requests. By default, fields with empty or
    // default values are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "CounterPrefix") to include in API
    // requests with the JSON null value. By default, fields with empty values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*MapTask) MarshalJSON ¶

func (s *MapTask) MarshalJSON() ([]byte, error)

type MemInfo ¶

MemInfo: Information about the memory usage of a worker or a container within a worker.

type MemInfo struct {
    // CurrentLimitBytes: Instantenous memory limit in bytes.
    CurrentLimitBytes uint64 `json:"currentLimitBytes,omitempty,string"`
    // CurrentOoms: Number of Out of Memory (OOM) events recorded since the
    // previous measurement.
    CurrentOoms int64 `json:"currentOoms,omitempty,string"`
    // CurrentRssBytes: Instantenous memory (RSS) size in bytes.
    CurrentRssBytes uint64 `json:"currentRssBytes,omitempty,string"`
    // Timestamp: Timestamp of the measurement.
    Timestamp string `json:"timestamp,omitempty"`
    // TotalGbMs: Total memory (RSS) usage since start up in GB * ms.
    TotalGbMs uint64 `json:"totalGbMs,omitempty,string"`
    // ForceSendFields is a list of field names (e.g. "CurrentLimitBytes") to
    // unconditionally include in API requests. By default, fields with empty or
    // default values are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "CurrentLimitBytes") to include in
    // API requests with the JSON null value. By default, fields with empty values
    // are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*MemInfo) MarshalJSON ¶

func (s *MemInfo) MarshalJSON() ([]byte, error)

type MetricShortId ¶

MetricShortId: The metric short id is returned to the user alongside an offset into ReportWorkItemStatusRequest

type MetricShortId struct {
    // MetricIndex: The index of the corresponding metric in the
    // ReportWorkItemStatusRequest. Required.
    MetricIndex int64 `json:"metricIndex,omitempty"`
    // ShortId: The service-generated short identifier for the metric.
    ShortId int64 `json:"shortId,omitempty,string"`
    // ForceSendFields is a list of field names (e.g. "MetricIndex") to
    // unconditionally include in API requests. By default, fields with empty or
    // default values are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "MetricIndex") to include in API
    // requests with the JSON null value. By default, fields with empty values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*MetricShortId) MarshalJSON ¶

func (s *MetricShortId) MarshalJSON() ([]byte, error)

type MetricStructuredName ¶

MetricStructuredName: Identifies a metric, by describing the source which generated the metric.

type MetricStructuredName struct {
    // Context: 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'] =
    // . Counters associated with PCollections in the SDK will have
    // context['pcollection'] = .
    Context map[string]string `json:"context,omitempty"`
    // Name: Worker-defined metric name.
    Name string `json:"name,omitempty"`
    // Origin: 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 `json:"origin,omitempty"`
    // ForceSendFields is a list of field names (e.g. "Context") to unconditionally
    // include in API requests. By default, fields with empty or default values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "Context") to include in API
    // requests with the JSON null value. By default, fields with empty values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*MetricStructuredName) MarshalJSON ¶

func (s *MetricStructuredName) MarshalJSON() ([]byte, error)

type MetricUpdate ¶

MetricUpdate: Describes the state of a metric.

type MetricUpdate struct {
    // Cumulative: 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 bool `json:"cumulative,omitempty"`
    // Distribution: A struct value describing properties of a distribution of
    // numeric values.
    Distribution interface{} `json:"distribution,omitempty"`
    // Gauge: A struct value describing properties of a Gauge. Metrics of gauge
    // type show the value of a metric across time, and is aggregated based on the
    // newest value.
    Gauge interface{} `json:"gauge,omitempty"`
    // Internal: Worker-computed aggregate value for internal use by the Dataflow
    // service.
    Internal interface{} `json:"internal,omitempty"`
    // Kind: 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 `json:"kind,omitempty"`
    // MeanCount: 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 interface{} `json:"meanCount,omitempty"`
    // MeanSum: 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 interface{} `json:"meanSum,omitempty"`
    // Name: Name of the metric.
    Name *MetricStructuredName `json:"name,omitempty"`
    // Scalar: Worker-computed aggregate value for aggregation kinds "Sum", "Max",
    // "Min", "And", and "Or". The possible value types are Long, Double, and
    // Boolean.
    Scalar interface{} `json:"scalar,omitempty"`
    // Set: 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 interface{} `json:"set,omitempty"`
    // UpdateTime: 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 `json:"updateTime,omitempty"`
    // ForceSendFields is a list of field names (e.g. "Cumulative") to
    // unconditionally include in API requests. By default, fields with empty or
    // default values are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "Cumulative") to include in API
    // requests with the JSON null value. By default, fields with empty values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*MetricUpdate) MarshalJSON ¶

func (s *MetricUpdate) MarshalJSON() ([]byte, error)

type MetricValue ¶

MetricValue: The value of a metric along with its name and labels.

type MetricValue struct {
    // Metric: Base name for this metric.
    Metric string `json:"metric,omitempty"`
    // MetricLabels: Optional. Set of metric labels for this metric.
    MetricLabels map[string]string `json:"metricLabels,omitempty"`
    // ValueHistogram: Histogram value of this metric.
    ValueHistogram *DataflowHistogramValue `json:"valueHistogram,omitempty"`
    // ValueInt64: Integer value of this metric.
    ValueInt64 int64 `json:"valueInt64,omitempty,string"`
    // ForceSendFields is a list of field names (e.g. "Metric") to unconditionally
    // include in API requests. By default, fields with empty or default values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "Metric") to include in API
    // requests with the JSON null value. By default, fields with empty values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*MetricValue) MarshalJSON ¶

func (s *MetricValue) MarshalJSON() ([]byte, error)

type MountedDataDisk ¶

MountedDataDisk: Describes mounted data disk.

type MountedDataDisk struct {
    // DataDisk: 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 `json:"dataDisk,omitempty"`
    // ForceSendFields is a list of field names (e.g. "DataDisk") to
    // unconditionally include in API requests. By default, fields with empty or
    // default values are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "DataDisk") to include in API
    // requests with the JSON null value. By default, fields with empty values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*MountedDataDisk) MarshalJSON ¶

func (s *MountedDataDisk) MarshalJSON() ([]byte, error)

type MultiOutputInfo ¶

MultiOutputInfo: Information about an output of a multi-output DoFn.

type MultiOutputInfo struct {
    // Tag: 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 `json:"tag,omitempty"`
    // ForceSendFields is a list of field names (e.g. "Tag") to unconditionally
    // include in API requests. By default, fields with empty or default values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "Tag") to include in API requests
    // with the JSON null value. By default, fields with empty values are omitted
    // from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*MultiOutputInfo) MarshalJSON ¶

func (s *MultiOutputInfo) MarshalJSON() ([]byte, error)

type NameAndKind ¶

NameAndKind: Basic metadata about a counter.

type NameAndKind struct {
    // Kind: Counter aggregation kind.
    //
    // Possible values:
    //   "INVALID" - Counter aggregation kind was not set.
    //   "SUM" - Aggregated value is the sum of all contributed values.
    //   "MAX" - Aggregated value is the max of all contributed values.
    //   "MIN" - Aggregated value is the min of all contributed values.
    //   "MEAN" - Aggregated value is the mean of all contributed values.
    //   "OR" - Aggregated value represents the logical 'or' of all contributed
    // values.
    //   "AND" - Aggregated value represents the logical 'and' of all contributed
    // values.
    //   "SET" - Aggregated value is a set of unique contributed values.
    //   "DISTRIBUTION" - Aggregated value captures statistics about a
    // distribution.
    //   "LATEST_VALUE" - Aggregated value tracks the latest value of a variable.
    Kind string `json:"kind,omitempty"`
    // Name: Name of the counter.
    Name string `json:"name,omitempty"`
    // ForceSendFields is a list of field names (e.g. "Kind") to unconditionally
    // include in API requests. By default, fields with empty or default values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "Kind") to include in API requests
    // with the JSON null value. By default, fields with empty values are omitted
    // from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*NameAndKind) MarshalJSON ¶

func (s *NameAndKind) MarshalJSON() ([]byte, error)

type OutlierStats ¶

OutlierStats: Statistics for the underflow and overflow bucket.

type OutlierStats struct {
    // OverflowCount: Number of values that are larger than the upper bound of the
    // largest bucket.
    OverflowCount int64 `json:"overflowCount,omitempty,string"`
    // OverflowMean: Mean of values in the overflow bucket.
    OverflowMean float64 `json:"overflowMean,omitempty"`
    // UnderflowCount: Number of values that are smaller than the lower bound of
    // the smallest bucket.
    UnderflowCount int64 `json:"underflowCount,omitempty,string"`
    // UnderflowMean: Mean of values in the undeflow bucket.
    UnderflowMean float64 `json:"underflowMean,omitempty"`
    // ForceSendFields is a list of field names (e.g. "OverflowCount") to
    // unconditionally include in API requests. By default, fields with empty or
    // default values are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "OverflowCount") to include in API
    // requests with the JSON null value. By default, fields with empty values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*OutlierStats) MarshalJSON ¶

func (s *OutlierStats) MarshalJSON() ([]byte, error)

func (*OutlierStats) UnmarshalJSON ¶

func (s *OutlierStats) UnmarshalJSON(data []byte) error

type Package ¶

Package: The packages that must be installed in order for a worker to run the steps of the Cloud Dataflow job that will be assigned to its worker pool. This is the mechanism by which the Cloud Dataflow SDK causes code to be loaded onto the workers. For example, the Cloud Dataflow Java SDK might use this to install jars containing the user's code and all of the various dependencies (libraries, data files, etc.) required in order for that code to run.

type Package struct {
    // Location: 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 `json:"location,omitempty"`
    // Name: The name of the package.
    Name string `json:"name,omitempty"`
    // ForceSendFields is a list of field names (e.g. "Location") to
    // unconditionally include in API requests. By default, fields with empty or
    // default values are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "Location") to include in API
    // requests with the JSON null value. By default, fields with empty values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*Package) MarshalJSON ¶

func (s *Package) MarshalJSON() ([]byte, error)

type ParDoInstruction ¶

ParDoInstruction: An instruction that does a ParDo operation. Takes one main input and zero or more side inputs, and produces zero or more outputs. Runs user code.

type ParDoInstruction struct {
    // Input: The input.
    Input *InstructionInput `json:"input,omitempty"`
    // MultiOutputInfos: Information about each of the outputs, if user_fn is a
    // MultiDoFn.
    MultiOutputInfos []*MultiOutputInfo `json:"multiOutputInfos,omitempty"`
    // NumOutputs: The number of outputs.
    NumOutputs int64 `json:"numOutputs,omitempty"`
    // SideInputs: Zero or more side inputs.
    SideInputs []*SideInputInfo `json:"sideInputs,omitempty"`
    // UserFn: The user function to invoke.
    UserFn googleapi.RawMessage `json:"userFn,omitempty"`
    // ForceSendFields is a list of field names (e.g. "Input") to unconditionally
    // include in API requests. By default, fields with empty or default values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "Input") to include in API
    // requests with the JSON null value. By default, fields with empty values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*ParDoInstruction) MarshalJSON ¶

func (s *ParDoInstruction) MarshalJSON() ([]byte, error)

type ParallelInstruction ¶

ParallelInstruction: Describes a particular operation comprising a MapTask.

type ParallelInstruction struct {
    // Flatten: Additional information for Flatten instructions.
    Flatten *FlattenInstruction `json:"flatten,omitempty"`
    // Name: User-provided name of this operation.
    Name string `json:"name,omitempty"`
    // OriginalName: System-defined name for the operation in the original workflow
    // graph.
    OriginalName string `json:"originalName,omitempty"`
    // Outputs: Describes the outputs of the instruction.
    Outputs []*InstructionOutput `json:"outputs,omitempty"`
    // ParDo: Additional information for ParDo instructions.
    ParDo *ParDoInstruction `json:"parDo,omitempty"`
    // PartialGroupByKey: Additional information for PartialGroupByKey
    // instructions.
    PartialGroupByKey *PartialGroupByKeyInstruction `json:"partialGroupByKey,omitempty"`
    // Read: Additional information for Read instructions.
    Read *ReadInstruction `json:"read,omitempty"`
    // SystemName: System-defined name of this operation. Unique across the
    // workflow.
    SystemName string `json:"systemName,omitempty"`
    // Write: Additional information for Write instructions.
    Write *WriteInstruction `json:"write,omitempty"`
    // ForceSendFields is a list of field names (e.g. "Flatten") to unconditionally
    // include in API requests. By default, fields with empty or default values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "Flatten") to include in API
    // requests with the JSON null value. By default, fields with empty values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*ParallelInstruction) MarshalJSON ¶

func (s *ParallelInstruction) MarshalJSON() ([]byte, error)

type Parameter ¶

Parameter: Structured data associated with this message.

type Parameter struct {
    // Key: Key or name for this parameter.
    Key string `json:"key,omitempty"`
    // Value: Value for this parameter.
    Value interface{} `json:"value,omitempty"`
    // ForceSendFields is a list of field names (e.g. "Key") to unconditionally
    // include in API requests. By default, fields with empty or default values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "Key") to include in API requests
    // with the JSON null value. By default, fields with empty values are omitted
    // from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*Parameter) MarshalJSON ¶

func (s *Parameter) MarshalJSON() ([]byte, error)

type ParameterMetadata ¶

ParameterMetadata: Metadata for a specific parameter.

type ParameterMetadata struct {
    // CustomMetadata: Optional. Additional metadata for describing this parameter.
    CustomMetadata map[string]string `json:"customMetadata,omitempty"`
    // DefaultValue: Optional. The default values will pre-populate the parameter
    // with the given value from the proto. If default_value is left empty, the
    // parameter will be populated with a default of the relevant type, e.g. false
    // for a boolean.
    DefaultValue string `json:"defaultValue,omitempty"`
    // EnumOptions: Optional. The options shown when ENUM ParameterType is
    // specified.
    EnumOptions []*ParameterMetadataEnumOption `json:"enumOptions,omitempty"`
    // GroupName: Optional. Specifies a group name for this parameter to be
    // rendered under. Group header text will be rendered exactly as specified in
    // this field. Only considered when parent_name is NOT provided.
    GroupName string `json:"groupName,omitempty"`
    // HelpText: Required. The help text to display for the parameter.
    HelpText string `json:"helpText,omitempty"`
    // HiddenUi: Optional. Whether the parameter should be hidden in the UI.
    HiddenUi bool `json:"hiddenUi,omitempty"`
    // IsOptional: Optional. Whether the parameter is optional. Defaults to false.
    IsOptional bool `json:"isOptional,omitempty"`
    // Label: Required. The label to display for the parameter.
    Label string `json:"label,omitempty"`
    // Name: Required. The name of the parameter.
    Name string `json:"name,omitempty"`
    // ParamType: Optional. The type of the parameter. Used for selecting input
    // picker.
    //
    // Possible values:
    //   "DEFAULT" - Default input type.
    //   "TEXT" - The parameter specifies generic text input.
    //   "GCS_READ_BUCKET" - The parameter specifies a Cloud Storage Bucket to read
    // from.
    //   "GCS_WRITE_BUCKET" - The parameter specifies a Cloud Storage Bucket to
    // write to.
    //   "GCS_READ_FILE" - The parameter specifies a Cloud Storage file path to
    // read from.
    //   "GCS_WRITE_FILE" - The parameter specifies a Cloud Storage file path to
    // write to.
    //   "GCS_READ_FOLDER" - The parameter specifies a Cloud Storage folder path to
    // read from.
    //   "GCS_WRITE_FOLDER" - The parameter specifies a Cloud Storage folder to
    // write to.
    //   "PUBSUB_TOPIC" - The parameter specifies a Pub/Sub Topic.
    //   "PUBSUB_SUBSCRIPTION" - The parameter specifies a Pub/Sub Subscription.
    //   "BIGQUERY_TABLE" - The parameter specifies a BigQuery table.
    //   "JAVASCRIPT_UDF_FILE" - The parameter specifies a JavaScript UDF in Cloud
    // Storage.
    //   "SERVICE_ACCOUNT" - The parameter specifies a Service Account email.
    //   "MACHINE_TYPE" - The parameter specifies a Machine Type.
    //   "KMS_KEY_NAME" - The parameter specifies a KMS Key name.
    //   "WORKER_REGION" - The parameter specifies a Worker Region.
    //   "WORKER_ZONE" - The parameter specifies a Worker Zone.
    //   "BOOLEAN" - The parameter specifies a boolean input.
    //   "ENUM" - The parameter specifies an enum input.
    //   "NUMBER" - The parameter specifies a number input.
    //   "KAFKA_TOPIC" - The parameter specifies the fully-qualified name of an
    // Apache Kafka topic. This can be either a Google Managed Kafka topic or a
    // non-managed Kafka topic.
    ParamType string `json:"paramType,omitempty"`
    // ParentName: Optional. Specifies the name of the parent parameter. Used in
    // conjunction with 'parent_trigger_values' to make this parameter conditional
    // (will only be rendered conditionally). Should be mappable to a
    // ParameterMetadata.name field.
    ParentName string `json:"parentName,omitempty"`
    // ParentTriggerValues: Optional. The value(s) of the 'parent_name' parameter
    // which will trigger this parameter to be shown. If left empty, ANY non-empty
    // value in parent_name will trigger this parameter to be shown. Only
    // considered when this parameter is conditional (when 'parent_name' has been
    // provided).
    ParentTriggerValues []string `json:"parentTriggerValues,omitempty"`
    // Regexes: Optional. Regexes that the parameter must match.
    Regexes []string `json:"regexes,omitempty"`
    // ForceSendFields is a list of field names (e.g. "CustomMetadata") to
    // unconditionally include in API requests. By default, fields with empty or
    // default values are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "CustomMetadata") to include in
    // API requests with the JSON null value. By default, fields with empty values
    // are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*ParameterMetadata) MarshalJSON ¶

func (s *ParameterMetadata) MarshalJSON() ([]byte, error)

type ParameterMetadataEnumOption ¶

ParameterMetadataEnumOption: ParameterMetadataEnumOption specifies the option shown in the enum form.

type ParameterMetadataEnumOption struct {
    // Description: Optional. The description to display for the enum option.
    Description string `json:"description,omitempty"`
    // Label: Optional. The label to display for the enum option.
    Label string `json:"label,omitempty"`
    // Value: Required. The value of the enum option.
    Value string `json:"value,omitempty"`
    // ForceSendFields is a list of field names (e.g. "Description") to
    // unconditionally include in API requests. By default, fields with empty or
    // default values are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "Description") to include in API
    // requests with the JSON null value. By default, fields with empty values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*ParameterMetadataEnumOption) MarshalJSON ¶

func (s *ParameterMetadataEnumOption) MarshalJSON() ([]byte, error)

type PartialGroupByKeyInstruction ¶

PartialGroupByKeyInstruction: An instruction that does a partial group-by-key. One input and one output.

type PartialGroupByKeyInstruction struct {
    // Input: Describes the input to the partial group-by-key instruction.
    Input *InstructionInput `json:"input,omitempty"`
    // InputElementCodec: The codec to use for interpreting an element in the input
    // PTable.
    InputElementCodec googleapi.RawMessage `json:"inputElementCodec,omitempty"`
    // OriginalCombineValuesInputStoreName: If this instruction includes a
    // combining function this is the name of the intermediate store between the
    // GBK and the CombineValues.
    OriginalCombineValuesInputStoreName string `json:"originalCombineValuesInputStoreName,omitempty"`
    // OriginalCombineValuesStepName: If this instruction includes a combining
    // function, this is the name of the CombineValues instruction lifted into this
    // instruction.
    OriginalCombineValuesStepName string `json:"originalCombineValuesStepName,omitempty"`
    // SideInputs: Zero or more side inputs.
    SideInputs []*SideInputInfo `json:"sideInputs,omitempty"`
    // ValueCombiningFn: The value combining function to invoke.
    ValueCombiningFn googleapi.RawMessage `json:"valueCombiningFn,omitempty"`
    // ForceSendFields is a list of field names (e.g. "Input") to unconditionally
    // include in API requests. By default, fields with empty or default values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "Input") to include in API
    // requests with the JSON null value. By default, fields with empty values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*PartialGroupByKeyInstruction) MarshalJSON ¶

func (s *PartialGroupByKeyInstruction) MarshalJSON() ([]byte, error)

type PerStepNamespaceMetrics ¶

PerStepNamespaceMetrics: Metrics for a particular unfused step and namespace. A metric is uniquely identified by the `metrics_namespace`, `original_step`, `metric name` and `metric_labels`.

type PerStepNamespaceMetrics struct {
    // MetricValues: Optional. Metrics that are recorded for this namespace and
    // unfused step.
    MetricValues []*MetricValue `json:"metricValues,omitempty"`
    // MetricsNamespace: The namespace of these metrics on the worker.
    MetricsNamespace string `json:"metricsNamespace,omitempty"`
    // OriginalStep: The original system name of the unfused step that these
    // metrics are reported from.
    OriginalStep string `json:"originalStep,omitempty"`
    // ForceSendFields is a list of field names (e.g. "MetricValues") to
    // unconditionally include in API requests. By default, fields with empty or
    // default values are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "MetricValues") to include in API
    // requests with the JSON null value. By default, fields with empty values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*PerStepNamespaceMetrics) MarshalJSON ¶

func (s *PerStepNamespaceMetrics) MarshalJSON() ([]byte, error)

type PerWorkerMetrics ¶

PerWorkerMetrics: Per worker metrics.

type PerWorkerMetrics struct {
    // PerStepNamespaceMetrics: Optional. Metrics for a particular unfused step and
    // namespace.
    PerStepNamespaceMetrics []*PerStepNamespaceMetrics `json:"perStepNamespaceMetrics,omitempty"`
    // ForceSendFields is a list of field names (e.g. "PerStepNamespaceMetrics") to
    // unconditionally include in API requests. By default, fields with empty or
    // default values are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "PerStepNamespaceMetrics") to
    // include in API requests with the JSON null value. By default, fields with
    // empty values are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*PerWorkerMetrics) MarshalJSON ¶

func (s *PerWorkerMetrics) MarshalJSON() ([]byte, error)

type PipelineDescription ¶

PipelineDescription: A descriptive representation of submitted pipeline as well as the executed form. This data is provided by the Dataflow service for ease of visualizing the pipeline and interpreting Dataflow provided metrics.

type PipelineDescription struct {
    // DisplayData: Pipeline level display data.
    DisplayData []*DisplayData `json:"displayData,omitempty"`
    // ExecutionPipelineStage: Description of each stage of execution of the
    // pipeline.
    ExecutionPipelineStage []*ExecutionStageSummary `json:"executionPipelineStage,omitempty"`
    // OriginalPipelineTransform: Description of each transform in the pipeline and
    // collections between them.
    OriginalPipelineTransform []*TransformSummary `json:"originalPipelineTransform,omitempty"`
    // StepNamesHash: A hash value of the submitted pipeline portable graph step
    // names if exists.
    StepNamesHash string `json:"stepNamesHash,omitempty"`
    // ForceSendFields is a list of field names (e.g. "DisplayData") to
    // unconditionally include in API requests. By default, fields with empty or
    // default values are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "DisplayData") to include in API
    // requests with the JSON null value. By default, fields with empty values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*PipelineDescription) MarshalJSON ¶

func (s *PipelineDescription) MarshalJSON() ([]byte, error)

type Point ¶

Point: A point in the timeseries.

type Point struct {
    // Time: The timestamp of the point.
    Time string `json:"time,omitempty"`
    // Value: The value of the point.
    Value float64 `json:"value,omitempty"`
    // ForceSendFields is a list of field names (e.g. "Time") to unconditionally
    // include in API requests. By default, fields with empty or default values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "Time") to include in API requests
    // with the JSON null value. By default, fields with empty values are omitted
    // from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*Point) MarshalJSON ¶

func (s *Point) MarshalJSON() ([]byte, error)

func (*Point) UnmarshalJSON ¶

func (s *Point) UnmarshalJSON(data []byte) error

type Position ¶

Position: Position defines a position within a collection of data. The value can be either the end position, a key (used with ordered collections), a byte offset, or a record index.

type Position struct {
    // ByteOffset: Position is a byte offset.
    ByteOffset int64 `json:"byteOffset,omitempty,string"`
    // ConcatPosition: CloudPosition is a concat position.
    ConcatPosition *ConcatPosition `json:"concatPosition,omitempty"`
    // End: Position is past all other positions. Also useful for the end position
    // of an unbounded range.
    End bool `json:"end,omitempty"`
    // Key: Position is a string key, ordered lexicographically.
    Key string `json:"key,omitempty"`
    // RecordIndex: Position is a record index.
    RecordIndex int64 `json:"recordIndex,omitempty,string"`
    // ShufflePosition: CloudPosition is a base64 encoded BatchShufflePosition
    // (with FIXED sharding).
    ShufflePosition string `json:"shufflePosition,omitempty"`
    // ForceSendFields is a list of field names (e.g. "ByteOffset") to
    // unconditionally include in API requests. By default, fields with empty or
    // default values are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "ByteOffset") to include in API
    // requests with the JSON null value. By default, fields with empty values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*Position) MarshalJSON ¶

func (s *Position) MarshalJSON() ([]byte, error)

type ProgressTimeseries ¶

ProgressTimeseries: Information about the progress of some component of job execution.

type ProgressTimeseries struct {
    // CurrentProgress: The current progress of the component, in the range [0,1].
    CurrentProgress float64 `json:"currentProgress,omitempty"`
    // DataPoints: History of progress for the component. Points are sorted by
    // time.
    DataPoints []*Point `json:"dataPoints,omitempty"`
    // ForceSendFields is a list of field names (e.g. "CurrentProgress") to
    // unconditionally include in API requests. By default, fields with empty or
    // default values are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "CurrentProgress") to include in
    // API requests with the JSON null value. By default, fields with empty values
    // are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*ProgressTimeseries) MarshalJSON ¶

func (s *ProgressTimeseries) MarshalJSON() ([]byte, error)

func (*ProgressTimeseries) UnmarshalJSON ¶

func (s *ProgressTimeseries) UnmarshalJSON(data []byte) error

type ProjectsDeleteSnapshotsCall ¶

type ProjectsDeleteSnapshotsCall struct {
    // contains filtered or unexported fields
}

func (*ProjectsDeleteSnapshotsCall) Context ¶

func (c *ProjectsDeleteSnapshotsCall) Context(ctx context.Context) *ProjectsDeleteSnapshotsCall

Context sets the context to be used in this call's Do method.

func (*ProjectsDeleteSnapshotsCall) Do ¶

func (c *ProjectsDeleteSnapshotsCall) Do(opts ...googleapi.CallOption) (*DeleteSnapshotResponse, error)

Do executes the "dataflow.projects.deleteSnapshots" call. Any non-2xx status code is an error. Response headers are in either *DeleteSnapshotResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsDeleteSnapshotsCall) Fields ¶

func (c *ProjectsDeleteSnapshotsCall) Fields(s ...googleapi.Field) *ProjectsDeleteSnapshotsCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsDeleteSnapshotsCall) Header ¶

func (c *ProjectsDeleteSnapshotsCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsDeleteSnapshotsCall) Location ¶

func (c *ProjectsDeleteSnapshotsCall) Location(location string) *ProjectsDeleteSnapshotsCall

Location sets the optional parameter "location": The location that contains this snapshot.

func (*ProjectsDeleteSnapshotsCall) SnapshotId ¶

func (c *ProjectsDeleteSnapshotsCall) SnapshotId(snapshotId string) *ProjectsDeleteSnapshotsCall

SnapshotId sets the optional parameter "snapshotId": The ID of the snapshot.

type ProjectsJobsAggregatedCall ¶

type ProjectsJobsAggregatedCall struct {
    // contains filtered or unexported fields
}

func (*ProjectsJobsAggregatedCall) Context ¶

func (c *ProjectsJobsAggregatedCall) Context(ctx context.Context) *ProjectsJobsAggregatedCall

Context sets the context to be used in this call's Do method.

func (*ProjectsJobsAggregatedCall) Do ¶

func (c *ProjectsJobsAggregatedCall) Do(opts ...googleapi.CallOption) (*ListJobsResponse, error)

Do executes the "dataflow.projects.jobs.aggregated" call. Any non-2xx status code is an error. Response headers are in either *ListJobsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsJobsAggregatedCall) Fields ¶

func (c *ProjectsJobsAggregatedCall) Fields(s ...googleapi.Field) *ProjectsJobsAggregatedCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsJobsAggregatedCall) Filter ¶

func (c *ProjectsJobsAggregatedCall) Filter(filter string) *ProjectsJobsAggregatedCall

Filter sets the optional parameter "filter": The kind of filter to use.

Possible values:

"UNKNOWN" - The filter isn't specified, or is unknown. This returns all

jobs ordered on descending `JobUuid`.

"ALL" - Returns all running jobs first ordered on creation timestamp, then

returns all terminated jobs ordered on the termination timestamp.

"TERMINATED" - Filters the jobs that have a terminated state, ordered on

the termination timestamp. Example terminated states: `JOB_STATE_STOPPED`, `JOB_STATE_UPDATED`, `JOB_STATE_DRAINED`, etc.

"ACTIVE" - Filters the jobs that are running ordered on the creation

timestamp.

func (*ProjectsJobsAggregatedCall) Header ¶

func (c *ProjectsJobsAggregatedCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsJobsAggregatedCall) IfNoneMatch ¶

func (c *ProjectsJobsAggregatedCall) IfNoneMatch(entityTag string) *ProjectsJobsAggregatedCall

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*ProjectsJobsAggregatedCall) Location ¶

func (c *ProjectsJobsAggregatedCall) Location(location string) *ProjectsJobsAggregatedCall

Location sets the optional parameter "location": The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains this job.

func (*ProjectsJobsAggregatedCall) Name ¶

func (c *ProjectsJobsAggregatedCall) Name(name string) *ProjectsJobsAggregatedCall

Name sets the optional parameter "name": The job name.

func (*ProjectsJobsAggregatedCall) PageSize ¶

func (c *ProjectsJobsAggregatedCall) PageSize(pageSize int64) *ProjectsJobsAggregatedCall

PageSize sets the optional parameter "pageSize": 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.

func (*ProjectsJobsAggregatedCall) PageToken ¶

func (c *ProjectsJobsAggregatedCall) PageToken(pageToken string) *ProjectsJobsAggregatedCall

PageToken sets the optional parameter "pageToken": Set this to the 'next_page_token' field of a previous response to request additional results in a long list.

func (*ProjectsJobsAggregatedCall) Pages ¶

func (c *ProjectsJobsAggregatedCall) Pages(ctx context.Context, f func(*ListJobsResponse) error) error

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

func (*ProjectsJobsAggregatedCall) View ¶

func (c *ProjectsJobsAggregatedCall) View(view string) *ProjectsJobsAggregatedCall

View sets the optional parameter "view": Deprecated. ListJobs always returns summaries now. Use GetJob for other JobViews.

Possible values:

"JOB_VIEW_UNKNOWN" - The job view to return isn't specified, or is

unknown. Responses will contain at least the `JOB_VIEW_SUMMARY` information, and may contain additional information.

"JOB_VIEW_SUMMARY" - Request summary information only: Project ID, Job ID,

job name, job type, job status, start/end time, and Cloud SDK version details.

"JOB_VIEW_ALL" - Request all information available for this job. When the

job is in `JOB_STATE_PENDING`, the job has been created but is not yet running, and not all job information is available. For complete job information, wait until the job in is `JOB_STATE_RUNNING`. For more information, see [JobState](https://cloud.google.com/dataflow/docs/reference/rest/v1b3/project s.jobs#jobstate).

"JOB_VIEW_DESCRIPTION" - Request summary info and limited job description

data for steps, labels and environment.

type ProjectsJobsCreateCall ¶

type ProjectsJobsCreateCall struct {
    // contains filtered or unexported fields
}

func (*ProjectsJobsCreateCall) Context ¶

func (c *ProjectsJobsCreateCall) Context(ctx context.Context) *ProjectsJobsCreateCall

Context sets the context to be used in this call's Do method.

func (*ProjectsJobsCreateCall) Do ¶

func (c *ProjectsJobsCreateCall) Do(opts ...googleapi.CallOption) (*Job, error)

Do executes the "dataflow.projects.jobs.create" call. Any non-2xx status code is an error. Response headers are in either *Job.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsJobsCreateCall) Fields ¶

func (c *ProjectsJobsCreateCall) Fields(s ...googleapi.Field) *ProjectsJobsCreateCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsJobsCreateCall) Header ¶

func (c *ProjectsJobsCreateCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsJobsCreateCall) Location ¶

func (c *ProjectsJobsCreateCall) Location(location string) *ProjectsJobsCreateCall

Location sets the optional parameter "location": The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains this job.

func (*ProjectsJobsCreateCall) ReplaceJobId ¶

func (c *ProjectsJobsCreateCall) ReplaceJobId(replaceJobId string) *ProjectsJobsCreateCall

ReplaceJobId sets the optional parameter "replaceJobId": Deprecated. This field is now in the Job message.

func (*ProjectsJobsCreateCall) View ¶

func (c *ProjectsJobsCreateCall) View(view string) *ProjectsJobsCreateCall

View sets the optional parameter "view": The level of information requested in response.

Possible values:

"JOB_VIEW_UNKNOWN" - The job view to return isn't specified, or is

unknown. Responses will contain at least the `JOB_VIEW_SUMMARY` information, and may contain additional information.

"JOB_VIEW_SUMMARY" - Request summary information only: Project ID, Job ID,

job name, job type, job status, start/end time, and Cloud SDK version details.

"JOB_VIEW_ALL" - Request all information available for this job. When the

job is in `JOB_STATE_PENDING`, the job has been created but is not yet running, and not all job information is available. For complete job information, wait until the job in is `JOB_STATE_RUNNING`. For more information, see [JobState](https://cloud.google.com/dataflow/docs/reference/rest/v1b3/project s.jobs#jobstate).

"JOB_VIEW_DESCRIPTION" - Request summary info and limited job description

data for steps, labels and environment.

type ProjectsJobsDebugGetConfigCall ¶

type ProjectsJobsDebugGetConfigCall struct {
    // contains filtered or unexported fields
}

func (*ProjectsJobsDebugGetConfigCall) Context ¶

func (c *ProjectsJobsDebugGetConfigCall) Context(ctx context.Context) *ProjectsJobsDebugGetConfigCall

Context sets the context to be used in this call's Do method.

func (*ProjectsJobsDebugGetConfigCall) Do ¶

func (c *ProjectsJobsDebugGetConfigCall) Do(opts ...googleapi.CallOption) (*GetDebugConfigResponse, error)

Do executes the "dataflow.projects.jobs.debug.getConfig" call. Any non-2xx status code is an error. Response headers are in either *GetDebugConfigResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsJobsDebugGetConfigCall) Fields ¶

func (c *ProjectsJobsDebugGetConfigCall) Fields(s ...googleapi.Field) *ProjectsJobsDebugGetConfigCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsJobsDebugGetConfigCall) Header ¶

func (c *ProjectsJobsDebugGetConfigCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsJobsDebugSendCaptureCall ¶

type ProjectsJobsDebugSendCaptureCall struct {
    // contains filtered or unexported fields
}

func (*ProjectsJobsDebugSendCaptureCall) Context ¶

func (c *ProjectsJobsDebugSendCaptureCall) Context(ctx context.Context) *ProjectsJobsDebugSendCaptureCall

Context sets the context to be used in this call's Do method.

func (*ProjectsJobsDebugSendCaptureCall) Do ¶

func (c *ProjectsJobsDebugSendCaptureCall) Do(opts ...googleapi.CallOption) (*SendDebugCaptureResponse, error)

Do executes the "dataflow.projects.jobs.debug.sendCapture" call. Any non-2xx status code is an error. Response headers are in either *SendDebugCaptureResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsJobsDebugSendCaptureCall) Fields ¶

func (c *ProjectsJobsDebugSendCaptureCall) Fields(s ...googleapi.Field) *ProjectsJobsDebugSendCaptureCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsJobsDebugSendCaptureCall) Header ¶

func (c *ProjectsJobsDebugSendCaptureCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsJobsDebugService ¶

type ProjectsJobsDebugService struct {
    // contains filtered or unexported fields
}

func NewProjectsJobsDebugService ¶

func NewProjectsJobsDebugService(s *Service) *ProjectsJobsDebugService

func (*ProjectsJobsDebugService) GetConfig ¶

func (r *ProjectsJobsDebugService) GetConfig(projectId string, jobId string, getdebugconfigrequest *GetDebugConfigRequest) *ProjectsJobsDebugGetConfigCall

GetConfig: Get encoded debug configuration for component. Not cacheable.

- jobId: The job id. - projectId: The project id.

func (*ProjectsJobsDebugService) SendCapture ¶

func (r *ProjectsJobsDebugService) SendCapture(projectId string, jobId string, senddebugcapturerequest *SendDebugCaptureRequest) *ProjectsJobsDebugSendCaptureCall

SendCapture: Send encoded debug capture data for component.

- jobId: The job id. - projectId: The project id.

type ProjectsJobsGetCall ¶

type ProjectsJobsGetCall struct {
    // contains filtered or unexported fields
}

func (*ProjectsJobsGetCall) Context ¶

func (c *ProjectsJobsGetCall) Context(ctx context.Context) *ProjectsJobsGetCall

Context sets the context to be used in this call's Do method.

func (*ProjectsJobsGetCall) Do ¶

func (c *ProjectsJobsGetCall) Do(opts ...googleapi.CallOption) (*Job, error)

Do executes the "dataflow.projects.jobs.get" call. Any non-2xx status code is an error. Response headers are in either *Job.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsJobsGetCall) Fields ¶

func (c *ProjectsJobsGetCall) Fields(s ...googleapi.Field) *ProjectsJobsGetCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsJobsGetCall) Header ¶

func (c *ProjectsJobsGetCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsJobsGetCall) IfNoneMatch ¶

func (c *ProjectsJobsGetCall) IfNoneMatch(entityTag string) *ProjectsJobsGetCall

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*ProjectsJobsGetCall) Location ¶

func (c *ProjectsJobsGetCall) Location(location string) *ProjectsJobsGetCall

Location sets the optional parameter "location": The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains this job.

func (*ProjectsJobsGetCall) View ¶

func (c *ProjectsJobsGetCall) View(view string) *ProjectsJobsGetCall

View sets the optional parameter "view": The level of information requested in response.

Possible values:

"JOB_VIEW_UNKNOWN" - The job view to return isn't specified, or is

unknown. Responses will contain at least the `JOB_VIEW_SUMMARY` information, and may contain additional information.

"JOB_VIEW_SUMMARY" - Request summary information only: Project ID, Job ID,

job name, job type, job status, start/end time, and Cloud SDK version details.

"JOB_VIEW_ALL" - Request all information available for this job. When the

job is in `JOB_STATE_PENDING`, the job has been created but is not yet running, and not all job information is available. For complete job information, wait until the job in is `JOB_STATE_RUNNING`. For more information, see [JobState](https://cloud.google.com/dataflow/docs/reference/rest/v1b3/project s.jobs#jobstate).

"JOB_VIEW_DESCRIPTION" - Request summary info and limited job description

data for steps, labels and environment.

type ProjectsJobsGetMetricsCall ¶

type ProjectsJobsGetMetricsCall struct {
    // contains filtered or unexported fields
}

func (*ProjectsJobsGetMetricsCall) Context ¶

func (c *ProjectsJobsGetMetricsCall) Context(ctx context.Context) *ProjectsJobsGetMetricsCall

Context sets the context to be used in this call's Do method.

func (*ProjectsJobsGetMetricsCall) Do ¶

func (c *ProjectsJobsGetMetricsCall) Do(opts ...googleapi.CallOption) (*JobMetrics, error)

Do executes the "dataflow.projects.jobs.getMetrics" call. Any non-2xx status code is an error. Response headers are in either *JobMetrics.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsJobsGetMetricsCall) Fields ¶

func (c *ProjectsJobsGetMetricsCall) Fields(s ...googleapi.Field) *ProjectsJobsGetMetricsCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsJobsGetMetricsCall) Header ¶

func (c *ProjectsJobsGetMetricsCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsJobsGetMetricsCall) IfNoneMatch ¶

func (c *ProjectsJobsGetMetricsCall) IfNoneMatch(entityTag string) *ProjectsJobsGetMetricsCall

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*ProjectsJobsGetMetricsCall) Location ¶

func (c *ProjectsJobsGetMetricsCall) Location(location string) *ProjectsJobsGetMetricsCall

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

func (*ProjectsJobsGetMetricsCall) StartTime ¶

func (c *ProjectsJobsGetMetricsCall) StartTime(startTime string) *ProjectsJobsGetMetricsCall

StartTime sets the optional parameter "startTime": Return only metric data that has changed since this time. Default is to return all information about all metrics for the job.

type ProjectsJobsListCall ¶

type ProjectsJobsListCall struct {
    // contains filtered or unexported fields
}

func (*ProjectsJobsListCall) Context ¶

func (c *ProjectsJobsListCall) Context(ctx context.Context) *ProjectsJobsListCall

Context sets the context to be used in this call's Do method.

func (*ProjectsJobsListCall) Do ¶

func (c *ProjectsJobsListCall) Do(opts ...googleapi.CallOption) (*ListJobsResponse, error)

Do executes the "dataflow.projects.jobs.list" call. Any non-2xx status code is an error. Response headers are in either *ListJobsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsJobsListCall) Fields ¶

func (c *ProjectsJobsListCall) Fields(s ...googleapi.Field) *ProjectsJobsListCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsJobsListCall) Filter ¶

func (c *ProjectsJobsListCall) Filter(filter string) *ProjectsJobsListCall

Filter sets the optional parameter "filter": The kind of filter to use.

Possible values:

"UNKNOWN" - The filter isn't specified, or is unknown. This returns all

jobs ordered on descending `JobUuid`.

"ALL" - Returns all running jobs first ordered on creation timestamp, then

returns all terminated jobs ordered on the termination timestamp.

"TERMINATED" - Filters the jobs that have a terminated state, ordered on

the termination timestamp. Example terminated states: `JOB_STATE_STOPPED`, `JOB_STATE_UPDATED`, `JOB_STATE_DRAINED`, etc.

"ACTIVE" - Filters the jobs that are running ordered on the creation

timestamp.

func (*ProjectsJobsListCall) Header ¶

func (c *ProjectsJobsListCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsJobsListCall) IfNoneMatch ¶

func (c *ProjectsJobsListCall) IfNoneMatch(entityTag string) *ProjectsJobsListCall

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*ProjectsJobsListCall) Location ¶

func (c *ProjectsJobsListCall) Location(location string) *ProjectsJobsListCall

Location sets the optional parameter "location": The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains this job.

func (*ProjectsJobsListCall) Name ¶

func (c *ProjectsJobsListCall) Name(name string) *ProjectsJobsListCall

Name sets the optional parameter "name": The job name.

func (*ProjectsJobsListCall) PageSize ¶

func (c *ProjectsJobsListCall) PageSize(pageSize int64) *ProjectsJobsListCall

PageSize sets the optional parameter "pageSize": 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.

func (*ProjectsJobsListCall) PageToken ¶

func (c *ProjectsJobsListCall) PageToken(pageToken string) *ProjectsJobsListCall

PageToken sets the optional parameter "pageToken": Set this to the 'next_page_token' field of a previous response to request additional results in a long list.

func (*ProjectsJobsListCall) Pages ¶

func (c *ProjectsJobsListCall) Pages(ctx context.Context, f func(*ListJobsResponse) error) error

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

func (*ProjectsJobsListCall) View ¶

func (c *ProjectsJobsListCall) View(view string) *ProjectsJobsListCall

View sets the optional parameter "view": Deprecated. ListJobs always returns summaries now. Use GetJob for other JobViews.

Possible values:

"JOB_VIEW_UNKNOWN" - The job view to return isn't specified, or is

unknown. Responses will contain at least the `JOB_VIEW_SUMMARY` information, and may contain additional information.

"JOB_VIEW_SUMMARY" - Request summary information only: Project ID, Job ID,

job name, job type, job status, start/end time, and Cloud SDK version details.

"JOB_VIEW_ALL" - Request all information available for this job. When the

job is in `JOB_STATE_PENDING`, the job has been created but is not yet running, and not all job information is available. For complete job information, wait until the job in is `JOB_STATE_RUNNING`. For more information, see [JobState](https://cloud.google.com/dataflow/docs/reference/rest/v1b3/project s.jobs#jobstate).

"JOB_VIEW_DESCRIPTION" - Request summary info and limited job description

data for steps, labels and environment.

type ProjectsJobsMessagesListCall ¶

type ProjectsJobsMessagesListCall struct {
    // contains filtered or unexported fields
}

func (*ProjectsJobsMessagesListCall) Context ¶

func (c *ProjectsJobsMessagesListCall) Context(ctx context.Context) *ProjectsJobsMessagesListCall

Context sets the context to be used in this call's Do method.

func (*ProjectsJobsMessagesListCall) Do ¶

func (c *ProjectsJobsMessagesListCall) Do(opts ...googleapi.CallOption) (*ListJobMessagesResponse, error)

Do executes the "dataflow.projects.jobs.messages.list" call. Any non-2xx status code is an error. Response headers are in either *ListJobMessagesResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsJobsMessagesListCall) EndTime ¶

func (c *ProjectsJobsMessagesListCall) EndTime(endTime string) *ProjectsJobsMessagesListCall

EndTime sets the optional parameter "endTime": Return only messages with timestamps < end_time. The default is now (i.e. return up to the latest messages available).

func (*ProjectsJobsMessagesListCall) Fields ¶

func (c *ProjectsJobsMessagesListCall) Fields(s ...googleapi.Field) *ProjectsJobsMessagesListCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsJobsMessagesListCall) Header ¶

func (c *ProjectsJobsMessagesListCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsJobsMessagesListCall) IfNoneMatch ¶

func (c *ProjectsJobsMessagesListCall) IfNoneMatch(entityTag string) *ProjectsJobsMessagesListCall

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*ProjectsJobsMessagesListCall) Location ¶

func (c *ProjectsJobsMessagesListCall) Location(location string) *ProjectsJobsMessagesListCall

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

func (*ProjectsJobsMessagesListCall) MinimumImportance ¶

func (c *ProjectsJobsMessagesListCall) MinimumImportance(minimumImportance string) *ProjectsJobsMessagesListCall

MinimumImportance sets the optional parameter "minimumImportance": Filter to only get messages with importance >= level

Possible values:

"JOB_MESSAGE_IMPORTANCE_UNKNOWN" - The message importance isn't specified,

or is unknown.

"JOB_MESSAGE_DEBUG" - The message is at the 'debug' level: typically only

useful for software engineers working on the code the job is running. Typically, Dataflow pipeline runners do not display log messages at this level by default.

"JOB_MESSAGE_DETAILED" - The message is at the 'detailed' level: somewhat

verbose, but potentially useful to users. Typically, Dataflow pipeline runners do not display log messages at this level by default. These messages are displayed by default in the Dataflow monitoring UI.

"JOB_MESSAGE_BASIC" - The message is at the 'basic' level: useful for

keeping track of the execution of a Dataflow pipeline. Typically, Dataflow pipeline runners display log messages at this level by default, and these messages are displayed by default in the Dataflow monitoring UI.

"JOB_MESSAGE_WARNING" - The message is at the 'warning' level: indicating

a condition pertaining to a job which may require human intervention. Typically, Dataflow pipeline runners display log messages at this level by default, and these messages are displayed by default in the Dataflow monitoring UI.

"JOB_MESSAGE_ERROR" - The message is at the 'error' level: indicating a

condition preventing a job from succeeding. Typically, Dataflow pipeline runners display log messages at this level by default, and these messages are displayed by default in the Dataflow monitoring UI.

func (*ProjectsJobsMessagesListCall) PageSize ¶

func (c *ProjectsJobsMessagesListCall) PageSize(pageSize int64) *ProjectsJobsMessagesListCall

PageSize sets the optional parameter "pageSize": 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.

func (*ProjectsJobsMessagesListCall) PageToken ¶

func (c *ProjectsJobsMessagesListCall) PageToken(pageToken string) *ProjectsJobsMessagesListCall

PageToken sets the optional parameter "pageToken": 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.

func (*ProjectsJobsMessagesListCall) Pages ¶

func (c *ProjectsJobsMessagesListCall) Pages(ctx context.Context, f func(*ListJobMessagesResponse) error) error

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

func (*ProjectsJobsMessagesListCall) StartTime ¶

func (c *ProjectsJobsMessagesListCall) StartTime(startTime string) *ProjectsJobsMessagesListCall

StartTime sets the optional parameter "startTime": If specified, return only messages with timestamps >= start_time. The default is the job creation time (i.e. beginning of messages).

type ProjectsJobsMessagesService ¶

type ProjectsJobsMessagesService struct {
    // contains filtered or unexported fields
}

func NewProjectsJobsMessagesService ¶

func NewProjectsJobsMessagesService(s *Service) *ProjectsJobsMessagesService

func (*ProjectsJobsMessagesService) List ¶

func (r *ProjectsJobsMessagesService) List(projectId string, jobId string) *ProjectsJobsMessagesListCall

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

- jobId: The job to get messages about. - projectId: A project id.

type ProjectsJobsService ¶

type ProjectsJobsService struct {
    Debug *ProjectsJobsDebugService

    Messages *ProjectsJobsMessagesService

    WorkItems *ProjectsJobsWorkItemsService
    // contains filtered or unexported fields
}

func NewProjectsJobsService ¶

func NewProjectsJobsService(s *Service) *ProjectsJobsService

func (*ProjectsJobsService) Aggregated ¶

func (r *ProjectsJobsService) Aggregated(projectId string) *ProjectsJobsAggregatedCall

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

- projectId: The project which owns the jobs.

func (*ProjectsJobsService) Create ¶

func (r *ProjectsJobsService) Create(projectId string, job *Job) *ProjectsJobsCreateCall

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

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

func (*ProjectsJobsService) Get ¶

func (r *ProjectsJobsService) Get(projectId string, jobId string) *ProjectsJobsGetCall

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

- jobId: The job ID. - projectId: The ID of the Cloud Platform project that the job belongs to.

func (*ProjectsJobsService) GetMetrics ¶

func (r *ProjectsJobsService) GetMetrics(projectId string, jobId string) *ProjectsJobsGetMetricsCall

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

- jobId: The job to get metrics for. - projectId: A project id.

func (*ProjectsJobsService) List ¶

func (r *ProjectsJobsService) List(projectId string) *ProjectsJobsListCall

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

- projectId: The project which owns the jobs.

func (*ProjectsJobsService) Snapshot ¶

func (r *ProjectsJobsService) Snapshot(projectId string, jobId string, snapshotjobrequest *SnapshotJobRequest) *ProjectsJobsSnapshotCall

Snapshot: Snapshot the state of a streaming job.

- jobId: The job to be snapshotted. - projectId: The project which owns the job to be snapshotted.

func (*ProjectsJobsService) Update ¶

func (r *ProjectsJobsService) Update(projectId string, jobId string, job *Job) *ProjectsJobsUpdateCall

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

- jobId: The job ID. - projectId: The ID of the Cloud Platform project that the job belongs to.

type ProjectsJobsSnapshotCall ¶

type ProjectsJobsSnapshotCall struct {
    // contains filtered or unexported fields
}

func (*ProjectsJobsSnapshotCall) Context ¶

func (c *ProjectsJobsSnapshotCall) Context(ctx context.Context) *ProjectsJobsSnapshotCall

Context sets the context to be used in this call's Do method.

func (*ProjectsJobsSnapshotCall) Do ¶

func (c *ProjectsJobsSnapshotCall) Do(opts ...googleapi.CallOption) (*Snapshot, error)

Do executes the "dataflow.projects.jobs.snapshot" call. Any non-2xx status code is an error. Response headers are in either *Snapshot.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsJobsSnapshotCall) Fields ¶

func (c *ProjectsJobsSnapshotCall) Fields(s ...googleapi.Field) *ProjectsJobsSnapshotCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsJobsSnapshotCall) Header ¶

func (c *ProjectsJobsSnapshotCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsJobsUpdateCall ¶

type ProjectsJobsUpdateCall struct {
    // contains filtered or unexported fields
}

func (*ProjectsJobsUpdateCall) Context ¶

func (c *ProjectsJobsUpdateCall) Context(ctx context.Context) *ProjectsJobsUpdateCall

Context sets the context to be used in this call's Do method.

func (*ProjectsJobsUpdateCall) Do ¶

func (c *ProjectsJobsUpdateCall) Do(opts ...googleapi.CallOption) (*Job, error)

Do executes the "dataflow.projects.jobs.update" call. Any non-2xx status code is an error. Response headers are in either *Job.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsJobsUpdateCall) Fields ¶

func (c *ProjectsJobsUpdateCall) Fields(s ...googleapi.Field) *ProjectsJobsUpdateCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsJobsUpdateCall) Header ¶

func (c *ProjectsJobsUpdateCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsJobsUpdateCall) Location ¶

func (c *ProjectsJobsUpdateCall) Location(location string) *ProjectsJobsUpdateCall

Location sets the optional parameter "location": The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains this job.

func (*ProjectsJobsUpdateCall) UpdateMask ¶

func (c *ProjectsJobsUpdateCall) UpdateMask(updateMask string) *ProjectsJobsUpdateCall

UpdateMask sets the optional parameter "updateMask": The list of fields to update relative to Job. If empty, only RequestedJobState will be considered for update. If the FieldMask is not empty and RequestedJobState is none/empty, The fields specified in the update mask will be the only ones considered for update. If both RequestedJobState and update_mask are specified, an error will be returned as we cannot update both state and mask.

type ProjectsJobsWorkItemsLeaseCall ¶

type ProjectsJobsWorkItemsLeaseCall struct {
    // contains filtered or unexported fields
}

func (*ProjectsJobsWorkItemsLeaseCall) Context ¶

func (c *ProjectsJobsWorkItemsLeaseCall) Context(ctx context.Context) *ProjectsJobsWorkItemsLeaseCall

Context sets the context to be used in this call's Do method.

func (*ProjectsJobsWorkItemsLeaseCall) Do ¶

func (c *ProjectsJobsWorkItemsLeaseCall) Do(opts ...googleapi.CallOption) (*LeaseWorkItemResponse, error)

Do executes the "dataflow.projects.jobs.workItems.lease" call. Any non-2xx status code is an error. Response headers are in either *LeaseWorkItemResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsJobsWorkItemsLeaseCall) Fields ¶

func (c *ProjectsJobsWorkItemsLeaseCall) Fields(s ...googleapi.Field) *ProjectsJobsWorkItemsLeaseCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsJobsWorkItemsLeaseCall) Header ¶

func (c *ProjectsJobsWorkItemsLeaseCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsJobsWorkItemsReportStatusCall ¶

type ProjectsJobsWorkItemsReportStatusCall struct {
    // contains filtered or unexported fields
}

func (*ProjectsJobsWorkItemsReportStatusCall) Context ¶

func (c *ProjectsJobsWorkItemsReportStatusCall) Context(ctx context.Context) *ProjectsJobsWorkItemsReportStatusCall

Context sets the context to be used in this call's Do method.

func (*ProjectsJobsWorkItemsReportStatusCall) Do ¶

func (c *ProjectsJobsWorkItemsReportStatusCall) Do(opts ...googleapi.CallOption) (*ReportWorkItemStatusResponse, error)

Do executes the "dataflow.projects.jobs.workItems.reportStatus" call. Any non-2xx status code is an error. Response headers are in either *ReportWorkItemStatusResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsJobsWorkItemsReportStatusCall) Fields ¶

func (c *ProjectsJobsWorkItemsReportStatusCall) Fields(s ...googleapi.Field) *ProjectsJobsWorkItemsReportStatusCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsJobsWorkItemsReportStatusCall) Header ¶

func (c *ProjectsJobsWorkItemsReportStatusCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsJobsWorkItemsService ¶

type ProjectsJobsWorkItemsService struct {
    // contains filtered or unexported fields
}

func NewProjectsJobsWorkItemsService ¶

func NewProjectsJobsWorkItemsService(s *Service) *ProjectsJobsWorkItemsService

func (*ProjectsJobsWorkItemsService) Lease ¶

func (r *ProjectsJobsWorkItemsService) Lease(projectId string, jobId string, leaseworkitemrequest *LeaseWorkItemRequest) *ProjectsJobsWorkItemsLeaseCall

Lease: Leases a dataflow WorkItem to run.

- jobId: Identifies the workflow job this worker belongs to. - projectId: Identifies the project this worker belongs to.

func (*ProjectsJobsWorkItemsService) ReportStatus ¶

func (r *ProjectsJobsWorkItemsService) ReportStatus(projectId string, jobId string, reportworkitemstatusrequest *ReportWorkItemStatusRequest) *ProjectsJobsWorkItemsReportStatusCall

ReportStatus: Reports the status of dataflow WorkItems leased by a worker.

- jobId: The job which the WorkItem is part of. - projectId: The project which owns the WorkItem's job.

type ProjectsLocationsFlexTemplatesLaunchCall ¶

type ProjectsLocationsFlexTemplatesLaunchCall struct {
    // contains filtered or unexported fields
}

func (*ProjectsLocationsFlexTemplatesLaunchCall) Context ¶

func (c *ProjectsLocationsFlexTemplatesLaunchCall) Context(ctx context.Context) *ProjectsLocationsFlexTemplatesLaunchCall

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsFlexTemplatesLaunchCall) Do ¶

func (c *ProjectsLocationsFlexTemplatesLaunchCall) Do(opts ...googleapi.CallOption) (*LaunchFlexTemplateResponse, error)

Do executes the "dataflow.projects.locations.flexTemplates.launch" call. Any non-2xx status code is an error. Response headers are in either *LaunchFlexTemplateResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsFlexTemplatesLaunchCall) Fields ¶

func (c *ProjectsLocationsFlexTemplatesLaunchCall) Fields(s ...googleapi.Field) *ProjectsLocationsFlexTemplatesLaunchCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsFlexTemplatesLaunchCall) Header ¶

func (c *ProjectsLocationsFlexTemplatesLaunchCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsFlexTemplatesService ¶

type ProjectsLocationsFlexTemplatesService struct {
    // contains filtered or unexported fields
}

func NewProjectsLocationsFlexTemplatesService ¶

func NewProjectsLocationsFlexTemplatesService(s *Service) *ProjectsLocationsFlexTemplatesService

func (*ProjectsLocationsFlexTemplatesService) Launch ¶

func (r *ProjectsLocationsFlexTemplatesService) Launch(projectId string, location string, launchflextemplaterequest *LaunchFlexTemplateRequest) *ProjectsLocationsFlexTemplatesLaunchCall

Launch: Launch a job with a FlexTemplate.

• location: The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) to which to direct the request. E.g., us-central1, us-west1.
• projectId: The ID of the Cloud Platform project that the job belongs to.

type ProjectsLocationsJobsCreateCall ¶

type ProjectsLocationsJobsCreateCall struct {
    // contains filtered or unexported fields
}

func (*ProjectsLocationsJobsCreateCall) Context ¶

func (c *ProjectsLocationsJobsCreateCall) Context(ctx context.Context) *ProjectsLocationsJobsCreateCall

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsJobsCreateCall) Do ¶

func (c *ProjectsLocationsJobsCreateCall) Do(opts ...googleapi.CallOption) (*Job, error)

Do executes the "dataflow.projects.locations.jobs.create" call. Any non-2xx status code is an error. Response headers are in either *Job.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsJobsCreateCall) Fields ¶

func (c *ProjectsLocationsJobsCreateCall) Fields(s ...googleapi.Field) *ProjectsLocationsJobsCreateCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsJobsCreateCall) Header ¶

func (c *ProjectsLocationsJobsCreateCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsJobsCreateCall) ReplaceJobId ¶

func (c *ProjectsLocationsJobsCreateCall) ReplaceJobId(replaceJobId string) *ProjectsLocationsJobsCreateCall

ReplaceJobId sets the optional parameter "replaceJobId": Deprecated. This field is now in the Job message.

func (*ProjectsLocationsJobsCreateCall) View ¶

func (c *ProjectsLocationsJobsCreateCall) View(view string) *ProjectsLocationsJobsCreateCall

View sets the optional parameter "view": The level of information requested in response.

Possible values:

"JOB_VIEW_UNKNOWN" - The job view to return isn't specified, or is

unknown. Responses will contain at least the `JOB_VIEW_SUMMARY` information, and may contain additional information.

"JOB_VIEW_SUMMARY" - Request summary information only: Project ID, Job ID,

job name, job type, job status, start/end time, and Cloud SDK version details.

"JOB_VIEW_ALL" - Request all information available for this job. When the

job is in `JOB_STATE_PENDING`, the job has been created but is not yet running, and not all job information is available. For complete job information, wait until the job in is `JOB_STATE_RUNNING`. For more information, see [JobState](https://cloud.google.com/dataflow/docs/reference/rest/v1b3/project s.jobs#jobstate).

"JOB_VIEW_DESCRIPTION" - Request summary info and limited job description

data for steps, labels and environment.

type ProjectsLocationsJobsDebugGetConfigCall ¶

type ProjectsLocationsJobsDebugGetConfigCall struct {
    // contains filtered or unexported fields
}

func (*ProjectsLocationsJobsDebugGetConfigCall) Context ¶

func (c *ProjectsLocationsJobsDebugGetConfigCall) Context(ctx context.Context) *ProjectsLocationsJobsDebugGetConfigCall

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsJobsDebugGetConfigCall) Do ¶

func (c *ProjectsLocationsJobsDebugGetConfigCall) Do(opts ...googleapi.CallOption) (*GetDebugConfigResponse, error)

Do executes the "dataflow.projects.locations.jobs.debug.getConfig" call. Any non-2xx status code is an error. Response headers are in either *GetDebugConfigResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsJobsDebugGetConfigCall) Fields ¶

func (c *ProjectsLocationsJobsDebugGetConfigCall) Fields(s ...googleapi.Field) *ProjectsLocationsJobsDebugGetConfigCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsJobsDebugGetConfigCall) Header ¶

func (c *ProjectsLocationsJobsDebugGetConfigCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsJobsDebugSendCaptureCall ¶

type ProjectsLocationsJobsDebugSendCaptureCall struct {
    // contains filtered or unexported fields
}

func (*ProjectsLocationsJobsDebugSendCaptureCall) Context ¶

func (c *ProjectsLocationsJobsDebugSendCaptureCall) Context(ctx context.Context) *ProjectsLocationsJobsDebugSendCaptureCall

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsJobsDebugSendCaptureCall) Do ¶

func (c *ProjectsLocationsJobsDebugSendCaptureCall) Do(opts ...googleapi.CallOption) (*SendDebugCaptureResponse, error)

Do executes the "dataflow.projects.locations.jobs.debug.sendCapture" call. Any non-2xx status code is an error. Response headers are in either *SendDebugCaptureResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsJobsDebugSendCaptureCall) Fields ¶

func (c *ProjectsLocationsJobsDebugSendCaptureCall) Fields(s ...googleapi.Field) *ProjectsLocationsJobsDebugSendCaptureCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsJobsDebugSendCaptureCall) Header ¶

func (c *ProjectsLocationsJobsDebugSendCaptureCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsJobsDebugService ¶

type ProjectsLocationsJobsDebugService struct {
    // contains filtered or unexported fields
}

func NewProjectsLocationsJobsDebugService ¶

func NewProjectsLocationsJobsDebugService(s *Service) *ProjectsLocationsJobsDebugService

func (*ProjectsLocationsJobsDebugService) GetConfig ¶

func (r *ProjectsLocationsJobsDebugService) GetConfig(projectId string, location string, jobId string, getdebugconfigrequest *GetDebugConfigRequest) *ProjectsLocationsJobsDebugGetConfigCall

GetConfig: Get encoded debug configuration for component. Not cacheable.

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

func (*ProjectsLocationsJobsDebugService) SendCapture ¶

func (r *ProjectsLocationsJobsDebugService) SendCapture(projectId string, location string, jobId string, senddebugcapturerequest *SendDebugCaptureRequest) *ProjectsLocationsJobsDebugSendCaptureCall

SendCapture: Send encoded debug capture data for component.

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

type ProjectsLocationsJobsGetCall ¶

type ProjectsLocationsJobsGetCall struct {
    // contains filtered or unexported fields
}

func (*ProjectsLocationsJobsGetCall) Context ¶

func (c *ProjectsLocationsJobsGetCall) Context(ctx context.Context) *ProjectsLocationsJobsGetCall

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsJobsGetCall) Do ¶

func (c *ProjectsLocationsJobsGetCall) Do(opts ...googleapi.CallOption) (*Job, error)

Do executes the "dataflow.projects.locations.jobs.get" call. Any non-2xx status code is an error. Response headers are in either *Job.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsJobsGetCall) Fields ¶

func (c *ProjectsLocationsJobsGetCall) Fields(s ...googleapi.Field) *ProjectsLocationsJobsGetCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsJobsGetCall) Header ¶

func (c *ProjectsLocationsJobsGetCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsJobsGetCall) IfNoneMatch ¶

func (c *ProjectsLocationsJobsGetCall) IfNoneMatch(entityTag string) *ProjectsLocationsJobsGetCall

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*ProjectsLocationsJobsGetCall) View ¶

func (c *ProjectsLocationsJobsGetCall) View(view string) *ProjectsLocationsJobsGetCall

View sets the optional parameter "view": The level of information requested in response.

Possible values:

"JOB_VIEW_UNKNOWN" - The job view to return isn't specified, or is

unknown. Responses will contain at least the `JOB_VIEW_SUMMARY` information, and may contain additional information.

"JOB_VIEW_SUMMARY" - Request summary information only: Project ID, Job ID,

job name, job type, job status, start/end time, and Cloud SDK version details.

"JOB_VIEW_ALL" - Request all information available for this job. When the

job is in `JOB_STATE_PENDING`, the job has been created but is not yet running, and not all job information is available. For complete job information, wait until the job in is `JOB_STATE_RUNNING`. For more information, see [JobState](https://cloud.google.com/dataflow/docs/reference/rest/v1b3/project s.jobs#jobstate).

"JOB_VIEW_DESCRIPTION" - Request summary info and limited job description

data for steps, labels and environment.

type ProjectsLocationsJobsGetExecutionDetailsCall ¶

type ProjectsLocationsJobsGetExecutionDetailsCall struct {
    // contains filtered or unexported fields
}

func (*ProjectsLocationsJobsGetExecutionDetailsCall) Context ¶

func (c *ProjectsLocationsJobsGetExecutionDetailsCall) Context(ctx context.Context) *ProjectsLocationsJobsGetExecutionDetailsCall

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsJobsGetExecutionDetailsCall) Do ¶

func (c *ProjectsLocationsJobsGetExecutionDetailsCall) Do(opts ...googleapi.CallOption) (*JobExecutionDetails, error)

Do executes the "dataflow.projects.locations.jobs.getExecutionDetails" call. Any non-2xx status code is an error. Response headers are in either *JobExecutionDetails.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsJobsGetExecutionDetailsCall) Fields ¶

func (c *ProjectsLocationsJobsGetExecutionDetailsCall) Fields(s ...googleapi.Field) *ProjectsLocationsJobsGetExecutionDetailsCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsJobsGetExecutionDetailsCall) Header ¶

func (c *ProjectsLocationsJobsGetExecutionDetailsCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsJobsGetExecutionDetailsCall) IfNoneMatch ¶

func (c *ProjectsLocationsJobsGetExecutionDetailsCall) IfNoneMatch(entityTag string) *ProjectsLocationsJobsGetExecutionDetailsCall

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*ProjectsLocationsJobsGetExecutionDetailsCall) PageSize ¶

func (c *ProjectsLocationsJobsGetExecutionDetailsCall) PageSize(pageSize int64) *ProjectsLocationsJobsGetExecutionDetailsCall

PageSize sets the optional parameter "pageSize": If specified, determines the maximum number of stages to return. If unspecified, the service may choose an appropriate default, or may return an arbitrarily large number of results.

func (*ProjectsLocationsJobsGetExecutionDetailsCall) PageToken ¶

func (c *ProjectsLocationsJobsGetExecutionDetailsCall) PageToken(pageToken string) *ProjectsLocationsJobsGetExecutionDetailsCall

PageToken sets the optional parameter "pageToken": 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.

func (*ProjectsLocationsJobsGetExecutionDetailsCall) Pages ¶

func (c *ProjectsLocationsJobsGetExecutionDetailsCall) Pages(ctx context.Context, f func(*JobExecutionDetails) error) error

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type ProjectsLocationsJobsGetMetricsCall ¶

type ProjectsLocationsJobsGetMetricsCall struct {
    // contains filtered or unexported fields
}

func (*ProjectsLocationsJobsGetMetricsCall) Context ¶

func (c *ProjectsLocationsJobsGetMetricsCall) Context(ctx context.Context) *ProjectsLocationsJobsGetMetricsCall

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsJobsGetMetricsCall) Do ¶

func (c *ProjectsLocationsJobsGetMetricsCall) Do(opts ...googleapi.CallOption) (*JobMetrics, error)

Do executes the "dataflow.projects.locations.jobs.getMetrics" call. Any non-2xx status code is an error. Response headers are in either *JobMetrics.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsJobsGetMetricsCall) Fields ¶

func (c *ProjectsLocationsJobsGetMetricsCall) Fields(s ...googleapi.Field) *ProjectsLocationsJobsGetMetricsCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsJobsGetMetricsCall) Header ¶

func (c *ProjectsLocationsJobsGetMetricsCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsJobsGetMetricsCall) IfNoneMatch ¶

func (c *ProjectsLocationsJobsGetMetricsCall) IfNoneMatch(entityTag string) *ProjectsLocationsJobsGetMetricsCall

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*ProjectsLocationsJobsGetMetricsCall) StartTime ¶

func (c *ProjectsLocationsJobsGetMetricsCall) StartTime(startTime string) *ProjectsLocationsJobsGetMetricsCall

StartTime sets the optional parameter "startTime": Return only metric data that has changed since this time. Default is to return all information about all metrics for the job.

type ProjectsLocationsJobsListCall ¶

type ProjectsLocationsJobsListCall struct {
    // contains filtered or unexported fields
}

func (*ProjectsLocationsJobsListCall) Context ¶

func (c *ProjectsLocationsJobsListCall) Context(ctx context.Context) *ProjectsLocationsJobsListCall

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsJobsListCall) Do ¶

func (c *ProjectsLocationsJobsListCall) Do(opts ...googleapi.CallOption) (*ListJobsResponse, error)

Do executes the "dataflow.projects.locations.jobs.list" call. Any non-2xx status code is an error. Response headers are in either *ListJobsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsJobsListCall) Fields ¶

func (c *ProjectsLocationsJobsListCall) Fields(s ...googleapi.Field) *ProjectsLocationsJobsListCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsJobsListCall) Filter ¶

func (c *ProjectsLocationsJobsListCall) Filter(filter string) *ProjectsLocationsJobsListCall

Filter sets the optional parameter "filter": The kind of filter to use.

Possible values:

"UNKNOWN" - The filter isn't specified, or is unknown. This returns all

jobs ordered on descending `JobUuid`.

"ALL" - Returns all running jobs first ordered on creation timestamp, then

returns all terminated jobs ordered on the termination timestamp.

"TERMINATED" - Filters the jobs that have a terminated state, ordered on

the termination timestamp. Example terminated states: `JOB_STATE_STOPPED`, `JOB_STATE_UPDATED`, `JOB_STATE_DRAINED`, etc.

"ACTIVE" - Filters the jobs that are running ordered on the creation

timestamp.

func (*ProjectsLocationsJobsListCall) Header ¶

func (c *ProjectsLocationsJobsListCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsJobsListCall) IfNoneMatch ¶

func (c *ProjectsLocationsJobsListCall) IfNoneMatch(entityTag string) *ProjectsLocationsJobsListCall

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*ProjectsLocationsJobsListCall) Name ¶

func (c *ProjectsLocationsJobsListCall) Name(name string) *ProjectsLocationsJobsListCall

Name sets the optional parameter "name": The job name.

func (*ProjectsLocationsJobsListCall) PageSize ¶

func (c *ProjectsLocationsJobsListCall) PageSize(pageSize int64) *ProjectsLocationsJobsListCall

PageSize sets the optional parameter "pageSize": 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.

func (*ProjectsLocationsJobsListCall) PageToken ¶

func (c *ProjectsLocationsJobsListCall) PageToken(pageToken string) *ProjectsLocationsJobsListCall

PageToken sets the optional parameter "pageToken": Set this to the 'next_page_token' field of a previous response to request additional results in a long list.

func (*ProjectsLocationsJobsListCall) Pages ¶

func (c *ProjectsLocationsJobsListCall) Pages(ctx context.Context, f func(*ListJobsResponse) error) error

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

func (*ProjectsLocationsJobsListCall) View ¶

func (c *ProjectsLocationsJobsListCall) View(view string) *ProjectsLocationsJobsListCall

View sets the optional parameter "view": Deprecated. ListJobs always returns summaries now. Use GetJob for other JobViews.

Possible values:

"JOB_VIEW_UNKNOWN" - The job view to return isn't specified, or is

unknown. Responses will contain at least the `JOB_VIEW_SUMMARY` information, and may contain additional information.

"JOB_VIEW_SUMMARY" - Request summary information only: Project ID, Job ID,

job name, job type, job status, start/end time, and Cloud SDK version details.

"JOB_VIEW_ALL" - Request all information available for this job. When the

job is in `JOB_STATE_PENDING`, the job has been created but is not yet running, and not all job information is available. For complete job information, wait until the job in is `JOB_STATE_RUNNING`. For more information, see [JobState](https://cloud.google.com/dataflow/docs/reference/rest/v1b3/project s.jobs#jobstate).

"JOB_VIEW_DESCRIPTION" - Request summary info and limited job description

data for steps, labels and environment.

type ProjectsLocationsJobsMessagesListCall ¶

type ProjectsLocationsJobsMessagesListCall struct {
    // contains filtered or unexported fields
}

func (*ProjectsLocationsJobsMessagesListCall) Context ¶

func (c *ProjectsLocationsJobsMessagesListCall) Context(ctx context.Context) *ProjectsLocationsJobsMessagesListCall

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsJobsMessagesListCall) Do ¶

func (c *ProjectsLocationsJobsMessagesListCall) Do(opts ...googleapi.CallOption) (*ListJobMessagesResponse, error)

Do executes the "dataflow.projects.locations.jobs.messages.list" call. Any non-2xx status code is an error. Response headers are in either *ListJobMessagesResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsJobsMessagesListCall) EndTime ¶

func (c *ProjectsLocationsJobsMessagesListCall) EndTime(endTime string) *ProjectsLocationsJobsMessagesListCall

EndTime sets the optional parameter "endTime": Return only messages with timestamps < end_time. The default is now (i.e. return up to the latest messages available).

func (*ProjectsLocationsJobsMessagesListCall) Fields ¶

func (c *ProjectsLocationsJobsMessagesListCall) Fields(s ...googleapi.Field) *ProjectsLocationsJobsMessagesListCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsJobsMessagesListCall) Header ¶

func (c *ProjectsLocationsJobsMessagesListCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsJobsMessagesListCall) IfNoneMatch ¶

func (c *ProjectsLocationsJobsMessagesListCall) IfNoneMatch(entityTag string) *ProjectsLocationsJobsMessagesListCall

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*ProjectsLocationsJobsMessagesListCall) MinimumImportance ¶

func (c *ProjectsLocationsJobsMessagesListCall) MinimumImportance(minimumImportance string) *ProjectsLocationsJobsMessagesListCall

MinimumImportance sets the optional parameter "minimumImportance": Filter to only get messages with importance >= level

Possible values:

"JOB_MESSAGE_IMPORTANCE_UNKNOWN" - The message importance isn't specified,

or is unknown.

"JOB_MESSAGE_DEBUG" - The message is at the 'debug' level: typically only

useful for software engineers working on the code the job is running. Typically, Dataflow pipeline runners do not display log messages at this level by default.

"JOB_MESSAGE_DETAILED" - The message is at the 'detailed' level: somewhat

verbose, but potentially useful to users. Typically, Dataflow pipeline runners do not display log messages at this level by default. These messages are displayed by default in the Dataflow monitoring UI.

"JOB_MESSAGE_BASIC" - The message is at the 'basic' level: useful for

keeping track of the execution of a Dataflow pipeline. Typically, Dataflow pipeline runners display log messages at this level by default, and these messages are displayed by default in the Dataflow monitoring UI.

"JOB_MESSAGE_WARNING" - The message is at the 'warning' level: indicating

a condition pertaining to a job which may require human intervention. Typically, Dataflow pipeline runners display log messages at this level by default, and these messages are displayed by default in the Dataflow monitoring UI.

"JOB_MESSAGE_ERROR" - The message is at the 'error' level: indicating a

condition preventing a job from succeeding. Typically, Dataflow pipeline runners display log messages at this level by default, and these messages are displayed by default in the Dataflow monitoring UI.

func (*ProjectsLocationsJobsMessagesListCall) PageSize ¶

func (c *ProjectsLocationsJobsMessagesListCall) PageSize(pageSize int64) *ProjectsLocationsJobsMessagesListCall

PageSize sets the optional parameter "pageSize": 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.

func (*ProjectsLocationsJobsMessagesListCall) PageToken ¶

func (c *ProjectsLocationsJobsMessagesListCall) PageToken(pageToken string) *ProjectsLocationsJobsMessagesListCall

PageToken sets the optional parameter "pageToken": 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.

func (*ProjectsLocationsJobsMessagesListCall) Pages ¶

func (c *ProjectsLocationsJobsMessagesListCall) Pages(ctx context.Context, f func(*ListJobMessagesResponse) error) error

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

func (*ProjectsLocationsJobsMessagesListCall) StartTime ¶

func (c *ProjectsLocationsJobsMessagesListCall) StartTime(startTime string) *ProjectsLocationsJobsMessagesListCall

StartTime sets the optional parameter "startTime": If specified, return only messages with timestamps >= start_time. The default is the job creation time (i.e. beginning of messages).

type ProjectsLocationsJobsMessagesService ¶

type ProjectsLocationsJobsMessagesService struct {
    // contains filtered or unexported fields
}

func NewProjectsLocationsJobsMessagesService ¶

func NewProjectsLocationsJobsMessagesService(s *Service) *ProjectsLocationsJobsMessagesService

func (*ProjectsLocationsJobsMessagesService) List ¶

func (r *ProjectsLocationsJobsMessagesService) List(projectId string, location string, jobId string) *ProjectsLocationsJobsMessagesListCall

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

• jobId: The job to get messages about.
• location: The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains the job specified by job_id.
• projectId: A project id.

type ProjectsLocationsJobsService ¶

type ProjectsLocationsJobsService struct {
    Debug *ProjectsLocationsJobsDebugService

    Messages *ProjectsLocationsJobsMessagesService

    Snapshots *ProjectsLocationsJobsSnapshotsService

    Stages *ProjectsLocationsJobsStagesService

    WorkItems *ProjectsLocationsJobsWorkItemsService
    // contains filtered or unexported fields
}

func NewProjectsLocationsJobsService ¶

func NewProjectsLocationsJobsService(s *Service) *ProjectsLocationsJobsService

func (*ProjectsLocationsJobsService) Create ¶

func (r *ProjectsLocationsJobsService) Create(projectId string, location string, job *Job) *ProjectsLocationsJobsCreateCall