dataflow

package
v0.198.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Sep 19, 2024 License: BSD-3-Clause Imports: 16 Imported by: 89

Documentation

Overview

Package dataflow provides access to the Dataflow API.

For product documentation, see: https://cloud.google.com/dataflow

Library status

These client libraries are officially supported by Google. However, this library is considered complete and is in maintenance mode. This means that we will address critical bugs and security issues but will not add any new features.

When possible, we recommend using our newer [Cloud Client Libraries for Go](https://pkg.go.dev/cloud.google.com/go) that are still actively being worked and iterated on.

Creating a client

Usage example: 

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

In this example, Google Application Default Credentials are used for authentication. For information on how to create and obtain Application Default Credentials, see https://developers.google.com/identity/protocols/application-default-credentials.

Other authentication options

By default, all available scopes (see "Constants") are used to authenticate. To restrict scopes, use google.golang.org/api/option.WithScopes: 

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

To use an API key for authentication (note: some APIs do not support API keys), use google.golang.org/api/option.WithAPIKey: 

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

To use an OAuth token (e.g., a user token obtained via a three-legged OAuth flow, use google.golang.org/api/option.WithTokenSource: 

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

See google.golang.org/api/option.ClientOption for details on options.

Index

Constants

View Source 
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"
)

OAuth2 scopes used by this API.

Variables

This section is empty.

Functions

This section is empty.

Types

type ApproximateProgress 

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:"-"`
}

ApproximateProgress: Obsolete in favor of ApproximateReportedProgress and ApproximateSplitRequest.

func (ApproximateProgress) MarshalJSON 

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

func (*ApproximateProgress) UnmarshalJSON 

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

type ApproximateReportedProgress 

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:"-"`
}

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

func (ApproximateReportedProgress) MarshalJSON 

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

func (*ApproximateReportedProgress) UnmarshalJSON 

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

type ApproximateSplitRequest 

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:"-"`
}

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

func (ApproximateSplitRequest) MarshalJSON 

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

func (*ApproximateSplitRequest) UnmarshalJSON 

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

type AutoscalingEvent 

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:"-"`
}

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

func (AutoscalingEvent) MarshalJSON 

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

type AutoscalingSettings 

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:"-"`
}

AutoscalingSettings: Settings for WorkerPool autoscaling.

func (AutoscalingSettings) MarshalJSON 

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

type Base2Exponent added in v0.156.0 

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:"-"`
}

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))

func (Base2Exponent) MarshalJSON added in v0.156.0 

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

type BigQueryIODetails 

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:"-"`
}

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

func (BigQueryIODetails) MarshalJSON 

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

type BigTableIODetails 

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:"-"`
}

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

func (BigTableIODetails) MarshalJSON 

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

type BucketOptions added in v0.156.0 

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:"-"`
}

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

func (BucketOptions) MarshalJSON added in v0.156.0 

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

type CPUTime 

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:"-"`
}

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

func (CPUTime) MarshalJSON 

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

func (*CPUTime) UnmarshalJSON 

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

type ComponentSource 

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:"-"`
}

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

func (ComponentSource) MarshalJSON 

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

type ComponentTransform 

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:"-"`
}

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

func (ComponentTransform) MarshalJSON 

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

type ComputationTopology 

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:"-"`
}

ComputationTopology: All configuration data for a particular Computation.

func (ComputationTopology) MarshalJSON 

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

type ConcatPosition 

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:"-"`
}

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.

func (ConcatPosition) MarshalJSON 

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

type ContainerSpec added in v0.16.0 

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:"-"`
}

ContainerSpec: Container Spec.

func (ContainerSpec) MarshalJSON added in v0.16.0 

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

type CounterMetadata 

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:"-"`
}

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

func (CounterMetadata) MarshalJSON 

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

type CounterStructuredName 

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:"-"`
}

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.

func (CounterStructuredName) MarshalJSON 

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

type CounterStructuredNameAndMetadata 

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:"-"`
}

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

func (CounterStructuredNameAndMetadata) MarshalJSON 

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

type CounterUpdate 

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:"-"`
}

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

func (CounterUpdate) MarshalJSON 

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

func (*CounterUpdate) UnmarshalJSON 

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

type CreateJobFromTemplateRequest 

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:"-"`
}

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

func (CreateJobFromTemplateRequest) MarshalJSON 

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

type CustomSourceLocation 

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:"-"`
}

CustomSourceLocation: Identifies the location of a custom souce.

func (CustomSourceLocation) MarshalJSON 

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

type DataDiskAssignment 

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:"-"`
}

DataDiskAssignment: Data disk assignment for a given VM instance.

func (DataDiskAssignment) MarshalJSON 

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

type DataSamplingConfig added in v0.135.0 

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:"-"`
}

DataSamplingConfig: Configuration options for sampling elements.

func (DataSamplingConfig) MarshalJSON added in v0.135.0 

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

type DataSamplingReport added in v0.135.0 

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:"-"`
}

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

func (DataSamplingReport) MarshalJSON added in v0.135.0 

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

type DataflowHistogramValue added in v0.156.0 

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:"-"`
}

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.

func (DataflowHistogramValue) MarshalJSON added in v0.156.0 

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

type DatastoreIODetails 

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:"-"`
}

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

func (DatastoreIODetails) MarshalJSON 

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

type DebugOptions added in v0.42.0 

type DebugOptions struct {
	// DataSampling: Configuration options for sampling elements from a running
	// pipeline.
	DataSampling *DataSamplingConfig `json:"dataSampling,omitempty"`
	// EnableHotKeyLogging: Optional. 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:"-"`
}

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

func (DebugOptions) MarshalJSON added in v0.42.0 

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

type DeleteSnapshotResponse added in v0.5.0 

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

DeleteSnapshotResponse: Response from deleting a snapshot.

type DerivedSource 

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:"-"`
}

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.

func (DerivedSource) MarshalJSON 

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

type Disk 

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:"-"`
}

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

func (Disk) MarshalJSON 

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

type DisplayData 

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:"-"`
}

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

func (DisplayData) MarshalJSON 

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

func (*DisplayData) UnmarshalJSON 

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

type DistributionUpdate 

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:"-"`
}

DistributionUpdate: A metric value representing a distribution.

func (DistributionUpdate) MarshalJSON 

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

func (*DistributionUpdate) UnmarshalJSON 

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

type DynamicSourceSplit 

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:"-"`
}

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.

func (DynamicSourceSplit) MarshalJSON 

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

type Environment 

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: Optional. 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: Optional. 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: Optional. 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: Optional. Identity to run virtual machines as. Defaults
	// to the default account.
	ServiceAccountEmail string `json:"serviceAccountEmail,omitempty"`
	// ServiceKmsKeyName: Optional. 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: Optional. 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: Optional. 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:"-"`
}

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

func (Environment) MarshalJSON 

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

type ExecutionStageState 

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:"-"`
}

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

func (ExecutionStageState) MarshalJSON 

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

type ExecutionStageSummary 

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:"-"`
}

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.

func (ExecutionStageSummary) MarshalJSON 

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

type FailedLocation 

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:"-"`
}

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

func (FailedLocation) MarshalJSON 

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

type FileIODetails 

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:"-"`
}

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

func (FileIODetails) MarshalJSON 

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

type FlattenInstruction 

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:"-"`
}

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

func (FlattenInstruction) MarshalJSON 

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

type FlexTemplateRuntimeEnvironment added in v0.33.0 

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:"-"`
}

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

func (FlexTemplateRuntimeEnvironment) MarshalJSON added in v0.33.0 

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

type FloatingPointList 

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:"-"`
}

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

func (FloatingPointList) MarshalJSON 

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

func (*FloatingPointList) UnmarshalJSON added in v0.122.0 

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

type FloatingPointMean 

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:"-"`
}

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

func (FloatingPointMean) MarshalJSON 

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

func (*FloatingPointMean) UnmarshalJSON 

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

type GetDebugConfigRequest 

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:"-"`
}

GetDebugConfigRequest: Request to get updated debug configuration for component.

func (GetDebugConfigRequest) MarshalJSON 

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

type GetDebugConfigResponse 

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:"-"`
}

GetDebugConfigResponse: Response to a get debug configuration request.

func (GetDebugConfigResponse) MarshalJSON 

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

type GetTemplateResponse 

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:"-"`
}

GetTemplateResponse: The response to a GetTemplate request.

func (GetTemplateResponse) MarshalJSON 

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

type Histogram 

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:"-"`
}

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.

func (Histogram) MarshalJSON 

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

type HotKeyDebuggingInfo added in v0.93.0 

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:"-"`
}

HotKeyDebuggingInfo: Information useful for debugging a hot key detection.

func (HotKeyDebuggingInfo) MarshalJSON added in v0.93.0 

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

type HotKeyDetection added in v0.7.0 

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:"-"`
}

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

func (HotKeyDetection) MarshalJSON added in v0.7.0 

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

type HotKeyInfo added in v0.93.0 

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:"-"`
}

HotKeyInfo: Information about a hot key.

func (HotKeyInfo) MarshalJSON added in v0.93.0 

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

type InstructionInput 

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:"-"`
}

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

func (InstructionInput) MarshalJSON 

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

type InstructionOutput 

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:"-"`
}

InstructionOutput: An output of an instruction.

func (InstructionOutput) MarshalJSON 

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

type IntegerGauge 

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:"-"`
}

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

func (IntegerGauge) MarshalJSON 

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

type IntegerList 

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:"-"`
}

IntegerList: A metric value representing a list of integers.

func (IntegerList) MarshalJSON 

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

type IntegerMean 

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:"-"`
}

IntegerMean: A representation of an integer mean metric contribution.

func (IntegerMean) MarshalJSON 

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

type Job 

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: Optional. 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"`
	// ServiceResources: Output only. Resources used by the Dataflow Service to run
	// the job.
	ServiceResources *ServiceResources `json:"serviceResources,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: Optional. 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:"-"`
}

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.

func (Job) MarshalJSON 

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

type JobExecutionDetails added in v0.31.0 

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:"-"`
}

JobExecutionDetails: Information about the execution of a job.

func (JobExecutionDetails) MarshalJSON added in v0.31.0 

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

type JobExecutionInfo 

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:"-"`
}

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

func (JobExecutionInfo) MarshalJSON 

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

type JobExecutionStageInfo 

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:"-"`
}

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

func (JobExecutionStageInfo) MarshalJSON 

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

type JobMessage 

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:"-"`
}

JobMessage: A particular message pertaining to a Dataflow job.

func (JobMessage) MarshalJSON 

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

type JobMetadata 

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:"-"`
}

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

func (JobMetadata) MarshalJSON 

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

type JobMetrics 

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:"-"`
}

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.

func (JobMetrics) MarshalJSON 

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

type KeyRangeDataDiskAssignment 

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:"-"`
}

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.

func (KeyRangeDataDiskAssignment) MarshalJSON 

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

type KeyRangeLocation 

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:"-"`
}

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.

func (KeyRangeLocation) MarshalJSON 

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

type LaunchFlexTemplateParameter added in v0.16.0 

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:"-"`
}

LaunchFlexTemplateParameter: Launch FlexTemplate Parameter.

func (LaunchFlexTemplateParameter) MarshalJSON added in v0.16.0 

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

type LaunchFlexTemplateRequest added in v0.16.0 

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:"-"`
}

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

func (LaunchFlexTemplateRequest) MarshalJSON added in v0.16.0 

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

type LaunchFlexTemplateResponse added in v0.16.0 

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:"-"`
}

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

func (LaunchFlexTemplateResponse) MarshalJSON added in v0.16.0 

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

type LaunchTemplateParameters 

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:"-"`
}

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.

func (LaunchTemplateParameters) MarshalJSON 

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

type LaunchTemplateResponse 

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:"-"`
}

LaunchTemplateResponse: Response to the request to launch a template.

func (LaunchTemplateResponse) MarshalJSON 

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

type LeaseWorkItemRequest 

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"`
	// ProjectNumber: Optional. The project number of the project this worker
	// belongs to.
	ProjectNumber int64 `json:"projectNumber,omitempty,string"`
	// 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:"-"`
}

LeaseWorkItemRequest: Request to lease WorkItems.

func (LeaseWorkItemRequest) MarshalJSON 

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

type LeaseWorkItemResponse 

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:"-"`
}

LeaseWorkItemResponse: Response to a request to lease WorkItems.

func (LeaseWorkItemResponse) MarshalJSON 

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

type Linear added in v0.156.0 

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:"-"`
}

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)

func (Linear) MarshalJSON added in v0.156.0 

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

func (*Linear) UnmarshalJSON added in v0.156.0 

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

type ListJobMessagesResponse 

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:"-"`
}

ListJobMessagesResponse: Response to a request to list job messages.

func (ListJobMessagesResponse) MarshalJSON 

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

type ListJobsResponse 

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:"-"`
}

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 {}.

func (ListJobsResponse) MarshalJSON 

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

type ListSnapshotsResponse added in v0.5.0 

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:"-"`
}

ListSnapshotsResponse: List of snapshots.

func (ListSnapshotsResponse) MarshalJSON added in v0.5.0 

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

type MapTask 

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:"-"`
}

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.

func (MapTask) MarshalJSON 

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

type MemInfo added in v0.22.0 

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:"-"`
}

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

func (MemInfo) MarshalJSON added in v0.22.0 

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

type MetricShortId 

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:"-"`
}

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

func (MetricShortId) MarshalJSON 

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

type MetricStructuredName 

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:"-"`
}

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

func (MetricStructuredName) MarshalJSON 

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

type MetricUpdate 

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:"-"`
}

MetricUpdate: Describes the state of a metric.

func (MetricUpdate) MarshalJSON 

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

type MetricValue added in v0.156.0 

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:"-"`
}

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

func (MetricValue) MarshalJSON added in v0.156.0 

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

type MountedDataDisk 

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:"-"`
}

MountedDataDisk: Describes mounted data disk.

func (MountedDataDisk) MarshalJSON 

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

type MultiOutputInfo 

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:"-"`
}

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

func (MultiOutputInfo) MarshalJSON 

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

type NameAndKind 

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:"-"`
}

NameAndKind: Basic metadata about a counter.

func (NameAndKind) MarshalJSON 

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

type OutlierStats added in v0.156.0 

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:"-"`
}

OutlierStats: Statistics for the underflow and overflow bucket.

func (OutlierStats) MarshalJSON added in v0.156.0 

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

func (*OutlierStats) UnmarshalJSON added in v0.156.0 

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

type Package 

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:"-"`
}

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.

func (Package) MarshalJSON 

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

type ParDoInstruction 

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:"-"`
}

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.

func (ParDoInstruction) MarshalJSON 

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

type ParallelInstruction 

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:"-"`
}

ParallelInstruction: Describes a particular operation comprising a MapTask.

func (ParallelInstruction) MarshalJSON 

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

type Parameter 

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:"-"`
}

Parameter: Structured data associated with this message.

func (Parameter) MarshalJSON 

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

type ParameterMetadata 

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" - Deprecated. Please use KAFKA_READ_TOPIC instead.
	//   "KAFKA_READ_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.
	//   "KAFKA_WRITE_TOPIC" - The parameter specifies the fully-qualified name of
	// an Apache Kafka topic. This can be an existing Google Managed Kafka topic,
	// the name for a new Google Managed Kafka topic, or an existing 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:"-"`
}

ParameterMetadata: Metadata for a specific parameter.

func (ParameterMetadata) MarshalJSON 

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

type ParameterMetadataEnumOption added in v0.130.0 

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:"-"`
}

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

func (ParameterMetadataEnumOption) MarshalJSON added in v0.130.0 

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

type PartialGroupByKeyInstruction 

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:"-"`
}

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

func (PartialGroupByKeyInstruction) MarshalJSON 

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

type PerStepNamespaceMetrics added in v0.156.0 

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:"-"`
}

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`.

func (PerStepNamespaceMetrics) MarshalJSON added in v0.156.0 

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

type PerWorkerMetrics added in v0.156.0 

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:"-"`
}

PerWorkerMetrics: Per worker metrics.

func (PerWorkerMetrics) MarshalJSON added in v0.156.0 

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

type PipelineDescription 

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:"-"`
}

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.

func (PipelineDescription) MarshalJSON 

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

type Point added in v0.31.0 

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:"-"`
}

Point: A point in the timeseries.

func (Point) MarshalJSON added in v0.31.0 

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

func (*Point) UnmarshalJSON added in v0.31.0 

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

type Position 

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:"-"`
}

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.

func (Position) MarshalJSON 

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

type ProgressTimeseries added in v0.31.0 

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:"-"`
}

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

func (ProgressTimeseries) MarshalJSON added in v0.31.0 

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

func (*ProgressTimeseries) UnmarshalJSON added in v0.31.0 

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

type ProjectsDeleteSnapshotsCall added in v0.5.0 

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

func (*ProjectsDeleteSnapshotsCall) Context added in v0.5.0 

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

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

func (*ProjectsDeleteSnapshotsCall) Do added in v0.5.0 

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 added in v0.5.0 

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 added in v0.5.0 

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 added in v0.5.0 

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

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

func (*ProjectsDeleteSnapshotsCall) SnapshotId added in v0.5.0 

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 added in v0.98.0 

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 added in v0.98.0 

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 added in v0.115.0 

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 added in v0.16.0 

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

func (*ProjectsLocationsFlexTemplatesLaunchCall) Context added in v0.16.0 

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

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

func (*ProjectsLocationsFlexTemplatesLaunchCall) Do added in v0.16.0 

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 added in v0.16.0 

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 added in v0.16.0 

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 added in v0.16.0 

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

func NewProjectsLocationsFlexTemplatesService added in v0.16.0 

func NewProjectsLocationsFlexTemplatesService(s *Service) *ProjectsLocationsFlexTemplatesService

func (*ProjectsLocationsFlexTemplatesService) Launch added in v0.16.0 

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

Launch: Launch a job with a FlexTemplate.

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.

func (*ProjectsLocationsJobsDebugService) SendCapture 

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

SendCapture: Send encoded debug capture data for component.

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 added in v0.31.0 

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

func (*ProjectsLocationsJobsGetExecutionDetailsCall) Context added in v0.31.0 

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

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

func (*ProjectsLocationsJobsGetExecutionDetailsCall) Do added in v0.31.0 

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 added in v0.31.0 

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 added in v0.31.0 

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 added in v0.31.0 

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 added in v0.33.0 

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 added in v0.33.0 

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 added in v0.33.0 

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 added in v0.98.0 

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`.

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

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.

func (*ProjectsLocationsJobsService) Get 

func (r *ProjectsLocationsJobsService) Get(projectId string, location string, jobId string) *ProjectsLocationsJobsGetCall

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`.

func (*ProjectsLocationsJobsService) GetExecutionDetails added in v0.31.0 

func (r *ProjectsLocationsJobsService) GetExecutionDetails(projectId string, location string, jobId string) *ProjectsLocationsJobsGetExecutionDetailsCall

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

func (*ProjectsLocationsJobsService) GetMetrics 

func (r *ProjectsLocationsJobsService) GetMetrics(projectId string, location string, jobId string) *ProjectsLocationsJobsGetMetricsCall

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`.

func (*ProjectsLocationsJobsService) List 

func (r *ProjectsLocationsJobsService) List(projectId string, location string) *ProjectsLocationsJobsListCall

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`.

func (*ProjectsLocationsJobsService) Snapshot 

func (r *ProjectsLocationsJobsService) Snapshot(projectId string, location string, jobId string, snapshotjobrequest *SnapshotJobRequest) *ProjectsLocationsJobsSnapshotCall

Snapshot: Snapshot the state of a streaming job.

- jobId: The job to be snapshotted. - location: The location that contains this job. - projectId: The project which owns the job to be snapshotted.

func (*ProjectsLocationsJobsService) Update 

func (r *ProjectsLocationsJobsService) Update(projectId string, location string, jobId string, job *Job) *ProjectsLocationsJobsUpdateCall

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`.

type ProjectsLocationsJobsSnapshotCall 

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

func (*ProjectsLocationsJobsSnapshotCall) Context 

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

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

func (*ProjectsLocationsJobsSnapshotCall) Do 

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

Do executes the "dataflow.projects.locations.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 (*ProjectsLocationsJobsSnapshotCall) Fields 

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

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

func (*ProjectsLocationsJobsSnapshotCall) Header 

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

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

type ProjectsLocationsJobsSnapshotsListCall added in v0.6.0 

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

func (*ProjectsLocationsJobsSnapshotsListCall) Context added in v0.6.0 

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

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

func (*ProjectsLocationsJobsSnapshotsListCall) Do added in v0.6.0 

func (c *ProjectsLocationsJobsSnapshotsListCall) Do(opts ...googleapi.CallOption) (*ListSnapshotsResponse, error)

Do executes the "dataflow.projects.locations.jobs.snapshots.list" call. Any non-2xx status code is an error. Response headers are in either *ListSnapshotsResponse.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 (*ProjectsLocationsJobsSnapshotsListCall) Fields added in v0.6.0 

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

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

func (*ProjectsLocationsJobsSnapshotsListCall) Header added in v0.6.0 

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

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

func (*ProjectsLocationsJobsSnapshotsListCall) IfNoneMatch added in v0.6.0 

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

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.

type ProjectsLocationsJobsSnapshotsService added in v0.6.0 

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

func NewProjectsLocationsJobsSnapshotsService added in v0.6.0 

func NewProjectsLocationsJobsSnapshotsService(s *Service) *ProjectsLocationsJobsSnapshotsService

func (*ProjectsLocationsJobsSnapshotsService) List added in v0.6.0 

func (r *ProjectsLocationsJobsSnapshotsService) List(projectId string, location string, jobId string) *ProjectsLocationsJobsSnapshotsListCall

List: Lists snapshots.

- jobId: If specified, list snapshots created from this job. - location: The location to list snapshots in. - projectId: The project ID to list snapshots for.

type ProjectsLocationsJobsStagesGetExecutionDetailsCall added in v0.31.0 

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

func (*ProjectsLocationsJobsStagesGetExecutionDetailsCall) Context added in v0.31.0 

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

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

func (*ProjectsLocationsJobsStagesGetExecutionDetailsCall) Do added in v0.31.0 

func (c *ProjectsLocationsJobsStagesGetExecutionDetailsCall) Do(opts ...googleapi.CallOption) (*StageExecutionDetails, error)

Do executes the "dataflow.projects.locations.jobs.stages.getExecutionDetails" call. Any non-2xx status code is an error. Response headers are in either *StageExecutionDetails.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 (*ProjectsLocationsJobsStagesGetExecutionDetailsCall) EndTime added in v0.31.0 

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

EndTime sets the optional parameter "endTime": Upper time bound of work items to include, by start time.

func (*ProjectsLocationsJobsStagesGetExecutionDetailsCall) Fields added in v0.31.0 

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

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

func (*ProjectsLocationsJobsStagesGetExecutionDetailsCall) Header added in v0.31.0 

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

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

func (*ProjectsLocationsJobsStagesGetExecutionDetailsCall) IfNoneMatch added in v0.31.0 

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

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 (*ProjectsLocationsJobsStagesGetExecutionDetailsCall) PageSize added in v0.31.0 

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

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

func (*ProjectsLocationsJobsStagesGetExecutionDetailsCall) PageToken added in v0.31.0 

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

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 (*ProjectsLocationsJobsStagesGetExecutionDetailsCall) Pages added in v0.31.0 

func (c *ProjectsLocationsJobsStagesGetExecutionDetailsCall) Pages(ctx context.Context, f func(*StageExecutionDetails) 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 (*ProjectsLocationsJobsStagesGetExecutionDetailsCall) StartTime added in v0.31.0 

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

StartTime sets the optional parameter "startTime": Lower time bound of work items to include, by start time.

type ProjectsLocationsJobsStagesService added in v0.31.0 

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

func NewProjectsLocationsJobsStagesService added in v0.31.0 

func NewProjectsLocationsJobsStagesService(s *Service) *ProjectsLocationsJobsStagesService

func (*ProjectsLocationsJobsStagesService) GetExecutionDetails added in v0.31.0 

func (r *ProjectsLocationsJobsStagesService) GetExecutionDetails(projectId string, location string, jobId string, stageId string) *ProjectsLocationsJobsStagesGetExecutionDetailsCall

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

type ProjectsLocationsJobsUpdateCall 

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

func (*ProjectsLocationsJobsUpdateCall) Context 

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

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

func (*ProjectsLocationsJobsUpdateCall) Do 

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

Do executes the "dataflow.projects.locations.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 (*ProjectsLocationsJobsUpdateCall) Fields 

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

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

func (*ProjectsLocationsJobsUpdateCall) Header 

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

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

func (*ProjectsLocationsJobsUpdateCall) UpdateMask added in v0.115.0 

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

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 ProjectsLocationsJobsWorkItemsLeaseCall 

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

func (*ProjectsLocationsJobsWorkItemsLeaseCall) Context 

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

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

func (*ProjectsLocationsJobsWorkItemsLeaseCall) Do 

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

Do executes the "dataflow.projects.locations.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 (*ProjectsLocationsJobsWorkItemsLeaseCall) Fields 

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

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

func (*ProjectsLocationsJobsWorkItemsLeaseCall) Header 

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

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

type ProjectsLocationsJobsWorkItemsReportStatusCall 

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

func (*ProjectsLocationsJobsWorkItemsReportStatusCall) Context 

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

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

func (*ProjectsLocationsJobsWorkItemsReportStatusCall) Do 

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

Do executes the "dataflow.projects.locations.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 (*ProjectsLocationsJobsWorkItemsReportStatusCall) Fields 

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

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

func (*ProjectsLocationsJobsWorkItemsReportStatusCall) Header 

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

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

type ProjectsLocationsJobsWorkItemsService 

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

func NewProjectsLocationsJobsWorkItemsService 

func NewProjectsLocationsJobsWorkItemsService(s *Service) *ProjectsLocationsJobsWorkItemsService

func (*ProjectsLocationsJobsWorkItemsService) Lease 

func (r *ProjectsLocationsJobsWorkItemsService) Lease(projectId string, location string, jobId string, leaseworkitemrequest *LeaseWorkItemRequest) *ProjectsLocationsJobsWorkItemsLeaseCall

Lease: Leases a dataflow WorkItem to run.

func (*ProjectsLocationsJobsWorkItemsService) ReportStatus 

func (r *ProjectsLocationsJobsWorkItemsService) ReportStatus(projectId string, location string, jobId string, reportworkitemstatusrequest *ReportWorkItemStatusRequest) *ProjectsLocationsJobsWorkItemsReportStatusCall

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

type ProjectsLocationsService 

type ProjectsLocationsService struct {
	FlexTemplates *ProjectsLocationsFlexTemplatesService

	Jobs *ProjectsLocationsJobsService

	Snapshots *ProjectsLocationsSnapshotsService

	Templates *ProjectsLocationsTemplatesService
	// contains filtered or unexported fields
}

func NewProjectsLocationsService 

func NewProjectsLocationsService(s *Service) *ProjectsLocationsService

func (*ProjectsLocationsService) WorkerMessages 

func (r *ProjectsLocationsService) WorkerMessages(projectId string, location string, sendworkermessagesrequest *SendWorkerMessagesRequest) *ProjectsLocationsWorkerMessagesCall

WorkerMessages: Send a worker_message to the service.

type ProjectsLocationsSnapshotsDeleteCall added in v0.5.0 

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

func (*ProjectsLocationsSnapshotsDeleteCall) Context added in v0.5.0 

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

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

func (*ProjectsLocationsSnapshotsDeleteCall) Do added in v0.5.0 

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

Do executes the "dataflow.projects.locations.snapshots.delete" 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 (*ProjectsLocationsSnapshotsDeleteCall) Fields added in v0.5.0 

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

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

func (*ProjectsLocationsSnapshotsDeleteCall) Header added in v0.5.0 

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

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

type ProjectsLocationsSnapshotsGetCall added in v0.5.0 

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

func (*ProjectsLocationsSnapshotsGetCall) Context added in v0.5.0 

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

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

func (*ProjectsLocationsSnapshotsGetCall) Do added in v0.5.0 

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

Do executes the "dataflow.projects.locations.snapshots.get" 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 (*ProjectsLocationsSnapshotsGetCall) Fields added in v0.5.0 

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

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

func (*ProjectsLocationsSnapshotsGetCall) Header added in v0.5.0 

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

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

func (*ProjectsLocationsSnapshotsGetCall) IfNoneMatch added in v0.5.0 

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

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.

type ProjectsLocationsSnapshotsListCall added in v0.5.0 

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

func (*ProjectsLocationsSnapshotsListCall) Context added in v0.5.0 

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

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

func (*ProjectsLocationsSnapshotsListCall) Do added in v0.5.0 

func (c *ProjectsLocationsSnapshotsListCall) Do(opts ...googleapi.CallOption) (*ListSnapshotsResponse, error)

Do executes the "dataflow.projects.locations.snapshots.list" call. Any non-2xx status code is an error. Response headers are in either *ListSnapshotsResponse.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 (*ProjectsLocationsSnapshotsListCall) Fields added in v0.5.0 

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

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

func (*ProjectsLocationsSnapshotsListCall) Header added in v0.5.0 

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

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

func (*ProjectsLocationsSnapshotsListCall) IfNoneMatch added in v0.5.0 

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

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 (*ProjectsLocationsSnapshotsListCall) JobId added in v0.6.0 

func (c *ProjectsLocationsSnapshotsListCall) JobId(jobId string) *ProjectsLocationsSnapshotsListCall

JobId sets the optional parameter "jobId": If specified, list snapshots created from this job.

type ProjectsLocationsSnapshotsService added in v0.5.0 

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

func NewProjectsLocationsSnapshotsService added in v0.5.0 

func NewProjectsLocationsSnapshotsService(s *Service) *ProjectsLocationsSnapshotsService

func (*ProjectsLocationsSnapshotsService) Delete added in v0.5.0 

func (r *ProjectsLocationsSnapshotsService) Delete(projectId string, location string, snapshotId string) *ProjectsLocationsSnapshotsDeleteCall

Delete: Deletes a snapshot.

  • location: The location that contains this snapshot.
  • projectId: The ID of the Cloud Platform project that the snapshot belongs to.
  • snapshotId: The ID of the snapshot.

func (*ProjectsLocationsSnapshotsService) Get added in v0.5.0 

func (r *ProjectsLocationsSnapshotsService) Get(projectId string, location string, snapshotId string) *ProjectsLocationsSnapshotsGetCall

Get: Gets information about a snapshot.

  • location: The location that contains this snapshot.
  • projectId: The ID of the Cloud Platform project that the snapshot belongs to.
  • snapshotId: The ID of the snapshot.

func (*ProjectsLocationsSnapshotsService) List added in v0.5.0 

func (r *ProjectsLocationsSnapshotsService) List(projectId string, location string) *ProjectsLocationsSnapshotsListCall

List: Lists snapshots.

- location: The location to list snapshots in. - projectId: The project ID to list snapshots for.

type ProjectsLocationsTemplatesCreateCall 

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

func (*ProjectsLocationsTemplatesCreateCall) Context 

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

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

func (*ProjectsLocationsTemplatesCreateCall) Do 

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

Do executes the "dataflow.projects.locations.templates.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 (*ProjectsLocationsTemplatesCreateCall) Fields 

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

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

func (*ProjectsLocationsTemplatesCreateCall) Header 

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

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

type ProjectsLocationsTemplatesGetCall 

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

func (*ProjectsLocationsTemplatesGetCall) Context 

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

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

func (*ProjectsLocationsTemplatesGetCall) Do 

func (c *ProjectsLocationsTemplatesGetCall) Do(opts ...googleapi.CallOption) (*GetTemplateResponse, error)

Do executes the "dataflow.projects.locations.templates.get" call. Any non-2xx status code is an error. Response headers are in either *GetTemplateResponse.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 (*ProjectsLocationsTemplatesGetCall) Fields 

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

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

func (*ProjectsLocationsTemplatesGetCall) GcsPath 

func (c *ProjectsLocationsTemplatesGetCall) GcsPath(gcsPath string) *ProjectsLocationsTemplatesGetCall

GcsPath sets the optional parameter "gcsPath": Required. A Cloud Storage path to the template from which to create the job. Must be valid Cloud Storage URL, beginning with 'gs://'.

func (*ProjectsLocationsTemplatesGetCall) Header 

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

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

func (*ProjectsLocationsTemplatesGetCall) IfNoneMatch 

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

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 (*ProjectsLocationsTemplatesGetCall) View 

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

View sets the optional parameter "view": The view to retrieve. Defaults to METADATA_ONLY.

Possible values: 

"METADATA_ONLY" - Template view that retrieves only the metadata

associated with the template.

type ProjectsLocationsTemplatesLaunchCall 

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

func (*ProjectsLocationsTemplatesLaunchCall) Context 

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

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

func (*ProjectsLocationsTemplatesLaunchCall) Do 

func (c *ProjectsLocationsTemplatesLaunchCall) Do(opts ...googleapi.CallOption) (*LaunchTemplateResponse, error)

Do executes the "dataflow.projects.locations.templates.launch" call. Any non-2xx status code is an error. Response headers are in either *LaunchTemplateResponse.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 (*ProjectsLocationsTemplatesLaunchCall) DynamicTemplateGcsPath 

func (c *ProjectsLocationsTemplatesLaunchCall) DynamicTemplateGcsPath(dynamicTemplateGcsPath string) *ProjectsLocationsTemplatesLaunchCall

DynamicTemplateGcsPath sets the optional parameter "dynamicTemplate.gcsPath": Path to the dynamic template specification file on Cloud Storage. The file must be a JSON serialized `DynamicTemplateFileSpec` object.

func (*ProjectsLocationsTemplatesLaunchCall) DynamicTemplateStagingLocation 

func (c *ProjectsLocationsTemplatesLaunchCall) DynamicTemplateStagingLocation(dynamicTemplateStagingLocation string) *ProjectsLocationsTemplatesLaunchCall

DynamicTemplateStagingLocation sets the optional parameter "dynamicTemplate.stagingLocation": Cloud Storage path for staging dependencies. Must be a valid Cloud Storage URL, beginning with `gs://`.

func (*ProjectsLocationsTemplatesLaunchCall) Fields 

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

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

func (*ProjectsLocationsTemplatesLaunchCall) GcsPath 

func (c *ProjectsLocationsTemplatesLaunchCall) GcsPath(gcsPath string) *ProjectsLocationsTemplatesLaunchCall

GcsPath sets the optional parameter "gcsPath": A Cloud Storage path to the template to use to create the job. Must be valid Cloud Storage URL, beginning with `gs://`.

func (*ProjectsLocationsTemplatesLaunchCall) Header 

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

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

func (*ProjectsLocationsTemplatesLaunchCall) ValidateOnly 

func (c *ProjectsLocationsTemplatesLaunchCall) ValidateOnly(validateOnly bool) *ProjectsLocationsTemplatesLaunchCall

ValidateOnly sets the optional parameter "validateOnly": If true, the request is validated but not actually executed. Defaults to false.

type ProjectsLocationsTemplatesService 

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

func NewProjectsLocationsTemplatesService 

func NewProjectsLocationsTemplatesService(s *Service) *ProjectsLocationsTemplatesService

func (*ProjectsLocationsTemplatesService) Create 

func (r *ProjectsLocationsTemplatesService) Create(projectId string, location string, createjobfromtemplaterequest *CreateJobFromTemplateRequest) *ProjectsLocationsTemplatesCreateCall

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

func (*ProjectsLocationsTemplatesService) Get 

func (r *ProjectsLocationsTemplatesService) Get(projectId string, location string) *ProjectsLocationsTemplatesGetCall

Get: Get the template associated with a template. To get the template, we recommend using `projects.locations.templates.get` with a [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). Using `projects.templates.get` is not recommended, because only templates that are running in `us-central1` are retrieved.

func (*ProjectsLocationsTemplatesService) Launch 

func (r *ProjectsLocationsTemplatesService) Launch(projectId string, location string, launchtemplateparameters *LaunchTemplateParameters) *ProjectsLocationsTemplatesLaunchCall

Launch: Launches a template. To launch a template, we recommend using `projects.locations.templates.launch` with a [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). Using `projects.templates.launch` is not recommended, because jobs launched from the template will always start in `us-central1`.

type ProjectsLocationsWorkerMessagesCall 

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

func (*ProjectsLocationsWorkerMessagesCall) Context 

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

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

func (*ProjectsLocationsWorkerMessagesCall) Do 

func (c *ProjectsLocationsWorkerMessagesCall) Do(opts ...googleapi.CallOption) (*SendWorkerMessagesResponse, error)

Do executes the "dataflow.projects.locations.workerMessages" call. Any non-2xx status code is an error. Response headers are in either *SendWorkerMessagesResponse.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 (*ProjectsLocationsWorkerMessagesCall) Fields 

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

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

func (*ProjectsLocationsWorkerMessagesCall) Header 

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

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

type ProjectsService 

type ProjectsService struct {
	Jobs *ProjectsJobsService

	Locations *ProjectsLocationsService

	Snapshots *ProjectsSnapshotsService

	Templates *ProjectsTemplatesService
	// contains filtered or unexported fields
}

func NewProjectsService 

func NewProjectsService(s *Service) *ProjectsService

func (*ProjectsService) DeleteSnapshots added in v0.5.0 

func (r *ProjectsService) DeleteSnapshots(projectId string) *ProjectsDeleteSnapshotsCall

DeleteSnapshots: Deletes a snapshot.

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

func (*ProjectsService) WorkerMessages 

func (r *ProjectsService) WorkerMessages(projectId string, sendworkermessagesrequest *SendWorkerMessagesRequest) *ProjectsWorkerMessagesCall

WorkerMessages: Send a worker_message to the service.

- projectId: The project to send the WorkerMessages to.

type ProjectsSnapshotsGetCall added in v0.5.0 

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

func (*ProjectsSnapshotsGetCall) Context added in v0.5.0 

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

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

func (*ProjectsSnapshotsGetCall) Do added in v0.5.0 

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

Do executes the "dataflow.projects.snapshots.get" 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 (*ProjectsSnapshotsGetCall) Fields added in v0.5.0 

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

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

func (*ProjectsSnapshotsGetCall) Header added in v0.5.0 

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

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

func (*ProjectsSnapshotsGetCall) IfNoneMatch added in v0.5.0 

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

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 (*ProjectsSnapshotsGetCall) Location added in v0.5.0 

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

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

type ProjectsSnapshotsListCall added in v0.5.0 

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

func (*ProjectsSnapshotsListCall) Context added in v0.5.0 

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

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

func (*ProjectsSnapshotsListCall) Do added in v0.5.0 

func (c *ProjectsSnapshotsListCall) Do(opts ...googleapi.CallOption) (*ListSnapshotsResponse, error)

Do executes the "dataflow.projects.snapshots.list" call. Any non-2xx status code is an error. Response headers are in either *ListSnapshotsResponse.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 (*ProjectsSnapshotsListCall) Fields added in v0.5.0 

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

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

func (*ProjectsSnapshotsListCall) Header added in v0.5.0 

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

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

func (*ProjectsSnapshotsListCall) IfNoneMatch added in v0.5.0 

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

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 (*ProjectsSnapshotsListCall) JobId added in v0.6.0 

func (c *ProjectsSnapshotsListCall) JobId(jobId string) *ProjectsSnapshotsListCall

JobId sets the optional parameter "jobId": If specified, list snapshots created from this job.

func (*ProjectsSnapshotsListCall) Location added in v0.5.0 

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

Location sets the optional parameter "location": The location to list snapshots in.

type ProjectsSnapshotsService added in v0.5.0 

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

func NewProjectsSnapshotsService added in v0.5.0 

func NewProjectsSnapshotsService(s *Service) *ProjectsSnapshotsService

func (*ProjectsSnapshotsService) Get added in v0.5.0 

func (r *ProjectsSnapshotsService) Get(projectId string, snapshotId string) *ProjectsSnapshotsGetCall

Get: Gets information about a snapshot.

  • projectId: The ID of the Cloud Platform project that the snapshot belongs to.
  • snapshotId: The ID of the snapshot.

func (*ProjectsSnapshotsService) List added in v0.5.0 

func (r *ProjectsSnapshotsService) List(projectId string) *ProjectsSnapshotsListCall

List: Lists snapshots.

- projectId: The project ID to list snapshots for.

type ProjectsTemplatesCreateCall 

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

func (*ProjectsTemplatesCreateCall) Context 

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

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

func (*ProjectsTemplatesCreateCall) Do 

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

Do executes the "dataflow.projects.templates.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 (*ProjectsTemplatesCreateCall) Fields 

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

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

func (*ProjectsTemplatesCreateCall) Header 

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

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

type ProjectsTemplatesGetCall 

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

func (*ProjectsTemplatesGetCall) Context 

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

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

func (*ProjectsTemplatesGetCall) Do 

func (c *ProjectsTemplatesGetCall) Do(opts ...googleapi.CallOption) (*GetTemplateResponse, error)

Do executes the "dataflow.projects.templates.get" call. Any non-2xx status code is an error. Response headers are in either *GetTemplateResponse.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 (*ProjectsTemplatesGetCall) Fields 

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

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

func (*ProjectsTemplatesGetCall) GcsPath 

func (c *ProjectsTemplatesGetCall) GcsPath(gcsPath string) *ProjectsTemplatesGetCall

GcsPath sets the optional parameter "gcsPath": Required. A Cloud Storage path to the template from which to create the job. Must be valid Cloud Storage URL, beginning with 'gs://'.

func (*ProjectsTemplatesGetCall) Header 

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

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

func (*ProjectsTemplatesGetCall) IfNoneMatch 

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

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 (*ProjectsTemplatesGetCall) Location 

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

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

func (*ProjectsTemplatesGetCall) View 

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

View sets the optional parameter "view": The view to retrieve. Defaults to METADATA_ONLY.

Possible values: 

"METADATA_ONLY" - Template view that retrieves only the metadata

associated with the template.

type ProjectsTemplatesLaunchCall 

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

func (*ProjectsTemplatesLaunchCall) Context 

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

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

func (*ProjectsTemplatesLaunchCall) Do 

func (c *ProjectsTemplatesLaunchCall) Do(opts ...googleapi.CallOption) (*LaunchTemplateResponse, error)

Do executes the "dataflow.projects.templates.launch" call. Any non-2xx status code is an error. Response headers are in either *LaunchTemplateResponse.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 (*ProjectsTemplatesLaunchCall) DynamicTemplateGcsPath 

func (c *ProjectsTemplatesLaunchCall) DynamicTemplateGcsPath(dynamicTemplateGcsPath string) *ProjectsTemplatesLaunchCall

DynamicTemplateGcsPath sets the optional parameter "dynamicTemplate.gcsPath": Path to the dynamic template specification file on Cloud Storage. The file must be a JSON serialized `DynamicTemplateFileSpec` object.

func (*ProjectsTemplatesLaunchCall) DynamicTemplateStagingLocation 

func (c *ProjectsTemplatesLaunchCall) DynamicTemplateStagingLocation(dynamicTemplateStagingLocation string) *ProjectsTemplatesLaunchCall

DynamicTemplateStagingLocation sets the optional parameter "dynamicTemplate.stagingLocation": Cloud Storage path for staging dependencies. Must be a valid Cloud Storage URL, beginning with `gs://`.

func (*ProjectsTemplatesLaunchCall) Fields 

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

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

func (*ProjectsTemplatesLaunchCall) GcsPath 

func (c *ProjectsTemplatesLaunchCall) GcsPath(gcsPath string) *ProjectsTemplatesLaunchCall

GcsPath sets the optional parameter "gcsPath": A Cloud Storage path to the template to use to create the job. Must be valid Cloud Storage URL, beginning with `gs://`.

func (*ProjectsTemplatesLaunchCall) Header 

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

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

func (*ProjectsTemplatesLaunchCall) Location 

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

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

func (*ProjectsTemplatesLaunchCall) ValidateOnly 

func (c *ProjectsTemplatesLaunchCall) ValidateOnly(validateOnly bool) *ProjectsTemplatesLaunchCall

ValidateOnly sets the optional parameter "validateOnly": If true, the request is validated but not actually executed. Defaults to false.

type ProjectsTemplatesService 

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

func NewProjectsTemplatesService 

func NewProjectsTemplatesService(s *Service) *ProjectsTemplatesService

func (*ProjectsTemplatesService) Create 

func (r *ProjectsTemplatesService) Create(projectId string, createjobfromtemplaterequest *CreateJobFromTemplateRequest) *ProjectsTemplatesCreateCall

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

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

func (*ProjectsTemplatesService) Get 

func (r *ProjectsTemplatesService) Get(projectId string) *ProjectsTemplatesGetCall

Get: Get the template associated with a template. To get the template, we recommend using `projects.locations.templates.get` with a [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). Using `projects.templates.get` is not recommended, because only templates that are running in `us-central1` are retrieved.

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

func (*ProjectsTemplatesService) Launch 

func (r *ProjectsTemplatesService) Launch(projectId string, launchtemplateparameters *LaunchTemplateParameters) *ProjectsTemplatesLaunchCall

Launch: Launches a template. To launch a template, we recommend using `projects.locations.templates.launch` with a [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). Using `projects.templates.launch` is not recommended, because jobs launched from the template will always start in `us-central1`.

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

type ProjectsWorkerMessagesCall 

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

func (*ProjectsWorkerMessagesCall) Context 

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

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

func (*ProjectsWorkerMessagesCall) Do 

func (c *ProjectsWorkerMessagesCall) Do(opts ...googleapi.CallOption) (*SendWorkerMessagesResponse, error)

Do executes the "dataflow.projects.workerMessages" call. Any non-2xx status code is an error. Response headers are in either *SendWorkerMessagesResponse.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 (*ProjectsWorkerMessagesCall) Fields 

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

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

func (*ProjectsWorkerMessagesCall) Header 

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

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

type PubSubIODetails 

type PubSubIODetails struct {
	// Subscription: Subscription used in the connection.
	Subscription string `json:"subscription,omitempty"`
	// Topic: Topic accessed in the connection.
	Topic string `json:"topic,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Subscription") 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. "Subscription") 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:"-"`
}

PubSubIODetails: Metadata for a Pub/Sub connector used by the job.

func (PubSubIODetails) MarshalJSON 

func (s PubSubIODetails) MarshalJSON() ([]byte, error)

type PubsubLocation 

type PubsubLocation struct {
	// DropLateData: Indicates whether the pipeline allows late-arriving data.
	DropLateData bool `json:"dropLateData,omitempty"`
	// DynamicDestinations: If true, then this location represents dynamic topics.
	DynamicDestinations bool `json:"dynamicDestinations,omitempty"`
	// IdLabel: If set, contains a pubsub label from which to extract record ids.
	// If left empty, record deduplication will be strictly best effort.
	IdLabel string `json:"idLabel,omitempty"`
	// Subscription: A pubsub subscription, in the form of
	// "pubsub.googleapis.com/subscriptions//"
	Subscription string `json:"subscription,omitempty"`
	// TimestampLabel: If set, contains a pubsub label from which to extract record
	// timestamps. If left empty, record timestamps will be generated upon arrival.
	TimestampLabel string `json:"timestampLabel,omitempty"`
	// Topic: A pubsub topic, in the form of "pubsub.googleapis.com/topics//"
	Topic string `json:"topic,omitempty"`
	// TrackingSubscription: If set, specifies the pubsub subscription that will be
	// used for tracking custom time timestamps for watermark estimation.
	TrackingSubscription string `json:"trackingSubscription,omitempty"`
	// WithAttributes: If true, then the client has requested to get pubsub
	// attributes.
	WithAttributes bool `json:"withAttributes,omitempty"`
	// ForceSendFields is a list of field names (e.g. "DropLateData") 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. "DropLateData") 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:"-"`
}

PubsubLocation: Identifies a pubsub location to use for transferring data into or out of a streaming Dataflow job.

func (PubsubLocation) MarshalJSON 

func (s PubsubLocation) MarshalJSON() ([]byte, error)

type PubsubSnapshotMetadata added in v0.22.0 

type PubsubSnapshotMetadata struct {
	// ExpireTime: The expire time of the Pubsub snapshot.
	ExpireTime string `json:"expireTime,omitempty"`
	// SnapshotName: The name of the Pubsub snapshot.
	SnapshotName string `json:"snapshotName,omitempty"`
	// TopicName: The name of the Pubsub topic.
	TopicName string `json:"topicName,omitempty"`
	// ForceSendFields is a list of field names (e.g. "ExpireTime") 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. "ExpireTime") 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:"-"`
}

PubsubSnapshotMetadata: Represents a Pubsub snapshot.

func (PubsubSnapshotMetadata) MarshalJSON added in v0.22.0 

func (s PubsubSnapshotMetadata) MarshalJSON() ([]byte, error)

type ReadInstruction 

type ReadInstruction struct {
	// Source: The source to read from.
	Source *Source `json:"source,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Source") 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. "Source") 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:"-"`
}

ReadInstruction: An instruction that reads records. Takes no inputs, produces one output.

func (ReadInstruction) MarshalJSON 

func (s ReadInstruction) MarshalJSON() ([]byte, error)

type ReportWorkItemStatusRequest 

type ReportWorkItemStatusRequest 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"`
	// ProjectNumber: Optional. The project number of the project which owns the
	// WorkItem's job.
	ProjectNumber int64 `json:"projectNumber,omitempty,string"`
	// UnifiedWorkerRequest: Untranslated bag-of-bytes WorkProgressUpdateRequest
	// from UnifiedWorker.
	UnifiedWorkerRequest googleapi.RawMessage `json:"unifiedWorkerRequest,omitempty"`
	// WorkItemStatuses: The order is unimportant, except that the order of the
	// WorkItemServiceState messages in the ReportWorkItemStatusResponse
	// corresponds to the order of WorkItemStatus messages here.
	WorkItemStatuses []*WorkItemStatus `json:"workItemStatuses,omitempty"`
	// WorkerId: The ID of the worker reporting the WorkItem status. If this does
	// not match the ID of the worker which the Dataflow service believes currently
	// has the lease on the WorkItem, the report will be dropped (with an error
	// response).
	WorkerId string `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:"-"`
}

ReportWorkItemStatusRequest: Request to report the status of WorkItems.

func (ReportWorkItemStatusRequest) MarshalJSON 

func (s ReportWorkItemStatusRequest) MarshalJSON() ([]byte, error)

type ReportWorkItemStatusResponse 

type ReportWorkItemStatusResponse struct {
	// UnifiedWorkerResponse: Untranslated bag-of-bytes WorkProgressUpdateResponse
	// for UnifiedWorker.
	UnifiedWorkerResponse googleapi.RawMessage `json:"unifiedWorkerResponse,omitempty"`
	// WorkItemServiceStates: A set of messages indicating the service-side state
	// for each WorkItem whose status was reported, in the same order as the
	// WorkItemStatus messages in the ReportWorkItemStatusRequest which resulting
	// in this response.
	WorkItemServiceStates []*WorkItemServiceState `json:"workItemServiceStates,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:"-"`
}

ReportWorkItemStatusResponse: Response from a request to report the status of WorkItems.

func (ReportWorkItemStatusResponse) MarshalJSON 

func (s ReportWorkItemStatusResponse) MarshalJSON() ([]byte, error)

type ReportedParallelism 

type ReportedParallelism struct {
	// IsInfinite: Specifies whether the parallelism is infinite. If true, "value"
	// is ignored. Infinite parallelism means the service will assume that the work
	// item can always be split into more non-empty work items by dynamic
	// splitting. This is a work-around for lack of support for infinity by the
	// current JSON-based Java RPC stack.
	IsInfinite bool `json:"isInfinite,omitempty"`
	// Value: Specifies the level of parallelism in case it is finite.
	Value float64 `json:"value,omitempty"`
	// ForceSendFields is a list of field names (e.g. "IsInfinite") 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. "IsInfinite") 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:"-"`
}

ReportedParallelism: Represents the level of parallelism in a WorkItem's input, reported by the worker.

func (ReportedParallelism) MarshalJSON 

func (s ReportedParallelism) MarshalJSON() ([]byte, error)

func (*ReportedParallelism) UnmarshalJSON 

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

type ResourceUtilizationReport 

type ResourceUtilizationReport struct {
	// Containers: Per container information. Key: container name.
	Containers map[string]ResourceUtilizationReport `json:"containers,omitempty"`
	// CpuTime: CPU utilization samples.
	CpuTime []*CPUTime `json:"cpuTime,omitempty"`
	// MemoryInfo: Memory utilization samples.
	MemoryInfo []*MemInfo `json:"memoryInfo,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Containers") 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. "Containers") 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:"-"`
}

ResourceUtilizationReport: Worker metrics exported from workers. This contains resource utilization metrics accumulated from a variety of sources. For more information, see go/df-resource-signals.

func (ResourceUtilizationReport) MarshalJSON 

func (s ResourceUtilizationReport) MarshalJSON() ([]byte, error)

type ResourceUtilizationReportResponse 

type ResourceUtilizationReportResponse struct {
}

ResourceUtilizationReportResponse: Service-side response to WorkerMessage reporting resource utilization.

type RuntimeEnvironment 

type RuntimeEnvironment struct {
	// AdditionalExperiments: Optional. Additional experiment flags for the job,
	// specified with the `--experiments` option.
	AdditionalExperiments []string `json:"additionalExperiments,omitempty"`
	// AdditionalUserLabels: Optional. Additional user labels to be specified for
	// the job. Keys and values should 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"`
	// BypassTempDirValidation: Optional. Whether to bypass the safety checks for
	// the job's temporary directory. Use with caution.
	BypassTempDirValidation bool `json:"bypassTempDirValidation,omitempty"`
	// DiskSizeGb: Optional. The disk size, in gigabytes, to use on each remote
	// Compute Engine worker instance.
	DiskSizeGb int64 `json:"diskSizeGb,omitempty"`
	// EnableStreamingEngine: Optional. Whether to enable Streaming Engine for the
	// job.
	EnableStreamingEngine bool `json:"enableStreamingEngine,omitempty"`
	// IpConfiguration: Optional. 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: Optional. Name for the Cloud KMS key for the job. Key format is:
	// projects//locations//keyRings//cryptoKeys/
	KmsKeyName string `json:"kmsKeyName,omitempty"`
	// MachineType: Optional. The machine type to use for the job. Defaults to the
	// value from the template if not specified.
	MachineType string `json:"machineType,omitempty"`
	// MaxWorkers: Optional. The maximum number of Google Compute Engine instances
	// to be made available to your pipeline during execution, from 1 to 1000. The
	// default value is 1.
	MaxWorkers int64 `json:"maxWorkers,omitempty"`
	// Network: Optional. Network to which VMs will be assigned. If empty or
	// unspecified, the service will use the network "default".
	Network string `json:"network,omitempty"`
	// NumWorkers: Optional. The initial number of Google Compute Engine instances
	// for the job. The default value is 11.
	NumWorkers int64 `json:"numWorkers,omitempty"`
	// ServiceAccountEmail: Optional. The email address of the service account to
	// run the job as.
	ServiceAccountEmail string `json:"serviceAccountEmail,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: Optional. 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: Required. 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: Required. 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: Optional. 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: Optional. 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:"-"`
}

RuntimeEnvironment: The environment values to set at runtime. LINT.IfChange

func (RuntimeEnvironment) MarshalJSON 

func (s RuntimeEnvironment) MarshalJSON() ([]byte, error)

type RuntimeMetadata added in v0.16.0 

type RuntimeMetadata struct {
	// Parameters: The parameters for the template.
	Parameters []*ParameterMetadata `json:"parameters,omitempty"`
	// SdkInfo: SDK Info for the template.
	SdkInfo *SDKInfo `json:"sdkInfo,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Parameters") 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. "Parameters") 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:"-"`
}

RuntimeMetadata: RuntimeMetadata describing a runtime environment.

func (RuntimeMetadata) MarshalJSON added in v0.16.0 

func (s RuntimeMetadata) MarshalJSON() ([]byte, error)

type RuntimeUpdatableParams added in v0.122.0 

type RuntimeUpdatableParams struct {
	// MaxNumWorkers: The maximum number of workers to cap autoscaling at. This
	// field is currently only supported for Streaming Engine jobs.
	MaxNumWorkers int64 `json:"maxNumWorkers,omitempty"`
	// MinNumWorkers: The minimum number of workers to scale down to. This field is
	// currently only supported for Streaming Engine jobs.
	MinNumWorkers int64 `json:"minNumWorkers,omitempty"`
	// WorkerUtilizationHint: Target worker utilization, compared against the
	// aggregate utilization of the worker pool by autoscaler, to determine
	// upscaling and downscaling when absent other constraints such as backlog. For
	// more information, see Update an existing pipeline
	// (https://cloud.google.com/dataflow/docs/guides/updating-a-pipeline).
	WorkerUtilizationHint float64 `json:"workerUtilizationHint,omitempty"`
	// ForceSendFields is a list of field names (e.g. "MaxNumWorkers") 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. "MaxNumWorkers") 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:"-"`
}

RuntimeUpdatableParams: Additional job parameters that can only be updated during runtime using the projects.jobs.update method. These fields have no effect when specified during job creation.

func (RuntimeUpdatableParams) MarshalJSON added in v0.122.0 

func (s RuntimeUpdatableParams) MarshalJSON() ([]byte, error)

func (*RuntimeUpdatableParams) UnmarshalJSON added in v0.154.0 

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

type SDKInfo added in v0.16.0 

type SDKInfo struct {
	// Language: Required. The SDK Language.
	//
	// Possible values:
	//   "UNKNOWN" - UNKNOWN Language.
	//   "JAVA" - Java.
	//   "PYTHON" - Python.
	//   "GO" - Go.
	Language string `json:"language,omitempty"`
	// Version: Optional. The SDK version.
	Version string `json:"version,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Language") 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. "Language") 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:"-"`
}

SDKInfo: SDK Information.

func (SDKInfo) MarshalJSON added in v0.16.0 

func (s SDKInfo) MarshalJSON() ([]byte, error)

type SdkBug added in v0.135.0 

type SdkBug struct {
	// Severity: Output only. How severe the SDK bug is.
	//
	// Possible values:
	//   "SEVERITY_UNSPECIFIED" - A bug of unknown severity.
	//   "NOTICE" - A minor bug that that may reduce reliability or performance for
	// some jobs. Impact will be minimal or non-existent for most jobs.
	//   "WARNING" - A bug that has some likelihood of causing performance
	// degradation, data loss, or job failures.
	//   "SEVERE" - A bug with extremely significant impact. Jobs may fail
	// erroneously, performance may be severely degraded, and data loss may be very
	// likely.
	Severity string `json:"severity,omitempty"`
	// Type: Output only. Describes the impact of this SDK bug.
	//
	// Possible values:
	//   "TYPE_UNSPECIFIED" - Unknown issue with this SDK.
	//   "GENERAL" - Catch-all for SDK bugs that don't fit in the below categories.
	//   "PERFORMANCE" - Using this version of the SDK may result in degraded
	// performance.
	//   "DATALOSS" - Using this version of the SDK may cause data loss.
	Type string `json:"type,omitempty"`
	// Uri: Output only. Link to more information on the bug.
	Uri string `json:"uri,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Severity") 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. "Severity") 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:"-"`
}

SdkBug: A bug found in the Dataflow SDK.

func (SdkBug) MarshalJSON added in v0.135.0 

func (s SdkBug) MarshalJSON() ([]byte, error)

type SdkHarnessContainerImage added in v0.18.0 

type SdkHarnessContainerImage struct {
	// Capabilities: The set of capabilities enumerated in the above Environment
	// proto. See also beam_runner_api.proto
	// (https://github.com/apache/beam/blob/master/model/pipeline/src/main/proto/org/apache/beam/model/pipeline/v1/beam_runner_api.proto)
	Capabilities []string `json:"capabilities,omitempty"`
	// ContainerImage: A docker container image that resides in Google Container
	// Registry.
	ContainerImage string `json:"containerImage,omitempty"`
	// EnvironmentId: Environment ID for the Beam runner API proto Environment that
	// corresponds to the current SDK Harness.
	EnvironmentId string `json:"environmentId,omitempty"`
	// UseSingleCorePerContainer: If true, recommends the Dataflow service to use
	// only one core per SDK container instance with this image. If false (or
	// unset) recommends using more than one core per SDK container instance with
	// this image for efficiency. Note that Dataflow service may choose to override
	// this property if needed.
	UseSingleCorePerContainer bool `json:"useSingleCorePerContainer,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Capabilities") 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. "Capabilities") 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:"-"`
}

SdkHarnessContainerImage: Defines an SDK harness container for executing Dataflow pipelines.

func (SdkHarnessContainerImage) MarshalJSON added in v0.18.0 

func (s SdkHarnessContainerImage) MarshalJSON() ([]byte, error)

type SdkVersion 

type SdkVersion struct {
	// Bugs: Output only. Known bugs found in this SDK version.
	Bugs []*SdkBug `json:"bugs,omitempty"`
	// SdkSupportStatus: The support status for this SDK version.
	//
	// Possible values:
	//   "UNKNOWN" - Cloud Dataflow is unaware of this version.
	//   "SUPPORTED" - This is a known version of an SDK, and is supported.
	//   "STALE" - A newer version of the SDK family exists, and an update is
	// recommended.
	//   "DEPRECATED" - This version of the SDK is deprecated and will eventually
	// be unsupported.
	//   "UNSUPPORTED" - Support for this SDK version has ended and it should no
	// longer be used.
	SdkSupportStatus string `json:"sdkSupportStatus,omitempty"`
	// Version: The version of the SDK used to run the job.
	Version string `json:"version,omitempty"`
	// VersionDisplayName: A readable string describing the version of the SDK.
	VersionDisplayName string `json:"versionDisplayName,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Bugs") 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. "Bugs") 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:"-"`
}

SdkVersion: The version of the SDK used to run the job.

func (SdkVersion) MarshalJSON 

func (s SdkVersion) MarshalJSON() ([]byte, error)

type SendDebugCaptureRequest 

type SendDebugCaptureRequest struct {
	// ComponentId: The internal component id for which debug information is sent.
	ComponentId string `json:"componentId,omitempty"`
	// Data: The encoded debug information.
	Data string `json:"data,omitempty"`
	// DataFormat: Format for the data field above (id=5).
	//
	// Possible values:
	//   "DATA_FORMAT_UNSPECIFIED" - Format unspecified, parsing is determined
	// based upon page type and legacy encoding.
	// (go/protodosdonts#do-include-an-unspecified-value-in-an-enum)
	//   "RAW" - Raw HTML string.
	//   "JSON" - JSON-encoded string.
	//   "ZLIB" - Websafe encoded zlib-compressed string.
	//   "BROTLI" - Websafe encoded brotli-compressed string.
	DataFormat string `json:"dataFormat,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:"-"`
}

SendDebugCaptureRequest: Request to send encoded debug information. Next ID: 8

func (SendDebugCaptureRequest) MarshalJSON 

func (s SendDebugCaptureRequest) MarshalJSON() ([]byte, error)

type SendDebugCaptureResponse 

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

SendDebugCaptureResponse: Response to a send capture request. nothing

type SendWorkerMessagesRequest 

type SendWorkerMessagesRequest struct {
	// Location: The [regional endpoint]
	// (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that
	// contains the job.
	Location string `json:"location,omitempty"`
	// WorkerMessages: The WorkerMessages to send.
	WorkerMessages []*WorkerMessage `json:"workerMessages,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:"-"`
}

SendWorkerMessagesRequest: A request for sending worker messages to the service.

func (SendWorkerMessagesRequest) MarshalJSON 

func (s SendWorkerMessagesRequest) MarshalJSON() ([]byte, error)

type SendWorkerMessagesResponse 

type SendWorkerMessagesResponse struct {
	// WorkerMessageResponses: The servers response to the worker messages.
	WorkerMessageResponses []*WorkerMessageResponse `json:"workerMessageResponses,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "WorkerMessageResponses") 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. "WorkerMessageResponses") 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:"-"`
}

SendWorkerMessagesResponse: The response to the worker messages.

func (SendWorkerMessagesResponse) MarshalJSON 

func (s SendWorkerMessagesResponse) MarshalJSON() ([]byte, error)

type SeqMapTask 

type SeqMapTask struct {
	// Inputs: Information about each of the inputs.
	Inputs []*SideInputInfo `json:"inputs,omitempty"`
	// Name: The user-provided name of the SeqDo operation.
	Name string `json:"name,omitempty"`
	// OutputInfos: Information about each of the outputs.
	OutputInfos []*SeqMapTaskOutputInfo `json:"outputInfos,omitempty"`
	// StageName: System-defined name of the stage containing the SeqDo operation.
	// Unique across the workflow.
	StageName string `json:"stageName,omitempty"`
	// SystemName: System-defined name of the SeqDo operation. Unique across the
	// workflow.
	SystemName string `json:"systemName,omitempty"`
	// UserFn: The user function to invoke.
	UserFn googleapi.RawMessage `json:"userFn,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:"-"`
}

SeqMapTask: Describes a particular function to invoke.

func (SeqMapTask) MarshalJSON 

func (s SeqMapTask) MarshalJSON() ([]byte, error)

type SeqMapTaskOutputInfo 

type SeqMapTaskOutputInfo struct {
	// Sink: The sink to write the output value to.
	Sink *Sink `json:"sink,omitempty"`
	// Tag: The id of the TupleTag the user code will tag the output value by.
	Tag string `json:"tag,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Sink") 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. "Sink") 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:"-"`
}

SeqMapTaskOutputInfo: Information about an output of a SeqMapTask.

func (SeqMapTaskOutputInfo) MarshalJSON 

func (s SeqMapTaskOutputInfo) MarshalJSON() ([]byte, error)

type Service 

type Service struct {
	BasePath  string // API endpoint base URL
	UserAgent string // optional additional User-Agent fragment

	Projects *ProjectsService
	// contains filtered or unexported fields
}

func New deprecated 

func New(client *http.Client) (*Service, error)

New creates a new Service. It uses the provided http.Client for requests.

Deprecated: please use NewService instead. To provide a custom HTTP client, use option.WithHTTPClient. If you are using google.golang.org/api/googleapis/transport.APIKey, use option.WithAPIKey with NewService instead.

func NewService added in v0.3.0 

func NewService(ctx context.Context, opts ...option.ClientOption) (*Service, error)

NewService creates a new Service.

type ServiceResources added in v0.187.0 

type ServiceResources struct {
	// Zones: Output only. List of Cloud Zones being used by the Dataflow Service
	// for this job. Example: us-central1-c
	Zones []string `json:"zones,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Zones") 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. "Zones") 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:"-"`
}

ServiceResources: Resources used by the Dataflow Service to run the job.

func (ServiceResources) MarshalJSON added in v0.187.0 

func (s ServiceResources) MarshalJSON() ([]byte, error)

type ShellTask 

type ShellTask struct {
	// Command: The shell command to run.
	Command string `json:"command,omitempty"`
	// ExitCode: Exit code for the task.
	ExitCode int64 `json:"exitCode,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Command") 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. "Command") 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:"-"`
}

ShellTask: A task which consists of a shell command for the worker to execute.

func (ShellTask) MarshalJSON 

func (s ShellTask) MarshalJSON() ([]byte, error)

type SideInputInfo 

type SideInputInfo struct {
	// Kind: How to interpret the source element(s) as a side input value.
	Kind googleapi.RawMessage `json:"kind,omitempty"`
	// Sources: The source(s) to read element(s) from to get the value of this side
	// input. If more than one source, then the elements are taken from the
	// sources, in the specified order if order matters. At least one source is
	// required.
	Sources []*Source `json:"sources,omitempty"`
	// Tag: The id of the tag the user code will access this side input by; this
	// should correspond to the tag of some MultiOutputInfo.
	Tag string `json:"tag,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:"-"`
}

SideInputInfo: Information about a side input of a DoFn or an input of a SeqDoFn.

func (SideInputInfo) MarshalJSON 

func (s SideInputInfo) MarshalJSON() ([]byte, error)

type Sink 

type Sink struct {
	// Codec: The codec to use to encode data written to the sink.
	Codec googleapi.RawMessage `json:"codec,omitempty"`
	// Spec: The sink to write to, plus its parameters.
	Spec googleapi.RawMessage `json:"spec,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:"-"`
}

Sink: A sink that records can be encoded and written to.

func (Sink) MarshalJSON 

func (s Sink) MarshalJSON() ([]byte, error)

type Snapshot 

type Snapshot struct {
	// CreationTime: The time this snapshot was created.
	CreationTime string `json:"creationTime,omitempty"`
	// Description: User specified description of the snapshot. Maybe empty.
	Description string `json:"description,omitempty"`
	// DiskSizeBytes: The disk byte size of the snapshot. Only available for
	// snapshots in READY state.
	DiskSizeBytes int64 `json:"diskSizeBytes,omitempty,string"`
	// Id: The unique ID of this snapshot.
	Id string `json:"id,omitempty"`
	// ProjectId: The project this snapshot belongs to.
	ProjectId string `json:"projectId,omitempty"`
	// PubsubMetadata: Pub/Sub snapshot metadata.
	PubsubMetadata []*PubsubSnapshotMetadata `json:"pubsubMetadata,omitempty"`
	// Region: Cloud region where this snapshot lives in, e.g., "us-central1".
	Region string `json:"region,omitempty"`
	// SourceJobId: The job this snapshot was created from.
	SourceJobId string `json:"sourceJobId,omitempty"`
	// State: State of the snapshot.
	//
	// Possible values:
	//   "UNKNOWN_SNAPSHOT_STATE" - Unknown state.
	//   "PENDING" - Snapshot intent to create has been persisted, snapshotting of
	// state has not yet started.
	//   "RUNNING" - Snapshotting is being performed.
	//   "READY" - Snapshot has been created and is ready to be used.
	//   "FAILED" - Snapshot failed to be created.
	//   "DELETED" - Snapshot has been deleted.
	State string `json:"state,omitempty"`
	// Ttl: The time after which this snapshot will be automatically deleted.
	Ttl string `json:"ttl,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "CreationTime") 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. "CreationTime") 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:"-"`
}

Snapshot: Represents a snapshot of a job.

func (Snapshot) MarshalJSON 

func (s Snapshot) MarshalJSON() ([]byte, error)

type SnapshotJobRequest 

type SnapshotJobRequest struct {
	// Description: User specified description of the snapshot. Maybe empty.
	Description string `json:"description,omitempty"`
	// Location: The location that contains this job.
	Location string `json:"location,omitempty"`
	// SnapshotSources: If true, perform snapshots for sources which support this.
	SnapshotSources bool `json:"snapshotSources,omitempty"`
	// Ttl: TTL for the snapshot.
	Ttl string `json:"ttl,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:"-"`
}

SnapshotJobRequest: Request to create a snapshot of a job.

func (SnapshotJobRequest) MarshalJSON 

func (s SnapshotJobRequest) MarshalJSON() ([]byte, error)

type Source 

type Source struct {
	// BaseSpecs: While splitting, sources may specify the produced bundles as
	// differences against another source, in order to save backend-side memory and
	// allow bigger jobs. For details, see SourceSplitRequest. To support this use
	// case, the full set of parameters of the source is logically obtained by
	// taking the latest explicitly specified value of each parameter in the order:
	// base_specs (later items win), spec (overrides anything in base_specs).
	BaseSpecs []googleapi.RawMessage `json:"baseSpecs,omitempty"`
	// Codec: The codec to use to decode data read from the source.
	Codec googleapi.RawMessage `json:"codec,omitempty"`
	// DoesNotNeedSplitting: Setting this value to true hints to the framework that
	// the source doesn't need splitting, and using SourceSplitRequest on it would
	// yield SOURCE_SPLIT_OUTCOME_USE_CURRENT. E.g. a file splitter may set this to
	// true when splitting a single file into a set of byte ranges of appropriate
	// size, and set this to false when splitting a filepattern into individual
	// files. However, for efficiency, a file splitter may decide to produce file
	// subranges directly from the filepattern to avoid a splitting round-trip. See
	// SourceSplitRequest for an overview of the splitting process. This field is
	// meaningful only in the Source objects populated by the user (e.g. when
	// filling in a DerivedSource). Source objects supplied by the framework to the
	// user don't have this field populated.
	DoesNotNeedSplitting bool `json:"doesNotNeedSplitting,omitempty"`
	// Metadata: Optionally, metadata for this source can be supplied right away,
	// avoiding a SourceGetMetadataOperation roundtrip (see
	// SourceOperationRequest). This field is meaningful only in the Source objects
	// populated by the user (e.g. when filling in a DerivedSource). Source objects
	// supplied by the framework to the user don't have this field populated.
	Metadata *SourceMetadata `json:"metadata,omitempty"`
	// Spec: The source to read from, plus its parameters.
	Spec googleapi.RawMessage `json:"spec,omitempty"`
	// ForceSendFields is a list of field names (e.g. "BaseSpecs") 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. "BaseSpecs") 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:"-"`
}

Source: A source that records can be read and decoded from.

func (Source) MarshalJSON 

func (s Source) MarshalJSON() ([]byte, error)

type SourceFork 

type SourceFork struct {
	// Primary: DEPRECATED
	Primary *SourceSplitShard `json:"primary,omitempty"`
	// PrimarySource: DEPRECATED
	PrimarySource *DerivedSource `json:"primarySource,omitempty"`
	// Residual: DEPRECATED
	Residual *SourceSplitShard `json:"residual,omitempty"`
	// ResidualSource: DEPRECATED
	ResidualSource *DerivedSource `json:"residualSource,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:"-"`
}

SourceFork: DEPRECATED in favor of DynamicSourceSplit.

func (SourceFork) MarshalJSON 

func (s SourceFork) MarshalJSON() ([]byte, error)

type SourceGetMetadataRequest 

type SourceGetMetadataRequest struct {
	// Source: Specification of the source whose metadata should be computed.
	Source *Source `json:"source,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Source") 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. "Source") 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:"-"`
}

SourceGetMetadataRequest: A request to compute the SourceMetadata of a Source.

func (SourceGetMetadataRequest) MarshalJSON 

func (s SourceGetMetadataRequest) MarshalJSON() ([]byte, error)

type SourceGetMetadataResponse 

type SourceGetMetadataResponse struct {
	// Metadata: The computed metadata.
	Metadata *SourceMetadata `json:"metadata,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:"-"`
}

SourceGetMetadataResponse: The result of a SourceGetMetadataOperation.

func (SourceGetMetadataResponse) MarshalJSON 

func (s SourceGetMetadataResponse) MarshalJSON() ([]byte, error)

type SourceMetadata 

type SourceMetadata struct {
	// EstimatedSizeBytes: An estimate of the total size (in bytes) of the data
	// that would be read from this source. This estimate is in terms of external
	// storage size, before any decompression or other processing done by the
	// reader.
	EstimatedSizeBytes int64 `json:"estimatedSizeBytes,omitempty,string"`
	// Infinite: Specifies that the size of this source is known to be infinite
	// (this is a streaming source).
	Infinite bool `json:"infinite,omitempty"`
	// ProducesSortedKeys: Whether this source is known to produce key/value pairs
	// with the (encoded) keys in lexicographically sorted order.
	ProducesSortedKeys bool `json:"producesSortedKeys,omitempty"`
	// ForceSendFields is a list of field names (e.g. "EstimatedSizeBytes") 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. "EstimatedSizeBytes") 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:"-"`
}

SourceMetadata: Metadata about a Source useful for automatically optimizing and tuning the pipeline, etc.

func (SourceMetadata) MarshalJSON 

func (s SourceMetadata) MarshalJSON() ([]byte, error)

type SourceOperationRequest 

type SourceOperationRequest struct {
	// GetMetadata: Information about a request to get metadata about a source.
	GetMetadata *SourceGetMetadataRequest `json:"getMetadata,omitempty"`
	// Name: User-provided name of the Read instruction for this source.
	Name string `json:"name,omitempty"`
	// OriginalName: System-defined name for the Read instruction for this source
	// in the original workflow graph.
	OriginalName string `json:"originalName,omitempty"`
	// Split: Information about a request to split a source.
	Split *SourceSplitRequest `json:"split,omitempty"`
	// StageName: System-defined name of the stage containing the source operation.
	// Unique across the workflow.
	StageName string `json:"stageName,omitempty"`
	// SystemName: System-defined name of the Read instruction for this source.
	// Unique across the workflow.
	SystemName string `json:"systemName,omitempty"`
	// ForceSendFields is a list of field names (e.g. "GetMetadata") 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. "GetMetadata") 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:"-"`
}

SourceOperationRequest: A work item that represents the different operations that can be performed on a user-defined Source specification.

func (SourceOperationRequest) MarshalJSON 

func (s SourceOperationRequest) MarshalJSON() ([]byte, error)

type SourceOperationResponse 

type SourceOperationResponse struct {
	// GetMetadata: A response to a request to get metadata about a source.
	GetMetadata *SourceGetMetadataResponse `json:"getMetadata,omitempty"`
	// Split: A response to a request to split a source.
	Split *SourceSplitResponse `json:"split,omitempty"`
	// ForceSendFields is a list of field names (e.g. "GetMetadata") 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. "GetMetadata") 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:"-"`
}

SourceOperationResponse: The result of a SourceOperationRequest, specified in ReportWorkItemStatusRequest.source_operation when the work item is completed.

func (SourceOperationResponse) MarshalJSON 

func (s SourceOperationResponse) MarshalJSON() ([]byte, error)

type SourceSplitOptions 

type SourceSplitOptions struct {
	// DesiredBundleSizeBytes: The source should be split into a set of bundles
	// where the estimated size of each is approximately this many bytes.
	DesiredBundleSizeBytes int64 `json:"desiredBundleSizeBytes,omitempty,string"`
	// DesiredShardSizeBytes: DEPRECATED in favor of desired_bundle_size_bytes.
	DesiredShardSizeBytes int64 `json:"desiredShardSizeBytes,omitempty,string"`
	// ForceSendFields is a list of field names (e.g. "DesiredBundleSizeBytes") 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. "DesiredBundleSizeBytes") 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:"-"`
}

SourceSplitOptions: Hints for splitting a Source into bundles (parts for parallel processing) using SourceSplitRequest.

func (SourceSplitOptions) MarshalJSON 

func (s SourceSplitOptions) MarshalJSON() ([]byte, error)

type SourceSplitRequest 

type SourceSplitRequest struct {
	// Options: Hints for tuning the splitting process.
	Options *SourceSplitOptions `json:"options,omitempty"`
	// Source: Specification of the source to be split.
	Source *Source `json:"source,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Options") 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. "Options") 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:"-"`
}

SourceSplitRequest: Represents the operation to split a high-level Source specification into bundles (parts for parallel processing). At a high level, splitting of a source into bundles happens as follows: SourceSplitRequest is applied to the source. If it returns SOURCE_SPLIT_OUTCOME_USE_CURRENT, no further splitting happens and the source is used "as is". Otherwise, splitting is applied recursively to each produced DerivedSource. As an optimization, for any Source, if its does_not_need_splitting is true, the framework assumes that splitting this source would return SOURCE_SPLIT_OUTCOME_USE_CURRENT, and doesn't initiate a SourceSplitRequest. This applies both to the initial source being split and to bundles produced from it.

func (SourceSplitRequest) MarshalJSON 

func (s SourceSplitRequest) MarshalJSON() ([]byte, error)

type SourceSplitResponse 

type SourceSplitResponse struct {
	// Bundles: If outcome is SPLITTING_HAPPENED, then this is a list of bundles
	// into which the source was split. Otherwise this field is ignored. This list
	// can be empty, which means the source represents an empty input.
	Bundles []*DerivedSource `json:"bundles,omitempty"`
	// Outcome: Indicates whether splitting happened and produced a list of
	// bundles. If this is USE_CURRENT_SOURCE_AS_IS, the current source should be
	// processed "as is" without splitting. "bundles" is ignored in this case. If
	// this is SPLITTING_HAPPENED, then "bundles" contains a list of bundles into
	// which the source was split.
	//
	// Possible values:
	//   "SOURCE_SPLIT_OUTCOME_UNKNOWN" - The source split outcome is unknown, or
	// unspecified.
	//   "SOURCE_SPLIT_OUTCOME_USE_CURRENT" - The current source should be
	// processed "as is" without splitting.
	//   "SOURCE_SPLIT_OUTCOME_SPLITTING_HAPPENED" - Splitting produced a list of
	// bundles.
	Outcome string `json:"outcome,omitempty"`
	// Shards: DEPRECATED in favor of bundles.
	Shards []*SourceSplitShard `json:"shards,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Bundles") 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. "Bundles") 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:"-"`
}

SourceSplitResponse: The response to a SourceSplitRequest.

func (SourceSplitResponse) MarshalJSON 

func (s SourceSplitResponse) MarshalJSON() ([]byte, error)

type SourceSplitShard 

type SourceSplitShard struct {
	// DerivationMode: DEPRECATED
	//
	// 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: DEPRECATED
	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:"-"`
}

SourceSplitShard: DEPRECATED in favor of DerivedSource.

func (SourceSplitShard) MarshalJSON 

func (s SourceSplitShard) MarshalJSON() ([]byte, error)

type SpannerIODetails 

type SpannerIODetails struct {
	// DatabaseId: DatabaseId accessed in the connection.
	DatabaseId string `json:"databaseId,omitempty"`
	// InstanceId: InstanceId accessed in the connection.
	InstanceId string `json:"instanceId,omitempty"`
	// ProjectId: ProjectId accessed in the connection.
	ProjectId string `json:"projectId,omitempty"`
	// ForceSendFields is a list of field names (e.g. "DatabaseId") 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. "DatabaseId") 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:"-"`
}

SpannerIODetails: Metadata for a Spanner connector used by the job.

func (SpannerIODetails) MarshalJSON 

func (s SpannerIODetails) MarshalJSON() ([]byte, error)

type SplitInt64 

type SplitInt64 struct {
	// HighBits: The high order bits, including the sign: n >> 32.
	HighBits int64 `json:"highBits,omitempty"`
	// LowBits: The low order bits: n & 0xffffffff.
	LowBits int64 `json:"lowBits,omitempty"`
	// ForceSendFields is a list of field names (e.g. "HighBits") 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. "HighBits") 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:"-"`
}

SplitInt64: A representation of an int64, n, that is immune to precision loss when encoded in JSON.

func (SplitInt64) MarshalJSON 

func (s SplitInt64) MarshalJSON() ([]byte, error)

type StageExecutionDetails added in v0.31.0 

type StageExecutionDetails 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"`
	// Workers: Workers that have done work on the stage.
	Workers []*WorkerDetails `json:"workers,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:"-"`
}

StageExecutionDetails: Information about the workers and work items within a stage.

func (StageExecutionDetails) MarshalJSON added in v0.31.0 

func (s StageExecutionDetails) MarshalJSON() ([]byte, error)

type StageSource 

type StageSource 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"`
	// SizeBytes: Size of the source, if measurable.
	SizeBytes int64 `json:"sizeBytes,omitempty,string"`
	// UserName: Human-readable name for this source; 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:"-"`
}

StageSource: Description of an input or output of an execution stage.

func (StageSource) MarshalJSON 

func (s StageSource) MarshalJSON() ([]byte, error)

type StageSummary added in v0.31.0 

type StageSummary struct {
	// EndTime: End time of this stage. If the work item is completed, this is the
	// actual end time of the stage. Otherwise, it is the predicted end time.
	EndTime string `json:"endTime,omitempty"`
	// Metrics: Metrics for this stage.
	Metrics []*MetricUpdate `json:"metrics,omitempty"`
	// Progress: Progress for this stage. Only applicable to Batch jobs.
	Progress *ProgressTimeseries `json:"progress,omitempty"`
	// StageId: ID of this stage
	StageId string `json:"stageId,omitempty"`
	// StartTime: Start time of this stage.
	StartTime string `json:"startTime,omitempty"`
	// State: State of this stage.
	//
	// Possible values:
	//   "EXECUTION_STATE_UNKNOWN" - The component state is unknown or unspecified.
	//   "EXECUTION_STATE_NOT_STARTED" - The component is not yet running.
	//   "EXECUTION_STATE_RUNNING" - The component is currently running.
	//   "EXECUTION_STATE_SUCCEEDED" - The component succeeded.
	//   "EXECUTION_STATE_FAILED" - The component failed.
	//   "EXECUTION_STATE_CANCELLED" - Execution of the component was cancelled.
	State string `json:"state,omitempty"`
	// StragglerSummary: Straggler summary for this stage.
	StragglerSummary *StragglerSummary `json:"stragglerSummary,omitempty"`
	// ForceSendFields is a list of field names (e.g. "EndTime") 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. "EndTime") 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:"-"`
}

StageSummary: Information about a particular execution stage of a job.

func (StageSummary) MarshalJSON added in v0.31.0 

func (s StageSummary) MarshalJSON() ([]byte, error)

type StateFamilyConfig 

type StateFamilyConfig struct {
	// IsRead: If true, this family corresponds to a read operation.
	IsRead bool `json:"isRead,omitempty"`
	// StateFamily: The state family value.
	StateFamily string `json:"stateFamily,omitempty"`
	// ForceSendFields is a list of field names (e.g. "IsRead") 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. "IsRead") 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:"-"`
}

StateFamilyConfig: State family configuration.

func (StateFamilyConfig) MarshalJSON 

func (s StateFamilyConfig) MarshalJSON() ([]byte, error)

type Status 

type Status struct {
	// Code: The status code, which should be an enum value of google.rpc.Code.
	Code int64 `json:"code,omitempty"`
	// Details: A list of messages that carry the error details. There is a common
	// set of message types for APIs to use.
	Details []googleapi.RawMessage `json:"details,omitempty"`
	// Message: A developer-facing error message, which should be in English. Any
	// user-facing error message should be localized and sent in the
	// google.rpc.Status.details field, or localized by the client.
	Message string `json:"message,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Code") 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. "Code") 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:"-"`
}

Status: The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide (https://cloud.google.com/apis/design/errors).

func (Status) MarshalJSON 

func (s Status) MarshalJSON() ([]byte, error)

type Step 

type Step struct {
	// Kind: The kind of step in the Cloud Dataflow job.
	Kind string `json:"kind,omitempty"`
	// Name: The name that identifies the step. This must be unique for each step
	// with respect to all other steps in the Cloud Dataflow job.
	Name string `json:"name,omitempty"`
	// Properties: Named properties associated with the step. Each kind of
	// predefined step has its own required set of properties. Must be provided on
	// Create. Only retrieved with JOB_VIEW_ALL.
	Properties googleapi.RawMessage `json:"properties,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:"-"`
}

Step: Defines a particular step within a Cloud Dataflow job. A job consists of multiple steps, each of which performs some specific operation as part of the overall job. Data is typically passed from one step to another as part of the job. **Note:** The properties of this object are not stable and might change. Here's an example of a sequence of steps which together implement a Map-Reduce job: * Read a collection of data from some source, parsing the collection's elements. * Validate the elements. * Apply a user-defined function to map each element to some value and extract an element-specific key value. * Group elements with the same key into a single element with that key, transforming a multiply-keyed collection into a uniquely-keyed collection. * Write the elements out to some data sink. Note that the Cloud Dataflow service may be used to run many different types of jobs, not just Map-Reduce.

func (Step) MarshalJSON 

func (s Step) MarshalJSON() ([]byte, error)

type Straggler added in v0.107.0 

type Straggler struct {
	// BatchStraggler: Batch straggler identification and debugging information.
	BatchStraggler *StragglerInfo `json:"batchStraggler,omitempty"`
	// StreamingStraggler: Streaming straggler identification and debugging
	// information.
	StreamingStraggler *StreamingStragglerInfo `json:"streamingStraggler,omitempty"`
	// ForceSendFields is a list of field names (e.g. "BatchStraggler") 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. "BatchStraggler") 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:"-"`
}

Straggler: Information for a straggler.

func (Straggler) MarshalJSON added in v0.107.0 

func (s Straggler) MarshalJSON() ([]byte, error)

type StragglerDebuggingInfo added in v0.93.0 

type StragglerDebuggingInfo struct {
	// HotKey: Hot key debugging details.
	HotKey *HotKeyDebuggingInfo `json:"hotKey,omitempty"`
	// ForceSendFields is a list of field names (e.g. "HotKey") 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. "HotKey") 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:"-"`
}

StragglerDebuggingInfo: Information useful for debugging a straggler. Each type will provide specialized debugging information relevant for a particular cause. The StragglerDebuggingInfo will be 1:1 mapping to the StragglerCause enum.

func (StragglerDebuggingInfo) MarshalJSON added in v0.93.0 

func (s StragglerDebuggingInfo) MarshalJSON() ([]byte, error)

type StragglerInfo added in v0.93.0 

type StragglerInfo struct {
	// Causes: The straggler causes, keyed by the string representation of the
	// StragglerCause enum and contains specialized debugging information for each
	// straggler cause.
	Causes map[string]StragglerDebuggingInfo `json:"causes,omitempty"`
	// StartTime: The time when the work item attempt became a straggler.
	StartTime string `json:"startTime,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Causes") 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. "Causes") 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:"-"`
}

StragglerInfo: Information useful for straggler identification and debugging.

func (StragglerInfo) MarshalJSON added in v0.93.0 

func (s StragglerInfo) MarshalJSON() ([]byte, error)

type StragglerSummary added in v0.93.0 

type StragglerSummary struct {
	// RecentStragglers: The most recent stragglers.
	RecentStragglers []*Straggler `json:"recentStragglers,omitempty"`
	// StragglerCauseCount: Aggregated counts of straggler causes, keyed by the
	// string representation of the StragglerCause enum.
	StragglerCauseCount map[string]string `json:"stragglerCauseCount,omitempty"`
	// TotalStragglerCount: The total count of stragglers.
	TotalStragglerCount int64 `json:"totalStragglerCount,omitempty,string"`
	// ForceSendFields is a list of field names (e.g. "RecentStragglers") 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. "RecentStragglers") 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:"-"`
}

StragglerSummary: Summarized straggler identification details.

func (StragglerSummary) MarshalJSON added in v0.93.0 

func (s StragglerSummary) MarshalJSON() ([]byte, error)

type StreamLocation 

type StreamLocation struct {
	// CustomSourceLocation: The stream is a custom source.
	CustomSourceLocation *CustomSourceLocation `json:"customSourceLocation,omitempty"`
	// PubsubLocation: The stream is a pubsub stream.
	PubsubLocation *PubsubLocation `json:"pubsubLocation,omitempty"`
	// SideInputLocation: The stream is a streaming side input.
	SideInputLocation *StreamingSideInputLocation `json:"sideInputLocation,omitempty"`
	// StreamingStageLocation: The stream is part of another computation within the
	// current streaming Dataflow job.
	StreamingStageLocation *StreamingStageLocation `json:"streamingStageLocation,omitempty"`
	// ForceSendFields is a list of field names (e.g. "CustomSourceLocation") 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. "CustomSourceLocation") 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:"-"`
}

StreamLocation: Describes a stream of data, either as input to be processed or as output of a streaming Dataflow job.

func (StreamLocation) MarshalJSON 

func (s StreamLocation) MarshalJSON() ([]byte, error)

type StreamingApplianceSnapshotConfig 

type StreamingApplianceSnapshotConfig struct {
	// ImportStateEndpoint: Indicates which endpoint is used to import appliance
	// state.
	ImportStateEndpoint string `json:"importStateEndpoint,omitempty"`
	// SnapshotId: If set, indicates the snapshot id for the snapshot being
	// performed.
	SnapshotId string `json:"snapshotId,omitempty"`
	// ForceSendFields is a list of field names (e.g. "ImportStateEndpoint") 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. "ImportStateEndpoint") 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:"-"`
}

StreamingApplianceSnapshotConfig: Streaming appliance snapshot configuration.

func (StreamingApplianceSnapshotConfig) MarshalJSON 

func (s StreamingApplianceSnapshotConfig) MarshalJSON() ([]byte, error)

type StreamingComputationConfig 

type StreamingComputationConfig struct {
	// ComputationId: Unique identifier for this computation.
	ComputationId string `json:"computationId,omitempty"`
	// Instructions: Instructions that comprise the computation.
	Instructions []*ParallelInstruction `json:"instructions,omitempty"`
	// StageName: Stage name of this computation.
	StageName string `json:"stageName,omitempty"`
	// SystemName: System defined name for this computation.
	SystemName string `json:"systemName,omitempty"`
	// TransformUserNameToStateFamily: Map from user name of stateful transforms in
	// this stage to their state family.
	TransformUserNameToStateFamily map[string]string `json:"transformUserNameToStateFamily,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:"-"`
}

StreamingComputationConfig: Configuration information for a single streaming computation.

func (StreamingComputationConfig) MarshalJSON 

func (s StreamingComputationConfig) MarshalJSON() ([]byte, error)

type StreamingComputationRanges 

type StreamingComputationRanges struct {
	// ComputationId: The ID of the computation.
	ComputationId string `json:"computationId,omitempty"`
	// RangeAssignments: Data disk assignments for ranges from this computation.
	RangeAssignments []*KeyRangeDataDiskAssignment `json:"rangeAssignments,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:"-"`
}

StreamingComputationRanges: Describes full or partial data disk assignment information of the computation ranges.

func (StreamingComputationRanges) MarshalJSON 

func (s StreamingComputationRanges) MarshalJSON() ([]byte, error)

type StreamingComputationTask 

type StreamingComputationTask struct {
	// ComputationRanges: Contains ranges of a streaming computation this task
	// should apply to.
	ComputationRanges []*StreamingComputationRanges `json:"computationRanges,omitempty"`
	// DataDisks: Describes the set of data disks this task should apply to.
	DataDisks []*MountedDataDisk `json:"dataDisks,omitempty"`
	// TaskType: A type of streaming computation task.
	//
	// Possible values:
	//   "STREAMING_COMPUTATION_TASK_UNKNOWN" - The streaming computation task is
	// unknown, or unspecified.
	//   "STREAMING_COMPUTATION_TASK_STOP" - Stop processing specified streaming
	// computation range(s).
	//   "STREAMING_COMPUTATION_TASK_START" - Start processing specified streaming
	// computation range(s).
	TaskType string `json:"taskType,omitempty"`
	// ForceSendFields is a list of field names (e.g. "ComputationRanges") 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. "ComputationRanges") 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:"-"`
}

StreamingComputationTask: A task which describes what action should be performed for the specified streaming computation ranges.

func (StreamingComputationTask) MarshalJSON 

func (s StreamingComputationTask) MarshalJSON() ([]byte, error)

type StreamingConfigTask 

type StreamingConfigTask struct {
	// CommitStreamChunkSizeBytes: Chunk size for commit streams from the harness
	// to windmill.
	CommitStreamChunkSizeBytes int64 `json:"commitStreamChunkSizeBytes,omitempty,string"`
	// GetDataStreamChunkSizeBytes: Chunk size for get data streams from the
	// harness to windmill.
	GetDataStreamChunkSizeBytes int64 `json:"getDataStreamChunkSizeBytes,omitempty,string"`
	// MaxWorkItemCommitBytes: Maximum size for work item commit supported windmill
	// storage layer.
	MaxWorkItemCommitBytes int64 `json:"maxWorkItemCommitBytes,omitempty,string"`
	// OperationalLimits: Operational limits for the streaming job. Can be used by
	// the worker to validate outputs sent to the backend.
	OperationalLimits *StreamingOperationalLimits `json:"operationalLimits,omitempty"`
	// StreamingComputationConfigs: Set of computation configuration information.
	StreamingComputationConfigs []*StreamingComputationConfig `json:"streamingComputationConfigs,omitempty"`
	// UserStepToStateFamilyNameMap: Map from user step names to state families.
	UserStepToStateFamilyNameMap map[string]string `json:"userStepToStateFamilyNameMap,omitempty"`
	// UserWorkerRunnerV1Settings: Binary encoded proto to control runtime behavior
	// of the java runner v1 user worker.
	UserWorkerRunnerV1Settings string `json:"userWorkerRunnerV1Settings,omitempty"`
	// UserWorkerRunnerV2Settings: Binary encoded proto to control runtime behavior
	// of the runner v2 user worker.
	UserWorkerRunnerV2Settings string `json:"userWorkerRunnerV2Settings,omitempty"`
	// WindmillServiceEndpoint: If present, the worker must use this endpoint to
	// communicate with Windmill Service dispatchers, otherwise the worker must
	// continue to use whatever endpoint it had been using.
	WindmillServiceEndpoint string `json:"windmillServiceEndpoint,omitempty"`
	// WindmillServicePort: If present, the worker must use this port to
	// communicate with Windmill Service dispatchers. Only applicable when
	// windmill_service_endpoint is specified.
	WindmillServicePort int64 `json:"windmillServicePort,omitempty,string"`
	// ForceSendFields is a list of field names (e.g. "CommitStreamChunkSizeBytes")
	// 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. "CommitStreamChunkSizeBytes") 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:"-"`
}

StreamingConfigTask: A task that carries configuration information for streaming computations.

func (StreamingConfigTask) MarshalJSON 

func (s StreamingConfigTask) MarshalJSON() ([]byte, error)

type StreamingOperationalLimits added in v0.178.0 

type StreamingOperationalLimits struct {
	// MaxBagElementBytes: The maximum size for an element in bag state.
	MaxBagElementBytes int64 `json:"maxBagElementBytes,omitempty,string"`
	// MaxGlobalDataBytes: The maximum size for an element in global data.
	MaxGlobalDataBytes int64 `json:"maxGlobalDataBytes,omitempty,string"`
	// MaxKeyBytes: The maximum size allowed for a key.
	MaxKeyBytes int64 `json:"maxKeyBytes,omitempty,string"`
	// MaxProductionOutputBytes: The maximum size for a single output element.
	MaxProductionOutputBytes int64 `json:"maxProductionOutputBytes,omitempty,string"`
	// MaxSortedListElementBytes: The maximum size for an element in sorted list
	// state.
	MaxSortedListElementBytes int64 `json:"maxSortedListElementBytes,omitempty,string"`
	// MaxSourceStateBytes: The maximum size for a source state update.
	MaxSourceStateBytes int64 `json:"maxSourceStateBytes,omitempty,string"`
	// MaxTagBytes: The maximum size for a state tag.
	MaxTagBytes int64 `json:"maxTagBytes,omitempty,string"`
	// MaxValueBytes: The maximum size for a value state field.
	MaxValueBytes int64 `json:"maxValueBytes,omitempty,string"`
	// ForceSendFields is a list of field names (e.g. "MaxBagElementBytes") 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. "MaxBagElementBytes") 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:"-"`
}

StreamingOperationalLimits: Operational limits imposed on streaming jobs by the backend.

func (StreamingOperationalLimits) MarshalJSON added in v0.178.0 

func (s StreamingOperationalLimits) MarshalJSON() ([]byte, error)

type StreamingScalingReport added in v0.154.0 

type StreamingScalingReport struct {
	ActiveBundleCount int64 `json:"activeBundleCount,omitempty"`
	// ActiveThreadCount: Current acive thread count.
	ActiveThreadCount int64 `json:"activeThreadCount,omitempty"`
	// MaximumBundleCount: Maximum bundle count.
	MaximumBundleCount int64 `json:"maximumBundleCount,omitempty"`
	// MaximumBytes: Maximum bytes.
	MaximumBytes      int64 `json:"maximumBytes,omitempty,string"`
	MaximumBytesCount int64 `json:"maximumBytesCount,omitempty"`
	// MaximumThreadCount: Maximum thread count limit.
	MaximumThreadCount int64 `json:"maximumThreadCount,omitempty"`
	// OutstandingBundleCount: Current outstanding bundle count.
	OutstandingBundleCount int64 `json:"outstandingBundleCount,omitempty"`
	// OutstandingBytes: Current outstanding bytes.
	OutstandingBytes      int64 `json:"outstandingBytes,omitempty,string"`
	OutstandingBytesCount int64 `json:"outstandingBytesCount,omitempty"`
	// ForceSendFields is a list of field names (e.g. "ActiveBundleCount") 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. "ActiveBundleCount") 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:"-"`
}

StreamingScalingReport: Contains per-user worker telemetry used in streaming autoscaling.

func (StreamingScalingReport) MarshalJSON added in v0.154.0 

func (s StreamingScalingReport) MarshalJSON() ([]byte, error)

type StreamingScalingReportResponse added in v0.167.0 

type StreamingScalingReportResponse struct {
	// MaximumThreadCount: Maximum thread count limit;
	MaximumThreadCount int64 `json:"maximumThreadCount,omitempty"`
	// ForceSendFields is a list of field names (e.g. "MaximumThreadCount") 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. "MaximumThreadCount") 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:"-"`
}

StreamingScalingReportResponse: Contains per-user-worker streaming scaling recommendation from the backend.

func (StreamingScalingReportResponse) MarshalJSON added in v0.167.0 

func (s StreamingScalingReportResponse) MarshalJSON() ([]byte, error)

type StreamingSetupTask 

type StreamingSetupTask struct {
	// Drain: The user has requested drain.
	Drain bool `json:"drain,omitempty"`
	// ReceiveWorkPort: The TCP port on which the worker should listen for messages
	// from other streaming computation workers.
	ReceiveWorkPort int64 `json:"receiveWorkPort,omitempty"`
	// SnapshotConfig: Configures streaming appliance snapshot.
	SnapshotConfig *StreamingApplianceSnapshotConfig `json:"snapshotConfig,omitempty"`
	// StreamingComputationTopology: The global topology of the streaming Dataflow
	// job.
	StreamingComputationTopology *TopologyConfig `json:"streamingComputationTopology,omitempty"`
	// WorkerHarnessPort: The TCP port used by the worker to communicate with the
	// Dataflow worker harness.
	WorkerHarnessPort int64 `json:"workerHarnessPort,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Drain") 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. "Drain") 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:"-"`
}

StreamingSetupTask: A task which initializes part of a streaming Dataflow job.

func (StreamingSetupTask) MarshalJSON 

func (s StreamingSetupTask) MarshalJSON() ([]byte, error)

type StreamingSideInputLocation 

type StreamingSideInputLocation struct {
	// StateFamily: Identifies the state family where this side input is stored.
	StateFamily string `json:"stateFamily,omitempty"`
	// Tag: Identifies the particular side input within the streaming Dataflow job.
	Tag string `json:"tag,omitempty"`
	// ForceSendFields is a list of field names (e.g. "StateFamily") 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. "StateFamily") 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:"-"`
}

StreamingSideInputLocation: Identifies the location of a streaming side input.

func (StreamingSideInputLocation) MarshalJSON 

func (s StreamingSideInputLocation) MarshalJSON() ([]byte, error)

type StreamingStageLocation 

type StreamingStageLocation struct {
	// StreamId: Identifies the particular stream within the streaming Dataflow
	// job.
	StreamId string `json:"streamId,omitempty"`
	// ForceSendFields is a list of field names (e.g. "StreamId") 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. "StreamId") 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:"-"`
}

StreamingStageLocation: Identifies the location of a streaming computation stage, for stage-to-stage communication.

func (StreamingStageLocation) MarshalJSON 

func (s StreamingStageLocation) MarshalJSON() ([]byte, error)

type StreamingStragglerInfo added in v0.107.0 

type StreamingStragglerInfo struct {
	// DataWatermarkLag: The event-time watermark lag at the time of the straggler
	// detection.
	DataWatermarkLag string `json:"dataWatermarkLag,omitempty"`
	// EndTime: End time of this straggler.
	EndTime string `json:"endTime,omitempty"`
	// StartTime: Start time of this straggler.
	StartTime string `json:"startTime,omitempty"`
	// SystemWatermarkLag: The system watermark lag at the time of the straggler
	// detection.
	SystemWatermarkLag string `json:"systemWatermarkLag,omitempty"`
	// WorkerName: Name of the worker where the straggler was detected.
	WorkerName string `json:"workerName,omitempty"`
	// ForceSendFields is a list of field names (e.g. "DataWatermarkLag") 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. "DataWatermarkLag") 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:"-"`
}

StreamingStragglerInfo: Information useful for streaming straggler identification and debugging.

func (StreamingStragglerInfo) MarshalJSON added in v0.107.0 

func (s StreamingStragglerInfo) MarshalJSON() ([]byte, error)

type StringList 

type StringList struct {
	// Elements: Elements of the list.
	Elements []string `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:"-"`
}

StringList: A metric value representing a list of strings.

func (StringList) MarshalJSON 

func (s StringList) MarshalJSON() ([]byte, error)

type StructuredMessage 

type StructuredMessage struct {
	// MessageKey: Identifier for this message type. Used by external systems to
	// internationalize or personalize message.
	MessageKey string `json:"messageKey,omitempty"`
	// MessageText: Human-readable version of message.
	MessageText string `json:"messageText,omitempty"`
	// Parameters: The structured data associated with this message.
	Parameters []*Parameter `json:"parameters,omitempty"`
	// ForceSendFields is a list of field names (e.g. "MessageKey") 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. "MessageKey") 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:"-"`
}

StructuredMessage: A rich message format, including a human readable string, a key for identifying the message, and structured data associated with the message for programmatic consumption.

func (StructuredMessage) MarshalJSON 

func (s StructuredMessage) MarshalJSON() ([]byte, error)

type TaskRunnerSettings 

type TaskRunnerSettings struct {
	// Alsologtostderr: Whether to also send taskrunner log info to stderr.
	Alsologtostderr bool `json:"alsologtostderr,omitempty"`
	// BaseTaskDir: The location on the worker for task-specific subdirectories.
	BaseTaskDir string `json:"baseTaskDir,omitempty"`
	// BaseUrl: The base URL for the taskrunner to use when accessing Google Cloud
	// APIs. When workers access Google Cloud APIs, they logically do so via
	// relative URLs. If this field is specified, it supplies the base URL to use
	// for resolving these relative URLs. The normative algorithm used is defined
	// by RFC 1808, "Relative Uniform Resource Locators". If not specified, the
	// default value is "http://www.googleapis.com/"
	BaseUrl string `json:"baseUrl,omitempty"`
	// CommandlinesFileName: The file to store preprocessing commands in.
	CommandlinesFileName string `json:"commandlinesFileName,omitempty"`
	// ContinueOnException: Whether to continue taskrunner if an exception is hit.
	ContinueOnException bool `json:"continueOnException,omitempty"`
	// DataflowApiVersion: The API version of endpoint, e.g. "v1b3"
	DataflowApiVersion string `json:"dataflowApiVersion,omitempty"`
	// HarnessCommand: The command to launch the worker harness.
	HarnessCommand string `json:"harnessCommand,omitempty"`
	// LanguageHint: The suggested backend language.
	LanguageHint string `json:"languageHint,omitempty"`
	// LogDir: The directory on the VM to store logs.
	LogDir string `json:"logDir,omitempty"`
	// LogToSerialconsole: Whether to send taskrunner log info to Google Compute
	// Engine VM serial console.
	LogToSerialconsole bool `json:"logToSerialconsole,omitempty"`
	// LogUploadLocation: Indicates where to put logs. If this is not specified,
	// the logs will not be uploaded. The supported resource type is: Google Cloud
	// Storage: storage.googleapis.com/{bucket}/{object}
	// bucket.storage.googleapis.com/{object}
	LogUploadLocation string `json:"logUploadLocation,omitempty"`
	// OauthScopes: The OAuth2 scopes to be requested by the taskrunner in order to
	// access the Cloud Dataflow API.
	OauthScopes []string `json:"oauthScopes,omitempty"`
	// ParallelWorkerSettings: The settings to pass to the parallel worker harness.
	ParallelWorkerSettings *WorkerSettings `json:"parallelWorkerSettings,omitempty"`
	// StreamingWorkerMainClass: The streaming worker main class name.
	StreamingWorkerMainClass string `json:"streamingWorkerMainClass,omitempty"`
	// TaskGroup: The UNIX group ID on the worker VM to use for tasks launched by
	// taskrunner; e.g. "wheel".
	TaskGroup string `json:"taskGroup,omitempty"`
	// TaskUser: The UNIX user ID on the worker VM to use for tasks launched by
	// taskrunner; e.g. "root".
	TaskUser string `json:"taskUser,omitempty"`
	// TempStoragePrefix: The prefix of the resources the taskrunner should use for
	// temporary storage. The supported resource type is: Google Cloud Storage:
	// storage.googleapis.com/{bucket}/{object}
	// bucket.storage.googleapis.com/{object}
	TempStoragePrefix string `json:"tempStoragePrefix,omitempty"`
	// VmId: The ID string of the VM.
	VmId string `json:"vmId,omitempty"`
	// WorkflowFileName: The file to store the workflow in.
	WorkflowFileName string `json:"workflowFileName,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Alsologtostderr") 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. "Alsologtostderr") 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:"-"`
}

TaskRunnerSettings: Taskrunner configuration settings.

func (TaskRunnerSettings) MarshalJSON 

func (s TaskRunnerSettings) MarshalJSON() ([]byte, error)

type TemplateMetadata 

type TemplateMetadata struct {
	// DefaultStreamingMode: Optional. Indicates the default streaming mode for a
	// streaming template. Only valid if both supports_at_least_once and
	// supports_exactly_once are true. Possible values: UNSPECIFIED, EXACTLY_ONCE
	// and AT_LEAST_ONCE
	DefaultStreamingMode string `json:"defaultStreamingMode,omitempty"`
	// Description: Optional. A description of the template.
	Description string `json:"description,omitempty"`
	// Name: Required. The name of the template.
	Name string `json:"name,omitempty"`
	// Parameters: The parameters for the template.
	Parameters []*ParameterMetadata `json:"parameters,omitempty"`
	// Streaming: Optional. Indicates if the template is streaming or not.
	Streaming bool `json:"streaming,omitempty"`
	// SupportsAtLeastOnce: Optional. Indicates if the streaming template supports
	// at least once mode.
	SupportsAtLeastOnce bool `json:"supportsAtLeastOnce,omitempty"`
	// SupportsExactlyOnce: Optional. Indicates if the streaming template supports
	// exactly once mode.
	SupportsExactlyOnce bool `json:"supportsExactlyOnce,omitempty"`
	// ForceSendFields is a list of field names (e.g. "DefaultStreamingMode") 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. "DefaultStreamingMode") 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:"-"`
}

TemplateMetadata: Metadata describing a template.

func (TemplateMetadata) MarshalJSON 

func (s TemplateMetadata) MarshalJSON() ([]byte, error)

type TopologyConfig 

type TopologyConfig struct {
	// Computations: The computations associated with a streaming Dataflow job.
	Computations []*ComputationTopology `json:"computations,omitempty"`
	// DataDiskAssignments: The disks assigned to a streaming Dataflow job.
	DataDiskAssignments []*DataDiskAssignment `json:"dataDiskAssignments,omitempty"`
	// ForwardingKeyBits: The size (in bits) of keys that will be assigned to
	// source messages.
	ForwardingKeyBits int64 `json:"forwardingKeyBits,omitempty"`
	// PersistentStateVersion: Version number for persistent state.
	PersistentStateVersion int64 `json:"persistentStateVersion,omitempty"`
	// UserStageToComputationNameMap: Maps user stage names to stable computation
	// names.
	UserStageToComputationNameMap map[string]string `json:"userStageToComputationNameMap,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Computations") 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. "Computations") 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:"-"`
}

TopologyConfig: Global topology of the streaming Dataflow job, including all computations and their sharded locations.

func (TopologyConfig) MarshalJSON 

func (s TopologyConfig) MarshalJSON() ([]byte, error)

type TransformSummary 

type TransformSummary struct {
	// DisplayData: Transform-specific display data.
	DisplayData []*DisplayData `json:"displayData,omitempty"`
	// Id: SDK generated id of this transform instance.
	Id string `json:"id,omitempty"`
	// InputCollectionName: User names for all collection inputs to this transform.
	InputCollectionName []string `json:"inputCollectionName,omitempty"`
	// Kind: Type of transform.
	//
	// 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: User provided name for this transform instance.
	Name string `json:"name,omitempty"`
	// OutputCollectionName: User names for all collection outputs to this
	// transform.
	OutputCollectionName []string `json:"outputCollectionName,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:"-"`
}

TransformSummary: Description of the type, names/ids, and input/outputs for a transform.

func (TransformSummary) MarshalJSON 

func (s TransformSummary) MarshalJSON() ([]byte, error)

type WorkItem 

type WorkItem struct {
	// Configuration: Work item-specific configuration as an opaque blob.
	Configuration string `json:"configuration,omitempty"`
	// Id: Identifies this WorkItem.
	Id int64 `json:"id,omitempty,string"`
	// InitialReportIndex: The initial index to use when reporting the status of
	// the WorkItem.
	InitialReportIndex int64 `json:"initialReportIndex,omitempty,string"`
	// JobId: Identifies the workflow job this WorkItem belongs to.
	JobId string `json:"jobId,omitempty"`
	// LeaseExpireTime: Time when the lease on this Work will expire.
	LeaseExpireTime string `json:"leaseExpireTime,omitempty"`
	// MapTask: Additional information for MapTask WorkItems.
	MapTask *MapTask `json:"mapTask,omitempty"`
	// Packages: Any required packages that need to be fetched in order to execute
	// this WorkItem.
	Packages []*Package `json:"packages,omitempty"`
	// ProjectId: Identifies the cloud project this WorkItem belongs to.
	ProjectId string `json:"projectId,omitempty"`
	// ReportStatusInterval: Recommended reporting interval.
	ReportStatusInterval string `json:"reportStatusInterval,omitempty"`
	// SeqMapTask: Additional information for SeqMapTask WorkItems.
	SeqMapTask *SeqMapTask `json:"seqMapTask,omitempty"`
	// ShellTask: Additional information for ShellTask WorkItems.
	ShellTask *ShellTask `json:"shellTask,omitempty"`
	// SourceOperationTask: Additional information for source operation WorkItems.
	SourceOperationTask *SourceOperationRequest `json:"sourceOperationTask,omitempty"`
	// StreamingComputationTask: Additional information for
	// StreamingComputationTask WorkItems.
	StreamingComputationTask *StreamingComputationTask `json:"streamingComputationTask,omitempty"`
	// StreamingConfigTask: Additional information for StreamingConfigTask
	// WorkItems.
	StreamingConfigTask *StreamingConfigTask `json:"streamingConfigTask,omitempty"`
	// StreamingSetupTask: Additional information for StreamingSetupTask WorkItems.
	StreamingSetupTask *StreamingSetupTask `json:"streamingSetupTask,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Configuration") 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. "Configuration") 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:"-"`
}

WorkItem: WorkItem represents basic information about a WorkItem to be executed in the cloud.

func (WorkItem) MarshalJSON 

func (s WorkItem) MarshalJSON() ([]byte, error)

type WorkItemDetails added in v0.31.0 

type WorkItemDetails struct {
	// AttemptId: Attempt ID of this work item
	AttemptId string `json:"attemptId,omitempty"`
	// EndTime: End time of this work item attempt. If the work item is completed,
	// this is the actual end time of the work item. Otherwise, it is the predicted
	// end time.
	EndTime string `json:"endTime,omitempty"`
	// Metrics: Metrics for this work item.
	Metrics []*MetricUpdate `json:"metrics,omitempty"`
	// Progress: Progress of this work item.
	Progress *ProgressTimeseries `json:"progress,omitempty"`
	// StartTime: Start time of this work item attempt.
	StartTime string `json:"startTime,omitempty"`
	// State: State of this work item.
	//
	// Possible values:
	//   "EXECUTION_STATE_UNKNOWN" - The component state is unknown or unspecified.
	//   "EXECUTION_STATE_NOT_STARTED" - The component is not yet running.
	//   "EXECUTION_STATE_RUNNING" - The component is currently running.
	//   "EXECUTION_STATE_SUCCEEDED" - The component succeeded.
	//   "EXECUTION_STATE_FAILED" - The component failed.
	//   "EXECUTION_STATE_CANCELLED" - Execution of the component was cancelled.
	State string `json:"state,omitempty"`
	// StragglerInfo: Information about straggler detections for this work item.
	StragglerInfo *StragglerInfo `json:"stragglerInfo,omitempty"`
	// TaskId: Name of this work item.
	TaskId string `json:"taskId,omitempty"`
	// ForceSendFields is a list of field names (e.g. "AttemptId") 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. "AttemptId") 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:"-"`
}

WorkItemDetails: Information about an individual work item execution.

func (WorkItemDetails) MarshalJSON added in v0.31.0 

func (s WorkItemDetails) MarshalJSON() ([]byte, error)

type WorkItemServiceState 

type WorkItemServiceState struct {
	// CompleteWorkStatus: If set, a request to complete the work item with the
	// given status. This will not be set to OK, unless supported by the specific
	// kind of WorkItem. It can be used for the backend to indicate a WorkItem must
	// terminate, e.g., for aborting work.
	CompleteWorkStatus *Status `json:"completeWorkStatus,omitempty"`
	// HarnessData: Other data returned by the service, specific to the particular
	// worker harness.
	HarnessData googleapi.RawMessage `json:"harnessData,omitempty"`
	// HotKeyDetection: A hot key is a symptom of poor data distribution in which
	// there are enough elements mapped to a single key to impact pipeline
	// performance. When present, this field includes metadata associated with any
	// hot key.
	HotKeyDetection *HotKeyDetection `json:"hotKeyDetection,omitempty"`
	// LeaseExpireTime: Time at which the current lease will expire.
	LeaseExpireTime string `json:"leaseExpireTime,omitempty"`
	// MetricShortId: The short ids that workers should use in subsequent metric
	// updates. Workers should strive to use short ids whenever possible, but it is
	// ok to request the short_id again if a worker lost track of it (e.g. if the
	// worker is recovering from a crash). NOTE: it is possible that the response
	// may have short ids for a subset of the metrics.
	MetricShortId []*MetricShortId `json:"metricShortId,omitempty"`
	// NextReportIndex: The index value to use for the next report sent by the
	// worker. Note: If the report call fails for whatever reason, the worker
	// should reuse this index for subsequent report attempts.
	NextReportIndex int64 `json:"nextReportIndex,omitempty,string"`
	// ReportStatusInterval: New recommended reporting interval.
	ReportStatusInterval string `json:"reportStatusInterval,omitempty"`
	// SplitRequest: The progress point in the WorkItem where the Dataflow service
	// suggests that the worker truncate the task.
	SplitRequest *ApproximateSplitRequest `json:"splitRequest,omitempty"`
	// SuggestedStopPoint: DEPRECATED in favor of split_request.
	SuggestedStopPoint *ApproximateProgress `json:"suggestedStopPoint,omitempty"`
	// SuggestedStopPosition: Obsolete, always empty.
	SuggestedStopPosition *Position `json:"suggestedStopPosition,omitempty"`
	// ForceSendFields is a list of field names (e.g. "CompleteWorkStatus") 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. "CompleteWorkStatus") 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:"-"`
}

WorkItemServiceState: The Dataflow service's idea of the current state of a WorkItem being processed by a worker.

func (WorkItemServiceState) MarshalJSON 

func (s WorkItemServiceState) MarshalJSON() ([]byte, error)

type WorkItemStatus 

type WorkItemStatus struct {
	// Completed: True if the WorkItem was completed (successfully or
	// unsuccessfully).
	Completed bool `json:"completed,omitempty"`
	// CounterUpdates: Worker output counters for this WorkItem.
	CounterUpdates []*CounterUpdate `json:"counterUpdates,omitempty"`
	// DynamicSourceSplit: See documentation of stop_position.
	DynamicSourceSplit *DynamicSourceSplit `json:"dynamicSourceSplit,omitempty"`
	// Errors: Specifies errors which occurred during processing. If errors are
	// provided, and completed = true, then the WorkItem is considered to have
	// failed.
	Errors []*Status `json:"errors,omitempty"`
	// MetricUpdates: DEPRECATED in favor of counter_updates.
	MetricUpdates []*MetricUpdate `json:"metricUpdates,omitempty"`
	// Progress: DEPRECATED in favor of reported_progress.
	Progress *ApproximateProgress `json:"progress,omitempty"`
	// ReportIndex: The report index. When a WorkItem is leased, the lease will
	// contain an initial report index. When a WorkItem's status is reported to the
	// system, the report should be sent with that report index, and the response
	// will contain the index the worker should use for the next report. Reports
	// received with unexpected index values will be rejected by the service. In
	// order to preserve idempotency, the worker should not alter the contents of a
	// report, even if the worker must submit the same report multiple times before
	// getting back a response. The worker should not submit a subsequent report
	// until the response for the previous report had been received from the
	// service.
	ReportIndex int64 `json:"reportIndex,omitempty,string"`
	// ReportedProgress: The worker's progress through this WorkItem.
	ReportedProgress *ApproximateReportedProgress `json:"reportedProgress,omitempty"`
	// RequestedLeaseDuration: Amount of time the worker requests for its lease.
	RequestedLeaseDuration string `json:"requestedLeaseDuration,omitempty"`
	// SourceFork: DEPRECATED in favor of dynamic_source_split.
	SourceFork *SourceFork `json:"sourceFork,omitempty"`
	// SourceOperationResponse: If the work item represented a
	// SourceOperationRequest, and the work is completed, contains the result of
	// the operation.
	SourceOperationResponse *SourceOperationResponse `json:"sourceOperationResponse,omitempty"`
	// StopPosition: A worker may split an active map task in two parts, "primary"
	// and "residual", continuing to process the primary part and returning the
	// residual part into the pool of available work. This event is called a
	// "dynamic split" and is critical to the dynamic work rebalancing feature. The
	// two obtained sub-tasks are called "parts" of the split. The parts, if
	// concatenated, must represent the same input as would be read by the current
	// task if the split did not happen. The exact way in which the original task
	// is decomposed into the two parts is specified either as a position
	// demarcating them (stop_position), or explicitly as two DerivedSources, if
	// this task consumes a user-defined source type (dynamic_source_split). The
	// "current" task is adjusted as a result of the split: after a task with range
	// [A, B) sends a stop_position update at C, its range is considered to be [A,
	// C), e.g.: * Progress should be interpreted relative to the new range, e.g.
	// "75% completed" means "75% of [A, C) completed" * The worker should
	// interpret proposed_stop_position relative to the new range, e.g. "split at
	// 68%" should be interpreted as "split at 68% of [A, C)". * If the worker
	// chooses to split again using stop_position, only stop_positions in [A, C)
	// will be accepted. * Etc. dynamic_source_split has similar semantics: e.g.,
	// if a task with source S splits using dynamic_source_split into {P, R} (where
	// P and R must be together equivalent to S), then subsequent progress and
	// proposed_stop_position should be interpreted relative to P, and in a
	// potential subsequent dynamic_source_split into {P', R'}, P' and R' must be
	// together equivalent to P, etc.
	StopPosition *Position `json:"stopPosition,omitempty"`
	// TotalThrottlerWaitTimeSeconds: Total time the worker spent being throttled
	// by external systems.
	TotalThrottlerWaitTimeSeconds float64 `json:"totalThrottlerWaitTimeSeconds,omitempty"`
	// WorkItemId: Identifies the WorkItem.
	WorkItemId string `json:"workItemId,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Completed") 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. "Completed") 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:"-"`
}

WorkItemStatus: Conveys a worker's progress through the work described by a WorkItem.

func (WorkItemStatus) MarshalJSON 

func (s WorkItemStatus) MarshalJSON() ([]byte, error)

func (*WorkItemStatus) UnmarshalJSON 

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

type WorkerDetails added in v0.31.0 

type WorkerDetails struct {
	// WorkItems: Work items processed by this worker, sorted by time.
	WorkItems []*WorkItemDetails `json:"workItems,omitempty"`
	// WorkerName: Name of this worker
	WorkerName string `json:"workerName,omitempty"`
	// ForceSendFields is a list of field names (e.g. "WorkItems") 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. "WorkItems") 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:"-"`
}

WorkerDetails: Information about a worker

func (WorkerDetails) MarshalJSON added in v0.31.0 

func (s WorkerDetails) MarshalJSON() ([]byte, error)

type WorkerHealthReport 

type WorkerHealthReport struct {
	// Msg: Message describing any unusual health reports.
	Msg string `json:"msg,omitempty"`
	// Pods: The pods running on the worker. See:
	// http://kubernetes.io/v1.1/docs/api-reference/v1/definitions.html#_v1_pod
	// This field is used by the worker to send the status of the indvidual
	// containers running on each worker.
	Pods []googleapi.RawMessage `json:"pods,omitempty"`
	// ReportInterval: The interval at which the worker is sending health reports.
	// The default value of 0 should be interpreted as the field is not being
	// explicitly set by the worker.
	ReportInterval string `json:"reportInterval,omitempty"`
	// VmBrokenCode: Code to describe a specific reason, if known, that a VM has
	// reported broken state.
	VmBrokenCode string `json:"vmBrokenCode,omitempty"`
	// VmIsBroken: Whether the VM is in a permanently broken state. Broken VMs
	// should be abandoned or deleted ASAP to avoid assigning or completing any
	// work.
	VmIsBroken bool `json:"vmIsBroken,omitempty"`
	// VmIsHealthy: Whether the VM is currently healthy.
	VmIsHealthy bool `json:"vmIsHealthy,omitempty"`
	// VmStartupTime: The time the VM was booted.
	VmStartupTime string `json:"vmStartupTime,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Msg") 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. "Msg") 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:"-"`
}

WorkerHealthReport: WorkerHealthReport contains information about the health of a worker. The VM should be identified by the labels attached to the WorkerMessage that this health ping belongs to.

func (WorkerHealthReport) MarshalJSON 

func (s WorkerHealthReport) MarshalJSON() ([]byte, error)

type WorkerHealthReportResponse 

type WorkerHealthReportResponse struct {
	// ReportInterval: A positive value indicates the worker should change its
	// reporting interval to the specified value. The default value of zero means
	// no change in report rate is requested by the server.
	ReportInterval string `json:"reportInterval,omitempty"`
	// ForceSendFields is a list of field names (e.g. "ReportInterval") 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. "ReportInterval") 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:"-"`
}

WorkerHealthReportResponse: WorkerHealthReportResponse contains information returned to the worker in response to a health ping.

func (WorkerHealthReportResponse) MarshalJSON 

func (s WorkerHealthReportResponse) MarshalJSON() ([]byte, error)

type WorkerLifecycleEvent 

type WorkerLifecycleEvent struct {
	// ContainerStartTime: The start time of this container. All events will report
	// this so that events can be grouped together across container/VM restarts.
	ContainerStartTime string `json:"containerStartTime,omitempty"`
	// Event: The event being reported.
	//
	// Possible values:
	//   "UNKNOWN_EVENT" - Invalid event.
	//   "OS_START" - The time the VM started.
	//   "CONTAINER_START" - Our container code starts running. Multiple containers
	// could be distinguished with WorkerMessage.labels if desired.
	//   "NETWORK_UP" - The worker has a functional external network connection.
	//   "STAGING_FILES_DOWNLOAD_START" - Started downloading staging files.
	//   "STAGING_FILES_DOWNLOAD_FINISH" - Finished downloading all staging files.
	//   "SDK_INSTALL_START" - For applicable SDKs, started installation of SDK and
	// worker packages.
	//   "SDK_INSTALL_FINISH" - Finished installing SDK.
	Event string `json:"event,omitempty"`
	// Metadata: Other stats that can accompany an event. E.g. { "downloaded_bytes"
	// : "123456" }
	Metadata map[string]string `json:"metadata,omitempty"`
	// ForceSendFields is a list of field names (e.g. "ContainerStartTime") 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. "ContainerStartTime") 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:"-"`
}

WorkerLifecycleEvent: A report of an event in a worker's lifecycle. The proto contains one event, because the worker is expected to asynchronously send each message immediately after the event. Due to this asynchrony, messages may arrive out of order (or missing), and it is up to the consumer to interpret. The timestamp of the event is in the enclosing WorkerMessage proto.

func (WorkerLifecycleEvent) MarshalJSON 

func (s WorkerLifecycleEvent) MarshalJSON() ([]byte, error)

type WorkerMessage 

type WorkerMessage struct {
	// DataSamplingReport: Optional. Contains metrics related to
	// go/dataflow-data-sampling-telemetry.
	DataSamplingReport *DataSamplingReport `json:"dataSamplingReport,omitempty"`
	// Labels: Labels are used to group WorkerMessages. For example, a
	// worker_message about a particular container might have the labels: {
	// "JOB_ID": "2015-04-22", "WORKER_ID": "wordcount-vm-2015…"
	// "CONTAINER_TYPE": "worker", "CONTAINER_ID": "ac1234def"} Label tags
	// typically correspond to Label enum values. However, for ease of development
	// other strings can be used as tags. LABEL_UNSPECIFIED should not be used
	// here.
	Labels map[string]string `json:"labels,omitempty"`
	// PerWorkerMetrics: System defined metrics for this worker.
	PerWorkerMetrics *PerWorkerMetrics `json:"perWorkerMetrics,omitempty"`
	// StreamingScalingReport: Contains per-user worker telemetry used in streaming
	// autoscaling.
	StreamingScalingReport *StreamingScalingReport `json:"streamingScalingReport,omitempty"`
	// Time: The timestamp of the worker_message.
	Time string `json:"time,omitempty"`
	// WorkerHealthReport: The health of a worker.
	WorkerHealthReport *WorkerHealthReport `json:"workerHealthReport,omitempty"`
	// WorkerLifecycleEvent: Record of worker lifecycle events.
	WorkerLifecycleEvent *WorkerLifecycleEvent `json:"workerLifecycleEvent,omitempty"`
	// WorkerMessageCode: A worker message code.
	WorkerMessageCode *WorkerMessageCode `json:"workerMessageCode,omitempty"`
	// WorkerMetrics: Resource metrics reported by workers.
	WorkerMetrics *ResourceUtilizationReport `json:"workerMetrics,omitempty"`
	// WorkerShutdownNotice: Shutdown notice by workers.
	WorkerShutdownNotice *WorkerShutdownNotice `json:"workerShutdownNotice,omitempty"`
	// WorkerThreadScalingReport: Thread scaling information reported by workers.
	WorkerThreadScalingReport *WorkerThreadScalingReport `json:"workerThreadScalingReport,omitempty"`
	// ForceSendFields is a list of field names (e.g. "DataSamplingReport") 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. "DataSamplingReport") 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:"-"`
}

WorkerMessage: WorkerMessage provides information to the backend about a worker.

func (WorkerMessage) MarshalJSON 

func (s WorkerMessage) MarshalJSON() ([]byte, error)

type WorkerMessageCode 

type WorkerMessageCode struct {
	// Code: The code is a string intended for consumption by a machine that
	// identifies the type of message being sent. Examples: 1. "HARNESS_STARTED"
	// might be used to indicate the worker harness has started. 2.
	// "GCS_DOWNLOAD_ERROR" might be used to indicate an error downloading a Cloud
	// Storage file as part of the boot process of one of the worker containers.
	// This is a string and not an enum to make it easy to add new codes without
	// waiting for an API change.
	Code string `json:"code,omitempty"`
	// Parameters: Parameters contains specific information about the code. This is
	// a struct to allow parameters of different types. Examples: 1. For a
	// "HARNESS_STARTED" message parameters might provide the name of the worker
	// and additional data like timing information. 2. For a "GCS_DOWNLOAD_ERROR"
	// parameters might contain fields listing the Cloud Storage objects being
	// downloaded and fields containing errors. In general complex data structures
	// should be avoided. If a worker needs to send a specific and complicated data
	// structure then please consider defining a new proto and adding it to the
	// data oneof in WorkerMessageResponse. Conventions: Parameters should only be
	// used for information that isn't typically passed as a label. hostname and
	// other worker identifiers should almost always be passed as labels since they
	// will be included on most messages.
	Parameters googleapi.RawMessage `json:"parameters,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Code") 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. "Code") 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:"-"`
}

WorkerMessageCode: A message code is used to report status and error messages to the service. The message codes are intended to be machine readable. The service will take care of translating these into user understandable messages if necessary. Example use cases: 1. Worker processes reporting successful startup. 2. Worker processes reporting specific errors (e.g. package staging failure).

func (WorkerMessageCode) MarshalJSON 

func (s WorkerMessageCode) MarshalJSON() ([]byte, error)

type WorkerMessageResponse 

type WorkerMessageResponse struct {
	// StreamingScalingReportResponse: Service's streaming scaling response for
	// workers.
	StreamingScalingReportResponse *StreamingScalingReportResponse `json:"streamingScalingReportResponse,omitempty"`
	// WorkerHealthReportResponse: The service's response to a worker's health
	// report.
	WorkerHealthReportResponse *WorkerHealthReportResponse `json:"workerHealthReportResponse,omitempty"`
	// WorkerMetricsResponse: Service's response to reporting worker metrics
	// (currently empty).
	WorkerMetricsResponse *ResourceUtilizationReportResponse `json:"workerMetricsResponse,omitempty"`
	// WorkerShutdownNoticeResponse: Service's response to shutdown notice
	// (currently empty).
	WorkerShutdownNoticeResponse *WorkerShutdownNoticeResponse `json:"workerShutdownNoticeResponse,omitempty"`
	// WorkerThreadScalingReportResponse: Service's thread scaling recommendation
	// for workers.
	WorkerThreadScalingReportResponse *WorkerThreadScalingReportResponse `json:"workerThreadScalingReportResponse,omitempty"`
	// ForceSendFields is a list of field names (e.g.
	// "StreamingScalingReportResponse") 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. "StreamingScalingReportResponse")
	// 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:"-"`
}

WorkerMessageResponse: A worker_message response allows the server to pass information to the sender.

func (WorkerMessageResponse) MarshalJSON 

func (s WorkerMessageResponse) MarshalJSON() ([]byte, error)

type WorkerPool 

type WorkerPool struct {
	// AutoscalingSettings: Settings for autoscaling of this WorkerPool.
	AutoscalingSettings *AutoscalingSettings `json:"autoscalingSettings,omitempty"`
	// DataDisks: Data disks that are used by a VM in this workflow.
	DataDisks []*Disk `json:"dataDisks,omitempty"`
	// DefaultPackageSet: The default package set to install. This allows the
	// service to select a default set of packages which are useful to worker
	// harnesses written in a particular language.
	//
	// Possible values:
	//   "DEFAULT_PACKAGE_SET_UNKNOWN" - The default set of packages to stage is
	// unknown, or unspecified.
	//   "DEFAULT_PACKAGE_SET_NONE" - Indicates that no packages should be staged
	// at the worker unless explicitly specified by the job.
	//   "DEFAULT_PACKAGE_SET_JAVA" - Stage packages typically useful to workers
	// written in Java.
	//   "DEFAULT_PACKAGE_SET_PYTHON" - Stage packages typically useful to workers
	// written in Python.
	DefaultPackageSet string `json:"defaultPackageSet,omitempty"`
	// DiskSizeGb: Size of root disk for VMs, in GB. If zero or unspecified, the
	// service will attempt to choose a reasonable default.
	DiskSizeGb int64 `json:"diskSizeGb,omitempty"`
	// DiskSourceImage: Fully qualified source image for disks.
	DiskSourceImage string `json:"diskSourceImage,omitempty"`
	// DiskType: Type of root disk for VMs. If empty or unspecified, the service
	// will attempt to choose a reasonable default.
	DiskType string `json:"diskType,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"`
	// Kind: The kind of the worker pool; currently only `harness` and `shuffle`
	// are supported.
	Kind string `json:"kind,omitempty"`
	// MachineType: Machine type (e.g. "n1-standard-1"). If empty or unspecified,
	// the service will attempt to choose a reasonable default.
	MachineType string `json:"machineType,omitempty"`
	// Metadata: Metadata to set on the Google Compute Engine VMs.
	Metadata map[string]string `json:"metadata,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"`
	// NumThreadsPerWorker: The number of threads per worker harness. If empty or
	// unspecified, the service will choose a number of threads (according to the
	// number of cores on the selected machine type for batch, or 1 by convention
	// for streaming).
	NumThreadsPerWorker int64 `json:"numThreadsPerWorker,omitempty"`
	// NumWorkers: Number of Google Compute Engine workers in this pool needed to
	// execute the job. If zero or unspecified, the service will attempt to choose
	// a reasonable default.
	NumWorkers int64 `json:"numWorkers,omitempty"`
	// OnHostMaintenance: The action to take on host maintenance, as defined by the
	// Google Compute Engine API.
	OnHostMaintenance string `json:"onHostMaintenance,omitempty"`
	// Packages: Packages to be installed on workers.
	Packages []*Package `json:"packages,omitempty"`
	// PoolArgs: Extra arguments for this worker pool.
	PoolArgs googleapi.RawMessage `json:"poolArgs,omitempty"`
	// SdkHarnessContainerImages: Set of SDK harness containers needed to execute
	// this pipeline. This will only be set in the Fn API path. For
	// non-cross-language pipelines this should have only one entry. Cross-language
	// pipelines will have two or more entries.
	SdkHarnessContainerImages []*SdkHarnessContainerImage `json:"sdkHarnessContainerImages,omitempty"`
	// Subnetwork: Subnetwork to which VMs will be assigned, if desired. Expected
	// to be of the form "regions/REGION/subnetworks/SUBNETWORK".
	Subnetwork string `json:"subnetwork,omitempty"`
	// TaskrunnerSettings: Settings passed through to Google Compute Engine workers
	// when using the standard Dataflow task runner. Users should ignore this
	// field.
	TaskrunnerSettings *TaskRunnerSettings `json:"taskrunnerSettings,omitempty"`
	// TeardownPolicy: Sets the policy for determining when to turndown worker
	// pool. Allowed values are: `TEARDOWN_ALWAYS`, `TEARDOWN_ON_SUCCESS`, and
	// `TEARDOWN_NEVER`. `TEARDOWN_ALWAYS` means workers are always torn down
	// regardless of whether the job succeeds. `TEARDOWN_ON_SUCCESS` means workers
	// are torn down if the job succeeds. `TEARDOWN_NEVER` means the workers are
	// never torn down. If the workers are not torn down by the service, they will
	// continue to run and use Google Compute Engine VM resources in the user's
	// project until they are explicitly terminated by the user. Because of this,
	// Google recommends using the `TEARDOWN_ALWAYS` policy except for small,
	// manually supervised test jobs. If unknown or unspecified, the service will
	// attempt to choose a reasonable default.
	//
	// Possible values:
	//   "TEARDOWN_POLICY_UNKNOWN" - The teardown policy isn't specified, or is
	// unknown.
	//   "TEARDOWN_ALWAYS" - Always teardown the resource.
	//   "TEARDOWN_ON_SUCCESS" - Teardown the resource on success. This is useful
	// for debugging failures.
	//   "TEARDOWN_NEVER" - Never teardown the resource. This is useful for
	// debugging and development.
	TeardownPolicy string `json:"teardownPolicy,omitempty"`
	// WorkerHarnessContainerImage: Required. Docker container image that executes
	// the Cloud Dataflow worker harness, residing in Google Container Registry.
	// Deprecated for the Fn API path. Use sdk_harness_container_images instead.
	WorkerHarnessContainerImage string `json:"workerHarnessContainerImage,omitempty"`
	// Zone: Zone to run the worker pools in. If empty or unspecified, the service
	// will attempt to choose a reasonable default.
	Zone string `json:"zone,omitempty"`
	// ForceSendFields is a list of field names (e.g. "AutoscalingSettings") 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. "AutoscalingSettings") 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:"-"`
}

WorkerPool: Describes one particular pool of Cloud Dataflow workers to be instantiated by the Cloud Dataflow service in order to perform the computations required by a job. Note that a workflow job may use multiple pools, in order to match the various computational requirements of the various stages of the job.

func (WorkerPool) MarshalJSON 

func (s WorkerPool) MarshalJSON() ([]byte, error)

type WorkerSettings 

type WorkerSettings struct {
	// BaseUrl: The base URL for accessing Google Cloud APIs. When workers access
	// Google Cloud APIs, they logically do so via relative URLs. If this field is
	// specified, it supplies the base URL to use for resolving these relative
	// URLs. The normative algorithm used is defined by RFC 1808, "Relative Uniform
	// Resource Locators". If not specified, the default value is
	// "http://www.googleapis.com/"
	BaseUrl string `json:"baseUrl,omitempty"`
	// ReportingEnabled: Whether to send work progress updates to the service.
	ReportingEnabled bool `json:"reportingEnabled,omitempty"`
	// ServicePath: The Cloud Dataflow service path relative to the root URL, for
	// example, "dataflow/v1b3/projects".
	ServicePath string `json:"servicePath,omitempty"`
	// ShuffleServicePath: The Shuffle service path relative to the root URL, for
	// example, "shuffle/v1beta1".
	ShuffleServicePath string `json:"shuffleServicePath,omitempty"`
	// TempStoragePrefix: The prefix of the resources the system should use for
	// temporary storage. The supported resource type is: Google Cloud Storage:
	// storage.googleapis.com/{bucket}/{object}
	// bucket.storage.googleapis.com/{object}
	TempStoragePrefix string `json:"tempStoragePrefix,omitempty"`
	// WorkerId: The ID of the worker running this pipeline.
	WorkerId string `json:"workerId,omitempty"`
	// ForceSendFields is a list of field names (e.g. "BaseUrl") 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. "BaseUrl") 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:"-"`
}

WorkerSettings: Provides data to pass through to the worker harness.

func (WorkerSettings) MarshalJSON 

func (s WorkerSettings) MarshalJSON() ([]byte, error)

type WorkerShutdownNotice 

type WorkerShutdownNotice struct {
	// Reason: The reason for the worker shutdown. Current possible values are:
	// "UNKNOWN": shutdown reason is unknown. "PREEMPTION": shutdown reason is
	// preemption. Other possible reasons may be added in the future.
	Reason string `json:"reason,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Reason") 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. "Reason") 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:"-"`
}

WorkerShutdownNotice: Shutdown notification from workers. This is to be sent by the shutdown script of the worker VM so that the backend knows that the VM is being shut down.

func (WorkerShutdownNotice) MarshalJSON 

func (s WorkerShutdownNotice) MarshalJSON() ([]byte, error)

type WorkerShutdownNoticeResponse 

type WorkerShutdownNoticeResponse struct {
}

WorkerShutdownNoticeResponse: Service-side response to WorkerMessage issuing shutdown notice.

type WorkerThreadScalingReport added in v0.106.0 

type WorkerThreadScalingReport struct {
	// CurrentThreadCount: Current number of active threads in a worker.
	CurrentThreadCount int64 `json:"currentThreadCount,omitempty"`
	// ForceSendFields is a list of field names (e.g. "CurrentThreadCount") 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. "CurrentThreadCount") 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:"-"`
}

WorkerThreadScalingReport: Contains information about the thread scaling information of a worker.

func (WorkerThreadScalingReport) MarshalJSON added in v0.106.0 

func (s WorkerThreadScalingReport) MarshalJSON() ([]byte, error)

type WorkerThreadScalingReportResponse added in v0.106.0 

type WorkerThreadScalingReportResponse struct {
	// RecommendedThreadCount: Recommended number of threads for a worker.
	RecommendedThreadCount int64 `json:"recommendedThreadCount,omitempty"`
	// ForceSendFields is a list of field names (e.g. "RecommendedThreadCount") 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. "RecommendedThreadCount") 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:"-"`
}

WorkerThreadScalingReportResponse: Contains the thread scaling recommendation for a worker from the backend.

func (WorkerThreadScalingReportResponse) MarshalJSON added in v0.106.0 

func (s WorkerThreadScalingReportResponse) MarshalJSON() ([]byte, error)

type WriteInstruction 

type WriteInstruction struct {
	// Input: The input.
	Input *InstructionInput `json:"input,omitempty"`
	// Sink: The sink to write to.
	Sink *Sink `json:"sink,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:"-"`
}

WriteInstruction: An instruction that writes records. Takes one input, produces no outputs.

func (WriteInstruction) MarshalJSON 

func (s WriteInstruction) MarshalJSON() ([]byte, error)

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.