i p0 S r SSKJr SSKJr SSKJr SSKJr Sr " S S\R 5 r " S S
\R 5 r " S S \R 5 r
" S
S\R 5 r " S S\R 5 r " S S\R 5 r " S S\R 5 r " S S\R 5 r " S S\R 5 r " S S\R 5 r " S S \R 5 r " S S \R 5 r " S S \R 5 r " S! S"\R 5 r " S# S$\R 5 r " S% S&\R 5 r " S' S(\R 5 r " S) S*\R 5 r " S+ S,\R 5 r " S- S.\R 5 r " S/ S0\R 5 r " S1 S2\R 5 r " S3 S4\R 5 r! " S5 S6\R 5 r" " S7 S8\R 5 r# " S9 S:\R 5 r$ " S; S<\R 5 r% " S= S>\R 5 r& " S? S@\R 5 r' " SA SB\R 5 r( " SC SD\R 5 r) " SE SF\R 5 r* " SG SH\R 5 r+ " SI SJ\R 5 r, " SK SL\R 5 r- " SM SN\R 5 r. " SO SP\R 5 r/ " SQ SR\R 5 r0 " SS ST\R 5 r1 " SU SV\R 5 r2 " SW SX\R 5 r3 " SY SZ\R 5 r4 " S[ S\\R 5 r5 " S] S^\R 5 r6 " S_ S`\R 5 r7 " Sa Sb\R 5 r8 " Sc Sd\R 5 r9 " Se Sf\R 5 r: " Sg Sh\R 5 r; " Si Sj\R 5 r< " Sk Sl\R 5 r= " Sm Sn\R 5 r> " So Sp\R 5 r? " Sq Sr\R 5 r@ " Ss St\R 5 rA " Su Sv\R 5 rB " Sw Sx\R 5 rC " Sy Sz\R 5 rD " S{ S|\R 5 rE " S} S~\R 5 rF " S S\R 5 rG " S S\R 5 rH " S S\R 5 rI " S S\R 5 rJ " S S\R 5 rK " S S\R 5 rL " S S\R 5 rM " S S\R 5 rN " S S\R 5 rO " S S\R 5 rP " S S\R 5 rQ " S S\R 5 rR " S S\R 5 rS " S S\R 5 rT " S S\R 5 rU " S S\R 5 rV " S S\R 5 rW " S S\R 5 rX " S S\R 5 rY " S S\R 5 rZ " S S\R 5 r[ " S S\R 5 r\ " S S\R 5 r] " S S\R 5 r^ " S S\R 5 r_ " S S\R 5 r` " S S\R 5 ra " S S\R 5 rb " S S\R 5 rc " S S\R 5 rd " S S\R 5 re " S S\R 5 rf " S S\R 5 rg " S S\R 5 rh " S S\R 5 ri " S S\R 5 rj " S S\R 5 rk " S S\R 5 rl " S S\R 5 rm " S S\R 5 rn " S S\R 5 ro " S S\R 5 rp " S S\R 5 rq " S S\R 5 rr " S S\R 5 rs " S S\R 5 rt " S S\R 5 ru " S S\R 5 rv " S S\R 5 rw " S S\R 5 rx " S S\R 5 ry " S S\R 5 rz " S S\R 5 r{ " S S\R 5 r| " S S\R 5 r} " S S\R 5 r~ " S S\R 5 r " S S\R 5 r " S S\R 5 r " S S\R 5 r " S S\R 5 r " S S\R 5 r " S S\R 5 r " S S\R 5 r " S GS \R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS
\R 5 r " GS GS \R 5 r " GS
GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS \R 5 r " GS GS \R 5 r " GS GS \R 5 r " GS! GS"\R 5 r " GS# GS$\R 5 r " GS% GS&\R 5 r " GS' GS(\R 5 r " GS) GS*\R 5 r " GS+ GS,\R 5 r " GS- GS.\R 5 r " GS/ GS0\R 5 r " GS1 GS2\R 5 r " GS3 GS4\R 5 r " GS5 GS6\R 5 r " GS7 GS8\R 5 r " GS9 GS:\R 5 r " GS; GS<\R 5 r " GS= GS>\R 5 r " GS? GS@\R 5 r " GSA GSB\R 5 r " GSC GSD\R 5 r " GSE GSF\R 5 r " GSG GSH\R 5 r " GSI GSJ\R 5 r " GSK GSL\R 5 r " GSM GSN\R 5 r " GSO GSP\R 5 r " GSQ GSR\R 5 r " GSS GST\R 5 r " GSU GSV\R 5 r " GSW GSX\R 5 r " GSY GSZ\R 5 r " GS[ GS\\R 5 r " GS] GS^\R 5 r " GS_ GS`\R 5 r " GSa GSb\R 5 r " GSc GSd\R 5 r " GSe GSf\R 5 r " GSg GSh\R 5 r " GSi GSj\R 5 r " GSk GSl\R 5 r " GSm GSn\R 5 r " GSo GSp\R 5 r " GSq GSr\R 5 r " GSs GSt\R 5 r " GSu GSv\R 5 r " GSw GSx\R 5 r " GSy GSz\R 5 r " GS{ GS|\R 5 r " GS} GS~\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 Gr " GS GS\R 5 Gr " GS GS\R 5 Gr " GS GS\R 5 Gr " GS GS\R 5 Gr " GS GS\R 5 Gr " GS GS\R 5 Gr " GS GS \R 5 Gr " GS GS\R 5 Gr " GS GS\R 5 Gr " GS GS\R 5 Gr
" GS GS\R 5 Gr " GS GS
\R 5 Gr " GS GS \R 5 Gr
" GS
GS\R 5 Gr " GS GS\R 5 Gr " GS GS\R 5 Gr " GS GS\R 5 Gr " GS GS\R 5 Gr " GS GS\R 5 Gr " GS GS\R 5 Gr " GS GS \R 5 Gr " GS GS \R 5 Gr " GS GS \R 5 Gr " GS! GS"\R 5 Gr\GR2 " \GS#GS$5 \GR4 " \GR6 GS%GS&5 \GR4 " \GR6 GS'GS(5 \GR2 " \[GS)GS*5 \GR2 " \[GS+GS,5 \GR2 " \bGS)GS*5 \GR2 " \bGS+GS,5 Gg-(. zwGenerated message classes for dataflow version v1b3.
Manages Google Cloud Dataflow projects on Google Cloud Platform.
)absolute_import)messages)encoding) extra_typesdataflowc \ rS rSrSr\R " S\R R S9r \R " SS5 r \R " S5 r
Srg )
ApproximateProgress zObsolete in favor of ApproximateReportedProgress and
ApproximateSplitRequest.
Fields:
percentComplete: Obsolete.
position: Obsolete.
remainingTime: Obsolete.
variantPosition N)__name__
__module__ __qualname____firstlineno____doc__ _messages
FloatFieldVariantFLOATpercentComplete MessageFieldposition StringField
remainingTime__static_attributes__r Qlib/googlecloudsdk/generated_clients/apis/dataflow/v1b3/dataflow_v1b3_messages.pyr r sI ((I4E4E4K4KL/
#
#J
2(''*-r! r c \ rS rSrSr\R " SS5 r\R " S5 r \R " SS5 r
\R " SS5 r S r g
) ApproximateReportedProgress a: A progress measurement of a WorkItem by a worker.
Fields:
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.
fractionConsumed: Completion as fraction of the input consumed, from 0.0
(beginning, nothing consumed), to 1.0 (end of the input, entire input
consumed).
position: A Position within the work to represent a progress.
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.
ReportedParallelismr r r r r N)
r r r r r r r consumedParallelismr fractionConsumedr remainingParallelismr r r! r" r$ r$ sU D "../DaH ))!,
#
#J
2("//0EqIr! r$ c \ rS rSrSr\R " S5 r\R " S5 r\R " SS5 r
Sr g) ApproximateSplitRequestI a A suggestion by the service to the worker to dynamically split the
WorkItem.
Fields:
fractionConsumed: A fraction at which to split the work item, from 0.0
(beginning of the input) to 1.0 (end of the input).
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).
position: A Position at which to split the work item.
r r r r r N) r r r r r r r r) fractionOfRemainderr r r r r! r" r, r, I s=
))!,!,,Q/
#
#J
2(r! r, c \ rS rSrSr\R " SS5 r\R " S5 r \R " SS5 r
Sr g )
Artifact[ zJob information for templates.
Fields:
containerSpec: Container image path set for flex Template.
jobGraphGcsPath: job_graph_gcs_path set for legacy Template.
metadata: Metadata set for legacy Template.
ContainerSpecr r TemplateMetadatar r N) r r r r r r r
containerSpecr jobGraphGcsPathmetadatar r r! r" r0 r0 [ s> (( !<- ))!,/
#
#$6
:(r! r0 c \ rS rSrSr " S S\R 5 r\R " S5 r \R " SS5 r \R " SS5 r
\R " S 5 r\R " S
5 r\R " S 5 rS rg
)AutoscalingEventi a A structured message reporting an autoscaling decision made by the
Dataflow service.
Enums:
EventTypeValueValuesEnum: The type of autoscaling event to report.
Fields:
currentNumWorkers: The current number of workers the job has.
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.
eventType: The type of autoscaling event to report.
targetNumWorkers: The target number of workers the worker pool wants to
resize to use.
time: The time this event was emitted to indicate a new target or current
num_workers value.
workerPool: A short and friendly name for the worker pool this event
refers to.
c , \ rS rSrSrSrSrSrSrSr Sr
g )
)AutoscalingEvent.EventTypeValueValuesEnum~ a# The type of autoscaling event to report.
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.
r r r r r' r N) r r r r r TYPE_UNKNOWNTARGET_NUM_WORKERS_CHANGEDCURRENT_NUM_WORKERS_CHANGEDACTUATION_FAILURE NO_CHANGEr r r! r" EventTypeValueValuesEnumr; ~ s% ( L!" "# Ir! rB r StructuredMessager r r' r N)r r r r r r EnumrB IntegerFieldcurrentNumWorkersr description EnumField eventTypetargetNumWorkersr time
workerPoolr r r! r" r8 r8 i s ( 6 ,,Q/&&':A>+!!" \ rS rSrSr\R " SS5 rSrg) CommitTemplateVersionRequesti> z}Commit will add a new TemplateVersion to an existing template.
Fields:
templateVersion: TemplateVersion object to create.
TemplateVersionr r N r r r r r r r templateVersionr r r! r" r r > **+
inn
y~~
++A. ++A.%%a1B1B1H1HI* q !$ 6 :& ))!,/ ( 4 4Q 7 **1- 8! <'
"
"2
&(r! r c d \ rS rSrSr\R " SS5 r\R " SS5 rSr g) CounterStructuredNameAndMetadatai. zA single message which encapsulates structured name and metadata for a
given counter.
Fields:
metadata: Metadata associated with a counter
name: Structured name of the counter.
r r r r r N)
r r r r r r r r6 r r r r! r" r r . s/
#
#$5q
9( 7 ;$r! r c p \ rS rSrSr\R " S5 r\R " SS5 r \R " S5 r
\R " SS5 r \R " S 5 r
\R " S
S 5 r\R " S S
5 r\R " SS5 r\R " SS5 r\R " SS5 r\R " SS5 r\R " SS5 r\R " SS5 r\R, " S5 r\R " SS 5 r\R " S S 5 rS rg )!
CounterUpdatei; a An update to a Counter sent from a worker. Next ID: 17
Fields:
boolean: Boolean value for And, Or.
boundedTrie: Bounded trie data
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.
distribution: Distribution data
floatingPoint: Floating point value for Sum, Max, Min.
floatingPointList: List of floating point numbers, for Set.
floatingPointMean: Floating point mean aggregation value for Mean.
integer: Integer value for Sum, Max, Min.
integerGauge: Gauge data
integerList: List of integers, for Set.
integerMean: Integer mean aggregation value for Mean.
internal: Value for internally-defined counters used by the Dataflow
service.
nameAndKind: Counter name and aggregation type.
shortId: The service-generated short identifier for this counter. The
short_id -> (name, metadata) mapping is constant for the lifetime of a
job.
stringList: List of strings, for Set.
structuredNameAndMetadata: Counter structured name and metadata.
r rp r r DistributionUpdater' rD FloatingPointListrE FloatingPointMeanr
SplitInt64r IntegerGauger IntegerListr IntegerMean extra_types.JsonValue NameAndKind
StringList r r N)r r r r r r r booleanr boundedTrie
cumulative distributionr
floatingPointfloatingPointListfloatingPointMeaninteger integerGauge integerList integerMeaninternal nameAndKindrG shortId
stringListstructuredNameAndMetadatar r r! r" r r ; s* 6
" "1 %'&&}a8+%%a(*''( \ rS rSrSr\R " SS5 rSrg) CreateTemplateVersionRequesti zpCreates a new Template with TemplateVersions.
Fields:
templateVersion: The TemplateVersion object to create.
r r r Nr r r! r" r+ r+ r r! r+ c < \ rS rSrSr\R " S5 rSrg)CustomSourceLocationi zaIdentifies the location of a custom souce.
Fields:
stateful: Whether this source is stateful.
r r N) r r r r r r r statefulr r r! r" r- r- s
#
#A
&(r! r- c ^ \ rS rSrSr\R " SSS9r\R " S5 rSr g) DataDiskAssignmenti a Data disk assignment for a given VM instance.
Fields:
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" }.
vmInstance: VM instance name the data disks mounted to, for example
"myproject-1014-104817-4c2-harness-0".
r Trs r r N)
r r r r r r r dataDisks
vmInstancer r r! r" r0 r0 s+
##A5)$$Q'*r! r0 c f \ rS rSrSr " S S\R 5 r\R " SSSS9r Sr
g )
DataSamplingConfigi a# Configuration options for sampling elements.
Enums:
BehaviorsValueListEntryValuesEnum:
Fields:
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.
c ( \ rS rSrSrSrSrSrSrSr g) 4DataSamplingConfig.BehaviorsValueListEntryValuesEnumi a BehaviorsValueListEntryValuesEnum enum type.
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.
r r r r r N)
r r r r r "DATA_SAMPLING_BEHAVIOR_UNSPECIFIEDDISABLED ALWAYS_ON
EXCEPTIONSr r r! r" !BehaviorsValueListEntryValuesEnumr6 s
*+&HIJr! r; r Trs r N) r r r r r r rF r; rJ behaviorsr r r! r" r4 r4 s/ ).. " !!"EqSWX)r! r4 c \ rS rSrSr\R " S5 r\R " S5 r\R " S5 r \R " S5 r
\R " S5 r \R " S5 r \R " S 5 r
S
rg ) DataSamplingReporti a& Contains per-worker telemetry about the data sampling feature.
Fields:
bytesWrittenDelta: Optional. Delta of bytes written to file from previous
report.
elementsSampledBytes: Optional. Delta of bytes sampled from previous
report.
elementsSampledCount: Optional. Delta of number of elements sampled from
previous report.
exceptionsSampledCount: Optional. Delta of number of samples taken from
user code exceptions from previous report.
pcollectionsSampledCount: Optional. Delta of number of PCollections
sampled from previous report.
persistenceErrorsCount: Optional. Delta of errors counts from persisting
the samples from previous report.
translationErrorsCount: Optional. Delta of errors counts from retrieving,
or translating the samples from previous report.
r r r r' rD rE r r N)r r r r r r rG bytesWrittenDeltaelementsSampledByteselementsSampledCountexceptionsSampledCountpcollectionsSampledCountpersistenceErrorsCounttranslationErrorsCountr r r! r" r> r> s & ,,Q/"//2"//2$11!4 & 3 3A 6$11!4$11!4r! r> c V \ rS rSrSr\R " S5 " S S\R 5 5 r \R " S5 " S S\R 5 5 r
\R " SS 5 r \R " S
5 r\R " SS 5 r\R " SS 5 rS
rg) DataflowClassicTemplateConfigi a/ Dataflow Job information of Classic Template Type. More info about
dataflow classic templates can be found here
https://cloud.google.com/dataflow/docs/guides/templates/creating-templates.
Messages:
ParametersValue: The runtime parameters to pass to the job.
TransformNameMappingsValue: Use this to pass transform_name_mappings for
streaming update jobs. Ex:{"oldTransformName":"newTransformName",...}'.
Fields:
environment: The runtime environment for the job.
gcsPath: A Cloud Storage path to the template from which to create the
job. Must be valid Cloud Storage URL, beginning with 'gs://'.
parameters: The runtime parameters to pass to the job.
transformNameMappings: Use this to pass transform_name_mappings for
streaming update jobs. Ex:{"oldTransformName":"newTransformName",...}'.
rz c f \ rS rSrSr " S S\R 5 r\R " SSSS9r Sr
g )
-DataflowClassicTemplateConfig.ParametersValuei r c ` \ rS rSrSr\R " S5 r\R " S5 rSr g)@DataflowClassicTemplateConfig.ParametersValue.AdditionalPropertyi r r r r Nr r r! r" r rK r! r! r r Trs r Nr r r! r" r" rI r# r! r" c f \ rS rSrSr " S S\R 5 r\R " SSSS9r Sr
g )
8DataflowClassicTemplateConfig.TransformNameMappingsValuei* a8 Use this to pass transform_name_mappings for streaming update jobs.
Ex:{"oldTransformName":"newTransformName",...}'.
Messages:
AdditionalProperty: An additional property for a
TransformNameMappingsValue object.
Fields:
additionalProperties: Additional properties of type
TransformNameMappingsValue
c ` \ rS rSrSr\R " S5 r\R " S5 rSr g)KDataflowClassicTemplateConfig.TransformNameMappingsValue.AdditionalPropertyi8 An additional property for a TransformNameMappingsValue object.
Fields:
key: Name of the additional property.
value: A string attribute.
r r r Nr r r! r" r rO 8 r! r! r r Trs r Nr r r! r" TransformNameMappingsValuerM * 2
'Y . . ' %112FTXYr! rQ r$ r r r r' r N)r r r r r r r r r r" rQ r r% r r& r) transformNameMappingsr r r! r" rG rG s $ !!"89Z )) Z :Z. !!"89Z9#4#4 Z :Z4 &&';Q?+ ! !! $'%%&7;*#001MqQr! rG c \ rS rSrSr\R " S5 " S S\R 5 5 r \R " S5 " S S\R 5 5 r
\R " S5 " S S \R 5 5 r \R " S
5 r
\R " S S 5 r\R " SS
5 r\R " SS5 r\R " S S5 rSrg)DataflowFlexTemplateConfigiK a Dataflow Job information of Flex Template Type. More info about dataflow
flex templates can be found here
https://cloud.google.com/dataflow/docs/guides/templates/using-flex-
templates.
Messages:
LaunchOptionsValue: 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.
ParametersValue: The parameters for FlexTemplate. Ex. {"num_workers":"5"}
TransformNameMappingsValue: Use this to pass transform_name_mappings for
streaming update jobs. Ex:{"oldTransformName":"newTransformName",...}'
Fields:
containerSpecGcsPath: Cloud Storage path to a file with json serialized
ContainerSpec as content.
environment: The runtime environment for the FlexTemplate job
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.
parameters: The parameters for FlexTemplate. Ex. {"num_workers":"5"}
transformNameMappings: Use this to pass transform_name_mappings for
streaming update jobs. Ex:{"oldTransformName":"newTransformName",...}'
rz c f \ rS rSrSr " S S\R 5 r\R " SSSS9r Sr
g )
-DataflowFlexTemplateConfig.LaunchOptionsValueie J 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.
Messages:
AdditionalProperty: An additional property for a LaunchOptionsValue
object.
Fields:
additionalProperties: Additional properties of type LaunchOptionsValue
c ` \ rS rSrSr\R " S5 r\R " S5 rSr g)@DataflowFlexTemplateConfig.LaunchOptionsValue.AdditionalPropertyis An additional property for a LaunchOptionsValue object.
Fields:
key: Name of the additional property.
value: A string attribute.
r r r Nr r r! r" r rZ s r! r! r r Trs r Nr r r! r" LaunchOptionsValuerW e rR r! r\ c f \ rS rSrSr " S S\R 5 r\R " SSSS9r Sr
g )
*DataflowFlexTemplateConfig.ParametersValuei The parameters for FlexTemplate. Ex. {"num_workers":"5"}
Messages:
AdditionalProperty: An additional property for a ParametersValue object.
Fields:
additionalProperties: Additional properties of type ParametersValue
c ` \ rS rSrSr\R " S5 r\R " S5 rSr g)=DataflowFlexTemplateConfig.ParametersValue.AdditionalPropertyi r r r r Nr r r! r" r ra r! r! r r Trs r Nr r r! r" r" r^ r# r! r" c f \ rS rSrSr " S S\R 5 r\R " SSSS9r Sr
g )
5DataflowFlexTemplateConfig.TransformNameMappingsValuei 7 Use this to pass transform_name_mappings for streaming update jobs.
Ex:{"oldTransformName":"newTransformName",...}'
Messages:
AdditionalProperty: An additional property for a
TransformNameMappingsValue object.
Fields:
additionalProperties: Additional properties of type
TransformNameMappingsValue
c ` \ rS rSrSr\R " S5 r\R " S5 rSr g)HDataflowFlexTemplateConfig.TransformNameMappingsValue.AdditionalPropertyi rP r r r Nr r r! r" r rf r! r! r r Trs r Nr r r! r" rQ rc rR r! rQ r r r r r' rD r N)r r r r r r r r r r\ r" rQ r containerSpecGcsPathr r%
launchOptionsr) rS r r r! r" rU rU K s 2 !!"89Z9,, Z :Z4 !!"89Z )) Z :Z. !!"89Z9#4#4 Z :Z4 #..q1&&'GK+(()=qA-%%&7;*#001MqQr! rU c ` \ rS rSrSr\R " S5 r\R " S5 r Sr
g)DataflowGaugeValuei zThe gauge value of a metric.
Fields:
measuredTime: The timestamp when the gauge was recorded.
value: The value of the gauge.
r r r N) r r r r r r r measuredTimerG r r r r! r" rj rj s) &&q),
#%r! rj c \ rS rSrSr\R " SSS9r\R " SS5 r \R " S5 r
\R " S S
5 r S r g )
DataflowHistogramValuei a6 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.
Fields:
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.
bucketOptions: Describes the bucket boundaries used in the histogram.
count: Number of values recorded in this histogram.
outlierStats: Statistics on the values recorded in the histogram that fall
out of the bucket boundaries.
r Trs r r r OutlierStatsr' r N)
r r r r r r rG bucketCountsr
bucketOptionscount outlierStatsr r r! r" rm rm sO " ''D9,(( !<-
#%'':,r! rm c ` \ rS rSrSr\R " SS5 r\R " SSS9r Sr
g )
-DataflowProjectsCatalogTemplatesCommitRequesti an A DataflowProjectsCatalogTemplatesCommitRequest object.
Fields:
commitTemplateVersionRequest: A CommitTemplateVersionRequest resource to
be passed as the request body.
name: The location of the template, name includes project_id and
display_name. Commit using project_id(pid1) and display_name(tid1).
Format: projects/{pid1}/catalogTemplates/{tid1}
r r r Trequiredr N) r r r r r r r commitTemplateVersionRequestr r r r r! r" rt rt s0 "+!7!78VXY!Z q4 0$r! rt c : \ rS rSrSr\R " SSS9rSrg)-DataflowProjectsCatalogTemplatesDeleteRequesti zA DataflowProjectsCatalogTemplatesDeleteRequest object.
Fields:
name: name includes project_id and display_name. Delete by
project_id(pid1) and display_name(tid1). Format:
projects/{pid1}/catalogTemplates/{tid1}
r Tru r N r r r r r r r r r r r! r" ry ry s
q4 0$r! ry c : \ rS rSrSr\R " SSS9rSrg)*DataflowProjectsCatalogTemplatesGetRequesti a A DataflowProjectsCatalogTemplatesGetRequest object.
Fields:
name: Resource name includes project_id and display_name. version_id is
optional. Get the latest TemplateVersion if version_id not set. Get by
project_id(pid1) and display_name(tid1): Format:
projects/{pid1}/catalogTemplates/{tid1} Get by project_id(pid1),
display_name(tid1), and version_id(vid1): Format:
projects/{pid1}/catalogTemplates/{tid1@vid}
r Tru r Nrz r r! r" r| r| s
q4 0$r! r| c ` \ rS rSrSr\R " SS5 r\R " SSS9r Sr
g )
,DataflowProjectsCatalogTemplatesLabelRequesti a A DataflowProjectsCatalogTemplatesLabelRequest object.
Fields:
modifyTemplateVersionLabelRequest: A ModifyTemplateVersionLabelRequest
resource to be passed as the request body.
name: Resource name includes project_id, display_name, and version_id.
Updates by project_id(pid1), display_name(tid1), and version_id(vid1):
Format: projects/{pid1}/catalogTemplates/{tid1@vid}
!ModifyTemplateVersionLabelRequestr r Tru r N) r r r r r r r !modifyTemplateVersionLabelRequestr r r r r! r" r~ r~ s0 '0&<&<=`bc&d# q4 0$r! r~ c ` \ rS rSrSr\R " SS5 r\R " SSS9r Sr
g )
*DataflowProjectsCatalogTemplatesTagRequesti a~ A DataflowProjectsCatalogTemplatesTagRequest object.
Fields:
modifyTemplateVersionTagRequest: A ModifyTemplateVersionTagRequest
resource to be passed as the request body.
name: Resource name includes project_id, display_name, and version_id.
Updates by project_id(pid1), display_name(tid1), and version_id(vid1):
Format: projects/{pid1}/catalogTemplates/{tid1@vid}
ModifyTemplateVersionTagRequestr r Tru r N) r r r r r r r modifyTemplateVersionTagRequestr r r r r! r" r r s0 %.$:$:;\^_$`! q4 0$r! r c ` \ rS rSrSr\R " SS5 r\R " SSS9r Sr
g )
=DataflowProjectsCatalogTemplatesTemplateVersionsCreateRequesti& a A DataflowProjectsCatalogTemplatesTemplateVersionsCreateRequest object.
Fields:
createTemplateVersionRequest: A CreateTemplateVersionRequest resource to
be passed as the request body.
parent: The parent project and template that the TemplateVersion will be
created under. Create using project_id(pid1) and display_name(tid1).
Format: projects/{pid1}/catalogTemplates/{tid1}
r+ r r Tru r N) r r r r r r r createTemplateVersionRequestr parentr r r! r" r r & s0 "+!7!78VXY!Z T 2&r! r c \ rS rSrSr\R " S5 r\R " SSS9r\R " S5 r Sr
g )
&DataflowProjectsDeleteSnapshotsRequesti5 zA DataflowProjectsDeleteSnapshotsRequest object.
Fields:
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.
r r Tru r r N r r r r r r r r( rg
snapshotIdr r r! r" r r 5 s;
"
"1
%(##A5)$$Q'*r! r c \ rS rSrSr " S S\R 5 r " S S\R 5 r\R " SS5 r
\R " S5 r \R " S 5 r
\R " S
\R R S 9r\R " S 5 r\R " S
SS9r\R " SS5 rSrg)%DataflowProjectsJobsAggregatedRequestiD a{ A DataflowProjectsJobsAggregatedRequest object.
Enums:
FilterValueValuesEnum: The kind of filter to use.
ViewValueValuesEnum: Deprecated. ListJobs always returns summaries now.
Use GetJob for other JobViews.
Fields:
filter: The kind of filter to use.
location: The [regional endpoint]
(https://cloud.google.com/dataflow/docs/concepts/regional-endpoints)
that contains this job.
name: Optional. The job name.
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.
pageToken: Set this to the 'next_page_token' field of a previous response
to request additional results in a long list.
projectId: The project which owns the jobs.
view: Deprecated. ListJobs always returns summaries now. Use GetJob for
other JobViews.
c ( \ rS rSrSrSrSrSrSrSr g) ;DataflowProjectsJobsAggregatedRequest.FilterValueValuesEnumi\ B The kind of filter to use.
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.
r r r r r N
r r r r r UNKNOWNr
TERMINATEDACTIVEr r r! r" FilterValueValuesEnumr \ G
CJ
Fr! r c ( \ rS rSrSrSrSrSrSrSr g) 9DataflowProjectsJobsAggregatedRequest.ViewValueValuesEnumio Deprecated. ListJobs always returns summaries now. Use GetJob for
other JobViews.
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/ref
erence/rest/v1b3/projects.jobs#jobstate).
JOB_VIEW_DESCRIPTION: Request summary info and limited job description
data for steps, labels and environment.
r r r r r N
r r r r r JOB_VIEW_UNKNOWNJOB_VIEW_SUMMARY JOB_VIEW_ALLJOB_VIEW_DESCRIPTIONr r r! r" ViewValueValuesEnumr o & L r! r r r r r' r rD rE Tru r r Nr r r r r r rF r r rJ filterr r( r rG r r\ pageSize pageTokenrg viewr r r! r" r r D .inn & INN 2 6 :&
"
"1
%( q !$
#
#Ay/@/@/F/F
G(##A&)##A5) 2A 6$r! r c \ rS rSrSr " S S\R 5 r\R " SS5 r \R " S5 r \R " SS S
9r \R " S 5 r
\R " SS 5 rS
rg)!DataflowProjectsJobsCreateRequesti a
A DataflowProjectsJobsCreateRequest object.
Enums:
ViewValueValuesEnum: The level of information requested in response.
Fields:
job: A Job resource to be passed as the request body.
location: The [regional endpoint]
(https://cloud.google.com/dataflow/docs/concepts/regional-endpoints)
that contains this job.
projectId: The ID of the Cloud Platform project that the job belongs to.
replaceJobId: Deprecated. This field is now in the Job message.
view: The level of information requested in response.
c ( \ rS rSrSrSrSrSrSrSr g) 5DataflowProjectsJobsCreateRequest.ViewValueValuesEnumi The level of information requested in response.
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/ref
erence/rest/v1b3/projects.jobs#jobstate).
JOB_VIEW_DESCRIPTION: Request summary info and limited job description
data for steps, labels and environment.
r r r r r Nr r r! r" r r $ L r! r Jobr r r Tru r' rD r Nr r r r r r rF r r jobr r( rg replaceJobIdrJ r r r r! r" r r sp
INN 0 ua(#
"
"1
%(##A5)&&q), 2A 6$r! r c \ rS rSrSr\R " SS5 r\R " SSS9r \R " SSS9r
S r g
) )DataflowProjectsJobsDebugGetConfigRequesti zA DataflowProjectsJobsDebugGetConfigRequest object.
Fields:
getDebugConfigRequest: A GetDebugConfigRequest resource to be passed as
the request body.
jobId: The job id.
projectId: The project id.
GetDebugConfigRequestr r Tru r r N) r r r r r r r getDebugConfigRequestr jobIdrg r r r! r" r r sA $001H!L
D
1%##A5)r! r c \ rS rSrSr\R " SSS9r\R " SSS9r\R " SS5 r
S r g
) +DataflowProjectsJobsDebugSendCaptureRequesti zA DataflowProjectsJobsDebugSendCaptureRequest object.
Fields:
jobId: The job id.
projectId: The project id.
sendDebugCaptureRequest: A SendDebugCaptureRequest resource to be passed
as the request body.
r Tru r SendDebugCaptureRequestr r N) r r r r r r r r rg r sendDebugCaptureRequestr r r! r" r r sA
D
1%##A5) % 2 23La Pr! r c \ rS rSrSr\R " SSS9r\R " S5 r\R " SSS9r \R " S5 r
S r g
) %DataflowProjectsJobsGetMetricsRequesti a A DataflowProjectsJobsGetMetricsRequest object.
Fields:
jobId: The job to get metrics for.
location: The [regional endpoint]
(https://cloud.google.com/dataflow/docs/concepts/regional-endpoints)
that contains the job specified by job_id.
projectId: A project id.
startTime: Return only metric data that has changed since this time.
Default is to return all information about all metrics for the job.
r Tru r r r' r N r r r r r r r r r( rg startTimer r r! r" r r sM
D
1%
"
"1
%(##A5)##A&)r! r c \ rS rSrSr " S S\R 5 r\R " SSS9r \R " S5 r
\R " S SS9r \R " SS
5 r
S rg )
DataflowProjectsJobsGetRequesti a A DataflowProjectsJobsGetRequest object.
Enums:
ViewValueValuesEnum: The level of information requested in response.
Fields:
jobId: The job ID.
location: The [regional endpoint]
(https://cloud.google.com/dataflow/docs/concepts/regional-endpoints)
that contains this job.
projectId: The ID of the Cloud Platform project that the job belongs to.
view: The level of information requested in response.
c ( \ rS rSrSrSrSrSrSrSr g) 2DataflowProjectsJobsGetRequest.ViewValueValuesEnumi r r r r r r Nr r r! r" r r r r! r r Tru r r r' r Nr r r r r r rF r r r r( rg rJ r r r r! r" r r s` INN 0
D
1%
"
"1
%(##A5) 2A 6$r! r c \ rS rSrSr " S S\R 5 r " S S\R 5 r\R " SS5 r
\R " S5 r \R " S 5 r
\R " S
\R R S 9r\R " S 5 r\R " S
SS9r\R " SS5 rSrg) DataflowProjectsJobsListRequesti au A DataflowProjectsJobsListRequest object.
Enums:
FilterValueValuesEnum: The kind of filter to use.
ViewValueValuesEnum: Deprecated. ListJobs always returns summaries now.
Use GetJob for other JobViews.
Fields:
filter: The kind of filter to use.
location: The [regional endpoint]
(https://cloud.google.com/dataflow/docs/concepts/regional-endpoints)
that contains this job.
name: Optional. The job name.
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.
pageToken: Set this to the 'next_page_token' field of a previous response
to request additional results in a long list.
projectId: The project which owns the jobs.
view: Deprecated. ListJobs always returns summaries now. Use GetJob for
other JobViews.
c ( \ rS rSrSrSrSrSrSrSr g) 5DataflowProjectsJobsListRequest.FilterValueValuesEnumi6 r r r r r r Nr r r! r" r r 6 r r! r c ( \ rS rSrSrSrSrSrSrSr g) 3DataflowProjectsJobsListRequest.ViewValueValuesEnumiI r r r r r r Nr r r! r" r r I r r! r r r r r' r rD rE Tru r r Nr r r! r" r r r r! r c \ rS rSrSr " S S\R 5 r\R " S5 r \R " SSS9r
\R " S 5 r \R " SS
5 r
\R " S \R R S 9r\R " S
5 r\R " SSS9r\R " S5 rSrg)'DataflowProjectsJobsMessagesListRequestik aY A DataflowProjectsJobsMessagesListRequest object.
Enums:
MinimumImportanceValueValuesEnum: Filter to only get messages with
importance >= level
Fields:
endTime: Return only messages with timestamps < end_time. The default is
now (i.e. return up to the latest messages available).
jobId: The job to get messages about.
location: The [regional endpoint]
(https://cloud.google.com/dataflow/docs/concepts/regional-endpoints)
that contains the job specified by job_id.
minimumImportance: Filter to only get messages with importance >= level
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.
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.
projectId: A project id.
startTime: If specified, return only messages with timestamps >=
start_time. The default is the job creation time (i.e. beginning of
messages).
c 0 \ rS rSrSrSrSrSrSrSr Sr
S r g
) HDataflowProjectsJobsMessagesListRequest.MinimumImportanceValueValuesEnumi 9 Filter to only get messages with importance >= level
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.
r r r r r' rD r N r r r r r JOB_MESSAGE_IMPORTANCE_UNKNOWNJOB_MESSAGE_DEBUGJOB_MESSAGE_DETAILEDJOB_MESSAGE_BASICJOB_MESSAGE_WARNINGJOB_MESSAGE_ERRORr r r! r" MinimumImportanceValueValuesEnumr - 8 &'" r! r r r Tru r r' rD r rE r r r Nr r r r r r rF r r endTimer r( rJ minimumImportancerG r r\ r r rg r r r r! r" r r k s 4" "H
! !! $'
D
1%
"
"1
%( ))*LaP
#
#Ay/@/@/F/F
G(##A&)##A5)##A&)r! r c \ rS rSrSr\R " SSS9r\R " SSS9r\R " SS5 r
S r g
) #DataflowProjectsJobsSnapshotRequesti zA DataflowProjectsJobsSnapshotRequest object.
Fields:
jobId: The job to be snapshotted.
projectId: The project which owns the job to be snapshotted.
snapshotJobRequest: A SnapshotJobRequest resource to be passed as the
request body.
r Tru r SnapshotJobRequestr r N) r r r r r r r r rg r snapshotJobRequestr r r! r" r r sA
D
1%##A5) --.BAFr! r c \ rS rSrSr\R " SS5 r\R " SSS9r \R " S5 r
\R " S SS9r \R " S
5 r S r
g )
!DataflowProjectsJobsUpdateRequesti a A DataflowProjectsJobsUpdateRequest object.
Fields:
job: A Job resource to be passed as the request body.
jobId: The job ID.
location: The [regional endpoint]
(https://cloud.google.com/dataflow/docs/concepts/regional-endpoints)
that contains this job.
projectId: The ID of the Cloud Platform project that the job belongs to.
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.
r r r Tru r r' rD r Nr r r r r r r r r r r( rg
updateMaskr r r! r" r r s_ " ua(#
D
1%
"
"1
%(##A5)$$Q'*r! r c \ rS rSrSr\R " SSS9r\R " SS5 r \R " SSS9r
S r g
) )DataflowProjectsJobsWorkItemsLeaseRequesti a A DataflowProjectsJobsWorkItemsLeaseRequest object.
Fields:
jobId: Identifies the workflow job this worker belongs to.
leaseWorkItemRequest: A LeaseWorkItemRequest resource to be passed as the
request body.
projectId: Identifies the project this worker belongs to.
r Tru LeaseWorkItemRequestr r r N) r r r r r r r r r leaseWorkItemRequestrg r r r! r" r r sA
D
1%"//0FJ##A5)r! r c \ rS rSrSr\R " SSS9r\R " SSS9r\R " SS5 r
S r g
) 0DataflowProjectsJobsWorkItemsReportStatusRequesti a A DataflowProjectsJobsWorkItemsReportStatusRequest object.
Fields:
jobId: The job which the WorkItem is part of.
projectId: The project which owns the WorkItem's job.
reportWorkItemStatusRequest: A ReportWorkItemStatusRequest resource to be
passed as the request body.
r Tru r ReportWorkItemStatusRequestr r N) r r r r r r r r rg r reportWorkItemStatusRequestr r r! r" r r sB
D
1%##A5) ) 6 67TVW X r! r c \ rS rSrSr\R " SS5 r\R " S5 r \R " SSS9r
\R " S 5 r \R " S
5 r
S rg )
1DataflowProjectsLocationsDeploymentsCreateRequesti a A DataflowProjectsLocationsDeploymentsCreateRequest object.
Fields:
deployment: A Deployment resource to be passed as the request body.
deploymentId: The ID to use for the Cloud Dataflow job deployment, which
will become the final component of the deployment's resource name. This
value should be 4-63 characters, and valid characters are /a-z-/.
parent: Required. The parent resource where this deployment will be
created. Format: projects/{project}/locations/{location}
requestId: A unique identifier for this request. Restricted to 36 ASCII
characters. A random UUID is recommended. This request is only
idempotent if a `request_id` is provided.
validateOnly: Validate an intended change to see what the result will be
before actually making the change.
Deploymentr r r Tru r' rD r N)r r r r r r r
deploymentr deploymentIdr requestIdr validateOnlyr r r! r" r r s] %%lA6*&&q), T 2&##A&)''*,r! r c \ rS rSrSr\R " S5 r\R " S5 r \R " SSS9r
\R " S5 r S r g
) 1DataflowProjectsLocationsDeploymentsDeleteRequesti a A DataflowProjectsLocationsDeploymentsDeleteRequest object.
Fields:
allowMissing: If set to true, and the `Deployment` is not found, the
request will succeed but no action will be taken on the server.
etag: The current etag of the Deployment. Checksum computed by the server.
Ensure that the client has an up-to-date value before proceeding. If an
etag is provided and does not match the current etag of the
`Deployment`, request will be blocked and an ABORTED error will be
returned.
name: Required. The name of the `Deployment`. Format:
projects/{project}/locations/{location}/deployments/{deployment_id}
validateOnly: Validate an intended change to see what the result will be
before actually making the change.
r r r Tru r' r N)
r r r r r r r allowMissingr etagr r r r r! r" r r sK ''*, q !$ q4 0$''*,r! r c \ rS rSrSr " S S\R 5 r\R " SSS9r \R " SS5 r S r g
) .DataflowProjectsLocationsDeploymentsGetRequesti) a
A DataflowProjectsLocationsDeploymentsGetRequest object.
Enums:
ViewValueValuesEnum:
Fields:
name: Required. The name of the `Deployment`. Format:
projects/{project}/locations/{location}/deployments/{deployment_id}
view: A ViewValueValuesEnum attribute.
c $ \ rS rSrSrSrSrSrSrg)BDataflowProjectsLocationsDeploymentsGetRequest.ViewValueValuesEnumi5 a ViewValueValuesEnum enum type.
Values:
DEPLOYMENT_VIEW_UNSPECIFIED: The deployment view to return isn't
specified, or is unknown. Responses will contain at least the
`DEPLOYMENT_VIEW_ALL` information, and may contain additional
information.
DEPLOYMENT_VIEW_ALL: Request all information available for this
deployment.
DEPLOYMENT_VIEW_MUTABLE: Request all mutable information available for
this deployment.
r r r r N) r r r r r DEPLOYMENT_VIEW_UNSPECIFIEDDEPLOYMENT_VIEW_ALLDEPLOYMENT_VIEW_MUTABLEr r r! r" r r 5 s #$ r! r r Tru r r N)
r r r r r r rF r r r rJ r r r r! r" r r ) s> INN "
q4 0$ 2A 6$r! r c \ rS rSrSr\R " S\R R S9r \R " S5 r \R " SSS9r S r
g
) /DataflowProjectsLocationsDeploymentsListRequestiJ a A DataflowProjectsLocationsDeploymentsListRequest object.
Fields:
pageSize: The maximum number of deployments to return. The service may
return fewer than this value. If unspecified, at most 50 deployments
will be returned. The maximum value is 1000; values above 1000 will be
coerced to 1000.
pageToken: A page token, received from a previous `ListDeployments` call.
Provide this to retrieve the subsequent page. When paginating, all other
parameters provided to `ListDeployments` must match the call that
provided the page token.
parent: Required. The `location`, which owns this collection of
deployments. Format: projects/{project}/locations/{location}
r r r r Tru r Nr r r r r r rG r r\ r r r r r r r! r" r r J sI
#
#Ay/@/@/F/F
G(##A&) T 2&r! r c \ rS rSrSr\R " SSS9r\R " S\R R S9r \R " S5 r S r
g
) 8DataflowProjectsLocationsDeploymentsListRevisionsRequesti_ a A DataflowProjectsLocationsDeploymentsListRevisionsRequest object.
Fields:
name: Required. The name of the `Deployment`. Format:
projects/{project}/locations/{location}/deployments/{deployment_id}
pageSize: The maximum number of deployments to return. The service may
return fewer than this value. If unspecified, at most 50 deployments
will be returned. The maximum value is 1000; values above 1000 will be
coerced to 1000.
pageToken: A page token, received from a previous `ListDeployments` call.
Provide this to retrieve the subsequent page. When paginating, all other
parameters provided to `ListDeployments` must match the call that
provided the page token.
r Tru r r r r N)r r r r r r r r rG r r\ r r r r r! r" r r _ sI
q4 0$
#
#Ay/@/@/F/F
G(##A&)r! r c \ rS rSrSr\R " S5 r\R " SS5 r \R " SSS9r \R " S 5 r \R " S
5 r
\R " S 5 rS rg
)0DataflowProjectsLocationsDeploymentsPatchRequestit a A DataflowProjectsLocationsDeploymentsPatchRequest object.
Fields:
allowMissing: If set to true, and the `Deployment` is not found, a new
`Deployment` will be created.
deployment: A Deployment resource to be passed as the request body.
name: Required. The name of the `Deployment`. Format:
projects/{project}/locations/{location}/deployments/{deployment_id}
requestId: A unique identifier for this request. Restricted to 36 ASCII
characters. A random UUID is recommended. This request is only
idempotent if a `request_id` is provided.
updateMask: The list of fields to update.
validateOnly: Validate an intended change to see what the result will be
before actually making the change.
r r r r Tru r' rD rE r N)r r r r r r r r r r r r r r r r r r! r" r r t sm ''*,%%lA6* q4 0$##A&)$$Q'*''*,r! r c ` \ rS rSrSr\R " SSS9r\R " SS5 r Sr
g )
3DataflowProjectsLocationsDeploymentsRollbackRequesti a/ A DataflowProjectsLocationsDeploymentsRollbackRequest object.
Fields:
name: Required. The name of the `Deployment`. Format:
projects/{project}/locations/{location}/deployments/{deployment_id}
rollbackDeploymentRequest: A RollbackDeploymentRequest resource to be
passed as the request body.
r Tru RollbackDeploymentRequestr r N) r r r r r r r r r rollbackDeploymentRequestr r r! r" r r s0
q4 0$ ' 4 45PRS Tr! r c \ rS rSrSr\R " SS5 r\R " SSS9r \R " SSS9r
S r g
) 3DataflowProjectsLocationsFlexTemplatesLaunchRequesti a A DataflowProjectsLocationsFlexTemplatesLaunchRequest object.
Fields:
launchFlexTemplateRequest: A LaunchFlexTemplateRequest resource to be
passed as the request body.
location: Required. The [regional endpoint]
(https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) to
which to direct the request. E.g., us-central1, us-west1.
projectId: Required. The ID of the Cloud Platform project that the job
belongs to.
LaunchFlexTemplateRequestr r Tru r r N) r r r r r r r launchFlexTemplateRequestr r( rg r r r! r" r r sB
( 4 45PRS T
"
"1t
4(##A5)r! r c \ rS rSrSr " S S\R 5 r\R " SS5 r \R " SSS 9r \R " S
SS 9r \R " S 5 r
\R " SS 5 rS
rg)*DataflowProjectsLocationsJobsCreateRequesti a A DataflowProjectsLocationsJobsCreateRequest object.
Enums:
ViewValueValuesEnum: The level of information requested in response.
Fields:
job: A Job resource to be passed as the request body.
location: The [regional endpoint]
(https://cloud.google.com/dataflow/docs/concepts/regional-endpoints)
that contains this job.
projectId: The ID of the Cloud Platform project that the job belongs to.
replaceJobId: Deprecated. This field is now in the Job message.
view: The level of information requested in response.
c ( \ rS rSrSrSrSrSrSrSr g) >DataflowProjectsLocationsJobsCreateRequest.ViewValueValuesEnumi r r r r r r Nr r r! r" r r r r! r r r r Tru r r' rD r Nr r r! r" r
r
sr
INN 0 ua(#
"
"1t
4(##A5)&&q), 2A 6$r! r
c \ rS rSrSr\R " SS5 r\R " SSS9r \R " SSS9r
\R " S SS9r S
r g ) 2DataflowProjectsLocationsJobsDebugGetConfigRequesti at A DataflowProjectsLocationsJobsDebugGetConfigRequest object.
Fields:
getDebugConfigRequest: A GetDebugConfigRequest resource to be passed as
the request body.
jobId: The job id.
location: The [regional endpoint]
(https://cloud.google.com/dataflow/docs/concepts/regional-endpoints)
that contains the job specified by job_id.
projectId: The project id.
r r r Tru r r' r N)
r r r r r r r r r r r( rg r r r! r" r r sS
$001H!L
D
1%
"
"1t
4(##A5)r! r c \ rS rSrSr\R " SS5 r\R " SSS9r \R " SSS9r
\R " S SS9r S
r g ) =DataflowProjectsLocationsJobsDebugGetWorkerStacktracesRequesti a A DataflowProjectsLocationsJobsDebugGetWorkerStacktracesRequest object.
Fields:
getWorkerStacktracesRequest: A GetWorkerStacktracesRequest resource to be
passed as the request body.
jobId: The job for which to get stacktraces.
location: The [regional endpoint]
(https://cloud.google.com/dataflow/docs/concepts/regional-endpoints)
that contains the job specified by job_id.
projectId: The project id.
GetWorkerStacktracesRequestr r Tru r r' r N)
r r r r r r r getWorkerStacktracesRequestr r r( rg r r r! r" r r sT
!* 6 67TVW X
D
1%
"
"1t
4(##A5)r! r c \ rS rSrSr\R " SSS9r\R " SSS9r\R " SSS9r \R " SS 5 r S
r g ) 4DataflowProjectsLocationsJobsDebugSendCaptureRequesti az A DataflowProjectsLocationsJobsDebugSendCaptureRequest object.
Fields:
jobId: The job id.
location: The [regional endpoint]
(https://cloud.google.com/dataflow/docs/concepts/regional-endpoints)
that contains the job specified by job_id.
projectId: The project id.
sendDebugCaptureRequest: A SendDebugCaptureRequest resource to be passed
as the request body.
r Tru r r r r' r N)
r r r r r r r r r( rg r r r r r! r" r r sS
D
1%
"
"1t
4(##A5) % 2 23La Pr! r c \ rS rSrSr\R " SSS9r\R " SSS9r\R " S\R R S9r \R " S 5 r
\R " S
SS9rS rg )
7DataflowProjectsLocationsJobsGetExecutionDetailsRequesti a A DataflowProjectsLocationsJobsGetExecutionDetailsRequest object.
Fields:
jobId: The job to get execution details for.
location: The [regional endpoint]
(https://cloud.google.com/dataflow/docs/concepts/regional-endpoints)
that contains the job specified by job_id.
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.
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.
projectId: A project id.
r Tru r r r r' rD r N)r r r r r r r r r( rG r r\ r r rg r r r! r" r r sm
D
1%
"
"1t
4(
#
#Ay/@/@/F/F
G(##A&)##A5)r! r c \ rS rSrSr\R " SSS9r\R " SSS9r\R " SSS9r \R " S5 r
S r g
) .DataflowProjectsLocationsJobsGetMetricsRequesti- a A DataflowProjectsLocationsJobsGetMetricsRequest object.
Fields:
jobId: The job to get metrics for.
location: The [regional endpoint]
(https://cloud.google.com/dataflow/docs/concepts/regional-endpoints)
that contains the job specified by job_id.
projectId: A project id.
startTime: Return only metric data that has changed since this time.
Default is to return all information about all metrics for the job.
r Tru r r r' r Nr r r! r" r r - sO
D
1%
"
"1t
4(##A5)##A&)r! r c \ rS rSrSr " S S\R 5 r\R " SSS9r \R " SSS9r
\R " S SS9r \R " SS
5 r
S rg )
'DataflowProjectsLocationsJobsGetRequesti@ a A DataflowProjectsLocationsJobsGetRequest object.
Enums:
ViewValueValuesEnum: The level of information requested in response.
Fields:
jobId: The job ID.
location: The [regional endpoint]
(https://cloud.google.com/dataflow/docs/concepts/regional-endpoints)
that contains this job.
projectId: The ID of the Cloud Platform project that the job belongs to.
view: The level of information requested in response.
c ( \ rS rSrSrSrSrSrSrSr g) ;DataflowProjectsLocationsJobsGetRequest.ViewValueValuesEnumiO r r r r r r Nr r r! r" r r O r r! r r Tru r r r' r Nr r r! r" r r @ sb INN 0
D
1%
"
"1t
4(##A5) 2A 6$r! r c \ rS rSrSr " S S\R 5 r " S S\R 5 r\R " SS5 r
\R " SS S
9r \R " S 5 r
\R " S \R R S
9r\R " S5 r\R " SS S
9r\R " SS5 rSrg)(DataflowProjectsLocationsJobsListRequestim a~ A DataflowProjectsLocationsJobsListRequest object.
Enums:
FilterValueValuesEnum: The kind of filter to use.
ViewValueValuesEnum: Deprecated. ListJobs always returns summaries now.
Use GetJob for other JobViews.
Fields:
filter: The kind of filter to use.
location: The [regional endpoint]
(https://cloud.google.com/dataflow/docs/concepts/regional-endpoints)
that contains this job.
name: Optional. The job name.
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.
pageToken: Set this to the 'next_page_token' field of a previous response
to request additional results in a long list.
projectId: The project which owns the jobs.
view: Deprecated. ListJobs always returns summaries now. Use GetJob for
other JobViews.
c ( \ rS rSrSrSrSrSrSrSr g) >DataflowProjectsLocationsJobsListRequest.FilterValueValuesEnumi r r r r r r Nr r r! r" r r# r r! r c ( \ rS rSrSrSrSrSrSrSr g) = level
Fields:
endTime: Return only messages with timestamps < end_time. The default is
now (i.e. return up to the latest messages available).
jobId: The job to get messages about.
location: The [regional endpoint]
(https://cloud.google.com/dataflow/docs/concepts/regional-endpoints)
that contains the job specified by job_id.
minimumImportance: Filter to only get messages with importance >= level
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.
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.
projectId: A project id.
startTime: If specified, return only messages with timestamps >=
start_time. The default is the job creation time (i.e. beginning of
messages).
c 0 \ rS rSrSrSrSrSrSrSr Sr
S r g
) QDataflowProjectsLocationsJobsMessagesListRequest.MinimumImportanceValueValuesEnumi r r r r r r' rD r Nr r r! r" r r) r r! r r r Tru r r' rD r rE r r r Nr r r! r" r' r' s 4" "H
! !! $'
D
1%
"
"1t
4( ))*LaP
#
#Ay/@/@/F/F
G(##A&)##A5)##A&)r! r' c \ rS rSrSr\R " SSS9r\R " SSS9r\R " SSS9r \R " SS 5 r S
r g ) ,DataflowProjectsLocationsJobsSnapshotRequesti a. A DataflowProjectsLocationsJobsSnapshotRequest object.
Fields:
jobId: The job to be snapshotted.
location: The location that contains this job.
projectId: The project which owns the job to be snapshotted.
snapshotJobRequest: A SnapshotJobRequest resource to be passed as the
request body.
r Tru r r r r' r N)
r r r r r r r r r( rg r r r r r! r" r+ r+ sS
D
1%
"
"1t
4(##A5) --.BAFr! r+ c ~ \ rS rSrSr\R " SSS9r\R " SSS9r\R " SSS9r Sr
g )
1DataflowProjectsLocationsJobsSnapshotsListRequesti zA DataflowProjectsLocationsJobsSnapshotsListRequest object.
Fields:
jobId: If specified, list snapshots created from this job.
location: The location to list snapshots in.
projectId: The project ID to list snapshots for.
r Tru r r r N r r r r r r r r r( rg r r r! r" r- r- s?
D
1%
"
"1t
4(##A5)r! r- c V \ rS rSrSr\R " S5 r\R " SSS9r\R " SSS9r \R " S\R R S 9r
\R " S
5 r\R " S SS9r\R " S SS9r\R " S
5 rSrg)=DataflowProjectsLocationsJobsStagesGetExecutionDetailsRequesti" aj A DataflowProjectsLocationsJobsStagesGetExecutionDetailsRequest object.
Fields:
endTime: Upper time bound of work items to include, by start time.
jobId: The job to get execution details for.
location: The [regional endpoint]
(https://cloud.google.com/dataflow/docs/concepts/regional-endpoints)
that contains the job specified by job_id.
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.
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.
projectId: A project id.
stageId: The stage for which to fetch information.
startTime: Lower time bound of work items to include, by start time.
r r Tru r r' r rD rE r r r N)r r r r r r r r r r( rG r r\ r r rg stageIdr r r r! r" r0 r0 " s &
! !! $'
D
1%
"
"1t
4(
#
#Ay/@/@/F/F
G(##A&)##A5) ! !!d 3'##A&)r! r0 c \ rS rSrSr\R " SS5 r\R " SSS9r \R " SSS9r
\R " S SS9r \R " S
5 r S r
g )
*DataflowProjectsLocationsJobsUpdateRequesti@ a A DataflowProjectsLocationsJobsUpdateRequest object.
Fields:
job: A Job resource to be passed as the request body.
jobId: The job ID.
location: The [regional endpoint]
(https://cloud.google.com/dataflow/docs/concepts/regional-endpoints)
that contains this job.
projectId: The ID of the Cloud Platform project that the job belongs to.
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.
r r r Tru r r' rD r Nr r r! r" r3 r3 @ sa " ua(#
D
1%
"
"1t
4(##A5)$$Q'*r! r3 c \ rS rSrSr\R " SSS9r\R " SS5 r \R " SSS9r
\R " S SS9r S
r g ) 2DataflowProjectsLocationsJobsWorkItemsLeaseRequestiY a A DataflowProjectsLocationsJobsWorkItemsLeaseRequest object.
Fields:
jobId: Identifies the workflow job this worker belongs to.
leaseWorkItemRequest: A LeaseWorkItemRequest resource to be passed as the
request body.
location: The [regional endpoint]
(https://cloud.google.com/dataflow/docs/concepts/regional-endpoints)
that contains the WorkItem's job.
projectId: Identifies the project this worker belongs to.
r Tru r r r r' r N)
r r r r r r r r r r r( rg r r r! r" r5 r5 Y sS
D
1%"//0FJ
"
"1t
4(##A5)r! r5 c \ rS rSrSr\R " SSS9r\R " SSS9r\R " SSS9r \R " SS 5 r S
r g ) 9DataflowProjectsLocationsJobsWorkItemsReportStatusRequestil a A DataflowProjectsLocationsJobsWorkItemsReportStatusRequest object.
Fields:
jobId: The job which the WorkItem is part of.
location: The [regional endpoint]
(https://cloud.google.com/dataflow/docs/concepts/regional-endpoints)
that contains the WorkItem's job.
projectId: The project which owns the WorkItem's job.
reportWorkItemStatusRequest: A ReportWorkItemStatusRequest resource to be
passed as the request body.
r Tru r r r r' r N)
r r r r r r r r r( rg r r r r r! r" r7 r7 l sT
D
1%
"
"1t
4(##A5) ) 6 67TVW X r! r7 c ~ \ rS rSrSr\R " SSS9r\R " SSS9r\R " SSS9r Sr
g )
/DataflowProjectsLocationsSnapshotsDeleteRequesti zA DataflowProjectsLocationsSnapshotsDeleteRequest object.
Fields:
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.
r Tru r r r Nr r r! r" r9 r9 ?
"
"1t
4(##A5)$$Q6*r! r9 c ~ \ rS rSrSr\R " SSS9r\R " SSS9r\R " SSS9r Sr
g )
,DataflowProjectsLocationsSnapshotsGetRequesti zA DataflowProjectsLocationsSnapshotsGetRequest object.
Fields:
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.
r Tru r r r Nr r r! r" r< r< r: r! r< c \ rS rSrSr\R " S5 r\R " SSS9r\R " SSS9r Sr
g )
-DataflowProjectsLocationsSnapshotsListRequesti zA DataflowProjectsLocationsSnapshotsListRequest object.
Fields:
jobId: If specified, list snapshots created from this job.
location: The location to list snapshots in.
projectId: The project ID to list snapshots for.
r r Tru r r Nr. r r! r" r> r> s=
"%
"
"1t
4(##A5)r! r> c \ rS rSrSr\R " SS5 r\R " SSS9r \R " SSS9r
S r g
) /DataflowProjectsLocationsTemplatesCreateRequesti a A DataflowProjectsLocationsTemplatesCreateRequest object.
Fields:
createJobFromTemplateRequest: A CreateJobFromTemplateRequest resource to
be passed as the request body.
location: The [regional endpoint]
(https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) to
which to direct the request.
projectId: Required. The ID of the Cloud Platform project that the job
belongs to.
r r r Tru r r N) r r r r r r r createJobFromTemplateRequestr r( rg r r r! r" r@ r@ sB
"+!7!78VXY!Z
"
"1t
4(##A5)r! r@ c \ rS rSrSr " S S\R 5 r\R " S5 r \R " SSS9r
\R " S SS9r \R " SS
5 r
S rg )
,DataflowProjectsLocationsTemplatesGetRequesti aH A DataflowProjectsLocationsTemplatesGetRequest object.
Enums:
ViewValueValuesEnum: The view to retrieve. Defaults to METADATA_ONLY.
Fields:
gcsPath: Required. A Cloud Storage path to the template from which to
create the job. Must be valid Cloud Storage URL, beginning with 'gs://'.
location: The [regional endpoint]
(https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) to
which to direct the request.
projectId: Required. The ID of the Cloud Platform project that the job
belongs to.
view: The view to retrieve. Defaults to METADATA_ONLY.
c \ rS rSrSrSrSrg)@DataflowProjectsLocationsTemplatesGetRequest.ViewValueValuesEnumi The view to retrieve. Defaults to METADATA_ONLY.
Values:
METADATA_ONLY: Template view that retrieves only the metadata associated
with the template.
r r Nr r r r r
METADATA_ONLYr r r! r" r rE Mr! r r r Tru r r' r Nr r r r r r rF r r r& r( rg rJ r r r r! r" rC rC s` INN
! !! $'
"
"1t
4(##A5) 2A 6$r! rC c \ rS rSrSr\R " S5 r\R " S5 r\R " S5 r \R " SS5 r \R " SS S
9r \R " S S S
9r
\R " S 5 rS
rg)/DataflowProjectsLocationsTemplatesLaunchRequesti a A DataflowProjectsLocationsTemplatesLaunchRequest object.
Fields:
dynamicTemplate_gcsPath: Path to the dynamic template specification file
on Cloud Storage. The file must be a JSON serialized
`DynamicTemplateFileSpec` object.
dynamicTemplate_stagingLocation: Cloud Storage path for staging
dependencies. Must be a valid Cloud Storage URL, beginning with `gs://`.
gcsPath: A Cloud Storage path to the template to use to create the job.
Must be valid Cloud Storage URL, beginning with `gs://`.
launchTemplateParameters: A LaunchTemplateParameters resource to be passed
as the request body.
location: The [regional endpoint]
(https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) to
which to direct the request.
projectId: Required. The ID of the Cloud Platform project that the job
belongs to.
validateOnly: If true, the request is validated but not actually executed.
Defaults to false.
r r r LaunchTemplateParametersr' rD Tru rE r r Nr r r r r r r dynamicTemplate_gcsPath dynamicTemplate_stagingLocationr& r launchTemplateParametersr( rg r r r r r! r" rL rL s * & 1 1! 4$-$9$9!$<! ! !! $' & 3 34NPQ R
"
"1t
4(##A5)''*,r! rL c \ rS rSrSr\R " SSS9r\R " SSS9r\R " SS5 r
S r g
) .DataflowProjectsLocationsWorkerMessagesRequesti aj A DataflowProjectsLocationsWorkerMessagesRequest object.
Fields:
location: The [regional endpoint]
(https://cloud.google.com/dataflow/docs/concepts/regional-endpoints)
that contains the job.
projectId: The project to send the WorkerMessages to.
sendWorkerMessagesRequest: A SendWorkerMessagesRequest resource to be
passed as the request body.
r Tru r SendWorkerMessagesRequestr r N) r r r r r r r r( rg r sendWorkerMessagesRequestr r r! r" rS rS sB
"
"1t
4(##A5) ' 4 45PRS Tr! rS c \ rS rSrSr\R " S5 r\R " SSS9r\R " SSS9r Sr
g )
#DataflowProjectsSnapshotsGetRequesti
zA DataflowProjectsSnapshotsGetRequest object.
Fields:
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.
r r Tru r r Nr r r! r" rW rW
s=
"
"1
%(##A5)$$Q6*r! rW c \ rS rSrSr\R " S5 r\R " S5 r\R " SSS9r Sr
g )
$DataflowProjectsSnapshotsListRequesti zA DataflowProjectsSnapshotsListRequest object.
Fields:
jobId: If specified, list snapshots created from this job.
location: The location to list snapshots in.
projectId: The project ID to list snapshots for.
r r r Tru r Nr. r r! r" rY rY s;
"%
"
"1
%(##A5)r! rY c \ rS rSrSr\R " S\R R S9r \R " S5 r \R " SSS9r S r
g
) +DataflowProjectsTemplateVersionsListRequesti* a A DataflowProjectsTemplateVersionsListRequest object.
Fields:
pageSize: The maximum number of TemplateVersions to return per page.
pageToken: The page token, received from a previous ListTemplateVersions
call. Provide this to retrieve the subsequent page.
parent: parent includes project_id, and display_name is optional. List by
project_id(pid1) and display_name(tid1). Format:
projects/{pid1}/catalogTemplates/{tid1} List by project_id(pid1).
Format: projects/{pid1}
r r r r Tru r Nr r r! r" r[ r[ * sI
#
#Ay/@/@/F/F
G(##A&) T 2&r! r[ c ` \ rS rSrSr\R " SS5 r\R " SSS9r Sr
g )
&DataflowProjectsTemplatesCreateRequesti< a A DataflowProjectsTemplatesCreateRequest object.
Fields:
createJobFromTemplateRequest: A CreateJobFromTemplateRequest resource to
be passed as the request body.
projectId: Required. The ID of the Cloud Platform project that the job
belongs to.
r r r Tru r N) r r r r r r r rA r rg r r r! r" r] r] < s0 "+!7!78VXY!Z ##A5)r! r] c \ rS rSrSr " S S\R 5 r\R " S5 r \R " S5 r
\R " SSS 9r \R " SS
5 r
S rg )
#DataflowProjectsTemplatesGetRequestiJ a? A DataflowProjectsTemplatesGetRequest object.
Enums:
ViewValueValuesEnum: The view to retrieve. Defaults to METADATA_ONLY.
Fields:
gcsPath: Required. A Cloud Storage path to the template from which to
create the job. Must be valid Cloud Storage URL, beginning with 'gs://'.
location: The [regional endpoint]
(https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) to
which to direct the request.
projectId: Required. The ID of the Cloud Platform project that the job
belongs to.
view: The view to retrieve. Defaults to METADATA_ONLY.
c \ rS rSrSrSrSrg)7DataflowProjectsTemplatesGetRequest.ViewValueValuesEnumi[ rF r r NrG r r! r" r ra [ rI r! r r r r Tru r' r NrJ r r! r" r_ r_ J s^ INN
! !! $'
"
"1
%(##A5) 2A 6$r! r_ c \ rS rSrSr\R " S5 r\R " S5 r\R " S5 r \R " SS5 r \R " S5 r \R " S S
S 9r
\R " S 5 rS
rg)&DataflowProjectsTemplatesLaunchRequestij a A DataflowProjectsTemplatesLaunchRequest object.
Fields:
dynamicTemplate_gcsPath: Path to the dynamic template specification file
on Cloud Storage. The file must be a JSON serialized
`DynamicTemplateFileSpec` object.
dynamicTemplate_stagingLocation: Cloud Storage path for staging
dependencies. Must be a valid Cloud Storage URL, beginning with `gs://`.
gcsPath: A Cloud Storage path to the template to use to create the job.
Must be valid Cloud Storage URL, beginning with `gs://`.
launchTemplateParameters: A LaunchTemplateParameters resource to be passed
as the request body.
location: The [regional endpoint]
(https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) to
which to direct the request.
projectId: Required. The ID of the Cloud Platform project that the job
belongs to.
validateOnly: If true, the request is validated but not actually executed.
Defaults to false.
r r r rM r' rD rE Tru r r NrN r r! r" rc rc j s * & 1 1! 4$-$9$9!$<! ! !! $' & 3 34NPQ R
"
"1
%(##A5)''*,r! rc c ` \ rS rSrSr\R " SSS9r\R " SS5 r Sr
g )
%DataflowProjectsWorkerMessagesRequesti zA DataflowProjectsWorkerMessagesRequest object.
Fields:
projectId: The project to send the WorkerMessages to.
sendWorkerMessagesRequest: A SendWorkerMessagesRequest resource to be
passed as the request body.
r Tru rT r r N) r r r r r r r rg r rU r r r! r" re re s0 ##A5) ' 4 45PRS Tr! re c ` \ rS rSrSr\R " S5 r\R " S5 rSr g)DatastoreIODetailsi zMetadata for a Datastore connector used by the job.
Fields:
namespace: Namespace used in the connection.
projectId: ProjectId accessed in the connection.
r r r N)
r r r r r r r namespacerg r r r! r" rg rg s) ##A&)##A&)r! rg c b \ rS rSrSr\R " SS5 r\R " S5 r Sr
g) DebugOptionsi a# Describes any options that have an effect on the debugging of pipelines.
Fields:
dataSampling: Configuration options for sampling elements from a running
pipeline.
enableHotKeyLogging: Optional. When true, enables the logging of the
literal hot key to the user's Cloud Logging.
r4 r r r N) r r r r r r r dataSamplingr enableHotKeyLoggingr r r! r" rj rj s- ''(.
!:A
>(r! r c \ rS rSrSr " S S\R 5 r\R " SS5 r \R " SS5 r Sr g )
DerivedSourceiR
a 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.
Enums:
DerivationModeValueValuesEnum: What source to base the produced source on
(if any).
Fields:
derivationMode: What source to base the produced source on (if any).
source: Specification of the source.
c ( \ rS rSrSrSrSrSrSrSr g) +DerivedSource.DerivationModeValueValuesEnumia
a What source to base the produced source on (if any).
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.
r r r r r N
r r r r r SOURCE_DERIVATION_MODE_UNKNOWN"SOURCE_DERIVATION_MODE_INDEPENDENT'SOURCE_DERIVATION_MODE_CHILD_OF_CURRENT)SOURCE_DERIVATION_MODE_SIBLING_OF_CURRENTr r r! r" DerivationModeValueValuesEnumr a
! &'")*&./+01-r! r r Sourcer r N
r r r r r r rF r rJ derivationModer sourcer r r! r" r r R
s> 2inn 2$ &&'FJ. ! !(A .&r! r c \ rS rSrSr\R " S5 r\R " S5 r\R " S\R R S9r Sr
g) Diskiw
a Describes the data disk used by a workflow job.
Fields:
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
mountPoint: Directory in a VM where disk is mounted.
sizeGb: Size of disk in GB. If zero or unspecified, the service will
attempt to choose a reasonable default.
r r r r r N)r r r r r r r diskType
mountPointrG r r\ sizeGbr r r! r" r r w
sG ,
"
"1
%($$Q'* ! !!Y->->-D-D E&r! r c \ rS rSrSr\R " S5 r\R " S5 r \R " S\R R S9r
\R " S5 r\R " S5 r\R " S 5 r\R " S
5 r\R " S 5 r\R " S 5 r\R " S
5 r\R " S5 r\R " S5 rSrg) DisplayDatai
aT Data provided with a pipeline or transform to provide descriptive info.
Fields:
boolValue: Contains value if the data is of a boolean type.
durationValue: Contains value if the data is of duration type.
floatValue: Contains value if the data is of float type.
int64Value: Contains value if the data is of int64 type.
javaClassValue: Contains value if the data is of java class type.
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.
label: An optional label to display in a dax UI for the element.
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.
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.
strValue: Contains value if the data is of string type.
timestampValue: Contains value if the data is of timestamp type.
url: An optional full URL.
r r r r r' rD rE r r r r r r r N)r r r r r r r boolValuer
durationValuer r r
floatValuerG
int64ValuejavaClassValuer labelrh
shortStrValuestrValuetimestampValueurlr r r! r" r r
s 2 $$Q')''*-##Ay/@/@/F/FG*%%a(* ((+. a #
"%##A&)''*-
"
"2
&( ((,. b!#r! r c \ rS rSrSr\R " SS5 r\R " SS5 r\R " SS5 r \R " SS5 r
\R " SS 5 r \R " S
5 r
S rg )
r i
a# A metric value representing a distribution.
Fields:
count: The count of the number of elements present in the distribution.
histogram: (Optional) Histogram of value counts for the distribution.
max: The maximum value present in the distribution.
min: The minimum value present in the distribution.
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.
sumOfSquares: Use a double since the sum of squares is likely to overflow
int64.
r r Histogramr r r' rD rE r N)r r r r r r r rq histogrammaxminsumr sumOfSquaresr r r! r" r r
ss
q
1%$$[!4) |Q/# |Q/# |Q/#%%a(,r! r c d \ rS rSrSr\R " SS5 r\R " SS5 rSr g)DynamicSourceSpliti
a 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.
Fields:
primary: Primary part (continued to be processed by worker). Specified
relative to the previously-current source. Becomes current.
residual: Residual part (returned to the pool of work). Specified relative
to the previously-current source.
r r r r N)
r r r r r r r primaryresidualr r r! r" r r
s-
" "?A 6'
#
#OQ
7(r! r c \ rS rSrSrSrg)Emptyi
a A generic empty message that you can re-use to avoid defining duplicated
empty messages in your APIs. A typical example is to use it as the request
or the response type of an API method. For instance: service Foo { rpc
Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
r Nro r r! r" r r
s r! r c \ rS rSrSr " S S\R 5 r " S S\R 5 r " S S\R 5 r \
R " S 5 " S
S \R 5 5 r
\
R " S 5 " S S
\R 5 5 r\
R " S 5 " S S\R 5 5 r\
R " S 5 " S S\R 5 5 r\R" " S5 r\R" " S5 r\R( " SS5 r\R" " SSS9r\R. " SS5 r\R( " S S5 r\R( " S
S5 r\R" " S 5 r\R" " S 5 r \R" " S SS9r \R. " SS 5 r \R. " SS 5 r \R" " S!5 r \RB " S"5 r"\RB " S#5 r#\R( " SS$5 r$\R( " SS%5 r%\R( " S&S'SS9r&\R" " S(5 r'\R" " S)5 r(S*r)g+), Environmenti
a+ Describes the environment in which a Dataflow Job runs.
Enums:
FlexResourceSchedulingGoalValueValuesEnum: Optional. Which Flexible
Resource Scheduling mode to run in.
ShuffleModeValueValuesEnum: Output only. The shuffle mode used for the
job.
StreamingModeValueValuesEnum: 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).
Messages:
InternalExperimentsValue: Experimental settings.
SdkPipelineOptionsValue: 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.
UserAgentValue: Optional. A description of the process that generated the
request.
VersionValue: A structure describing which components and their versions
of the service are required in order to run the job.
Fields:
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".
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}
debugOptions: Optional. Any debugging options to be supplied to the job.
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.
flexResourceSchedulingGoal: Optional. Which Flexible Resource Scheduling
mode to run in.
internalExperiments: Experimental settings.
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.
serviceAccountEmail: Optional. Identity to run virtual machines as.
Defaults to the default account.
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
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).
shuffleMode: Output only. The shuffle mode used for the job.
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).
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}
usePublicIps: Optional. True when any worker pool that uses public IPs is
present.
useStreamingEngineResourceBasedBilling: Output only. Whether the job uses
the Streaming Engine resource-based billing model.
userAgent: Optional. A description of the process that generated the
request.
version: A structure describing which components and their versions of the
service are required in order to run the job.
workerPools: The worker pools. At least one "harness" worker pool must be
specified in order for the job to have workers.
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.
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.
c $ \ rS rSrSrSrSrSrSrg)5Environment.FlexResourceSchedulingGoalValueValuesEnumiJ zOptional. Which Flexible Resource Scheduling mode to run in.
Values:
FLEXRS_UNSPECIFIED: Run in the default mode.
FLEXRS_SPEED_OPTIMIZED: Optimize for lower execution time.
FLEXRS_COST_OPTIMIZED: Optimize for lower cost.
r r r r N r r r r r FLEXRS_UNSPECIFIEDFLEXRS_SPEED_OPTIMIZEDFLEXRS_COST_OPTIMIZEDr r r! r" )FlexResourceSchedulingGoalValueValuesEnumr J s r! r c $ \ rS rSrSrSrSrSrSrg)&Environment.ShuffleModeValueValuesEnumiV zOutput only. The shuffle mode used for the job.
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.
r r r r N) r r r r r SHUFFLE_MODE_UNSPECIFIEDVM_BASED
SERVICE_BASEDr r r! r" ShuffleModeValueValuesEnumr V s ! HMr! r c $ \ rS rSrSrSrSrSrSrg)(Environment.StreamingModeValueValuesEnumib 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).
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.
r r r r N r r r r r STREAMING_MODE_UNSPECIFIEDSTREAMING_MODE_EXACTLY_ONCE STREAMING_MODE_AT_LEAST_ONCEr r r! r" StreamingModeValueValuesEnumr b $ "# "# #$ r! r rz c f \ rS rSrSr " S S\R 5 r\R " SSSS9r Sr
g )
$Environment.InternalExperimentsValueiy zExperimental settings.
Messages:
AdditionalProperty: An additional property for a
InternalExperimentsValue object.
Fields:
additionalProperties: Properties of the object. Contains field @type
with type URL.
c b \ rS rSrSr\R " S5 r\R " SS5 r Sr
g)7Environment.InternalExperimentsValue.AdditionalPropertyi zAn additional property for a InternalExperimentsValue object.
Fields:
key: Name of the additional property.
value: A extra_types.JsonValue attribute.
r r r r Nr r r! r" r r ,
! !! $c$$%>
%Y^^ %. !!"89Z!2!2 Z :Z2 !!"89Z 1 1 Z :Z6 !!"89Zy(( Z :Z. !!"89ZY&& Z :Z0 ' 2 21 5 ! !! $''':,%%a$7+ ( 2 23^`a b !../I1M --.GK!--a0 ++A. ((d;.##$@"E+%%&DbI- ++B/''+,+4+A+A"+E($$%5r:) " ">2 6'&&|R$G+&&r*,$$R(*r! r c \ rS rSrSr " S S\R 5 r\R " S5 r \R " S5 r
\R " SS5 r Sr
g )
ExecutionStageStatei a A message describing the state of a particular execution stage.
Enums:
ExecutionStageStateValueValuesEnum: Executions stage states allow the same
set of values as JobState.
Fields:
currentStateTime: The time at which the stage transitioned to this state.
executionStageName: The name of the execution stage.
executionStageState: Executions stage states allow the same set of values
as JobState.
c T \ rS rSrSrSrSrSrSrSr Sr
S r S
r S r
S rS
rSrSrSrSrSrg)6ExecutionStageState.ExecutionStageStateValueValuesEnumi a:
Executions stage states allow the same set of values as JobState.
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.
JOB_STATE_PAUSING: `JOB_STATE_PAUSING` is not implemented yet.
JOB_STATE_PAUSED: `JOB_STATE_PAUSED` is not implemented yet.
r r r r r' rD rE r r r r r r r r r Nr r r r r JOB_STATE_UNKNOWNJOB_STATE_STOPPEDJOB_STATE_RUNNINGJOB_STATE_DONEJOB_STATE_FAILEDJOB_STATE_CANCELLEDJOB_STATE_UPDATEDJOB_STATE_DRAININGJOB_STATE_DRAINEDJOB_STATE_PENDINGJOB_STATE_CANCELLINGJOB_STATE_QUEUED JOB_STATE_RESOURCE_CLEANING_UPJOB_STATE_PAUSINGJOB_STATE_PAUSEDr r r! r" "ExecutionStageStateValueValuesEnumr sc 6n N %'"r! r) r r r r N)r r r r r r rF r) r currentStateTimeexecutionStageNamerJ executionStageStater r r! r" r r sS F9>> FP **1- ,,Q/!++,PRSTr! r c b \ rS rSrSr " S S\R 5 r\R " SSSS9r \R " S S
SS9r
\R " S 5 r \R " S S
SS9r
\R " SS5 r\R " S5 r\R " S SSS9r\R " SSS9rSrg)ExecutionStageSummaryiQ a 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.
Enums:
KindValueValuesEnum: Type of transform this stage is executing.
Fields:
componentSource: Collections produced and consumed by component transforms
of this stage.
componentTransform: Transforms that comprise this execution stage.
id: Dataflow service generated id for this stage.
inputSource: Input sources for this stage.
kind: Type of transform this stage is executing.
name: Dataflow service generated name for this stage.
outputSource: Output sources for this stage.
prerequisiteStage: Other stages that must complete before this stage can
run.
c < \ rS rSrSrSrSrSrSrSr Sr
S r S
r S r
S rg
))ExecutionStageSummary.KindValueValuesEnumif a Type of transform this stage is executing.
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.
r r r r r' rD rE r r r Nr r r r r UNKNOWN_KIND PAR_DO_KINDGROUP_BY_KEY_KIND FLATTEN_KIND READ_KIND
WRITE_KIND
CONSTANT_KINDSINGLETON_KIND SHUFFLE_KINDr r r! r" r r0 f 7
LKLIJMNLr! r r r Trs r r r StageSourcer' rD rE r r r N)r r r r r r rF r r componentSourcecomponentTransformr id inputSourcerJ r r outputSourceprerequisiteStager r r! r" r. r. Q s (INN 2 **+B* ''(H"M/$$R(*!--b1%%b)+%%b)2C2C2I2IJ* ! !" %'%%b)2C2C2I2IJ*$004 ++B/!--b1 ))"-/%%&DbI-$$R(*&&r*,&&r*,$$R(* r "$r! r c : \ rS rSrSr\R " SSS9rSrg)r i
ziA metric value representing a list of floating point numbers.
Fields:
elements: Elements of the list.
r Trs r N) r r r r r r r elementsr r r! r" r r
s
!
!!d
3(r! r c b \ rS rSrSr\R " SS5 r\R " S5 r Sr
g)r i
zA representation of a floating point mean metric contribution.
Fields:
count: The number of values being aggregated.
sum: The sum of all values being aggregated.
r r r r N) r r r r r r r rq r r r r r! r" r r
s+
q
1% Q #r! r c b \ rS rSrSr\R " S5 r\R " SS5 r Sr
g)GPUUsagei
zInformation about the GPU usage on the worker.
Fields:
timestamp: Required. Timestamp of the measurement.
utilization: Required. Utilization info about the GPU.
r GPUUtilizationr r N) r r r r r r r r r utilizationr r r! r" r r
s, ##A&)&&'7;+r! r c < \ rS rSrSr\R " S5 rSrg)r i
zUtilization details about the GPU.
Fields:
rate: Required. GPU utilization rate of any kernel over the last sample
period in the range of [0, 1].
r r N) r r r r r r r r r r r! r" r r
s
a $r! r c \ rS rSrSr\R " S5 r\R " S5 r\R " S5 r Sr
g)r i
af Request to get updated debug configuration for component.
Fields:
componentId: The internal component id for which debug configuration is
requested.
location: The [regional endpoint]
(https://cloud.google.com/dataflow/docs/concepts/regional-endpoints)
that contains the job specified by job_id.
workerId: The worker id, i.e., VM hostname.
r r r r N) r r r r r r r componentIdr( r r r r! r" r r
s9 %%a(+
"
"1
%(
"
"1
%(r! r c < \ rS rSrSr\R " S5 rSrg)GetDebugConfigResponsei
zResponse to a get debug configuration request.
Fields:
config: The encoded debug configuration for the requested component.
r r N) r r r r r r r configr r r! r" r r
s #&r! r c \ rS rSrSr " S S\R 5 r\R " SS5 r \R " SS5 r
\R " S S
5 r \R " SS 5 r
S rg
)GetTemplateResponsei
a The response to a GetTemplate request.
Enums:
TemplateTypeValueValuesEnum: Template Type.
Fields:
metadata: The template metadata describing the template name, available
parameters, etc.
runtimeMetadata: Describes the runtime metadata with SDKInfo and available
parameters.
status: The status of the get template request. Any problems with the
request will be indicated in the error_details.
templateType: Template Type.
c $ \ rS rSrSrSrSrSrSrg)/GetTemplateResponse.TemplateTypeValueValuesEnumi
zlTemplate Type.
Values:
UNKNOWN: Unknown Template Type.
LEGACY: Legacy Template.
FLEX: Flex Template.
r r r r N) r r r r r r LEGACYFLEXr r r! r" TemplateTypeValueValuesEnumr
s G
F Dr! r r3 r RuntimeMetadatar Statusr r' r N)r r r r r r rF r r r6 runtimeMetadatastatusrJ templateTyper r r! r" r r
sd
INN
#
#$6
:( **+5MB.
r r r r N) r r r r r r r r r r keyTruncatedr r r! r" r r V s9 ##A&) a #''*,r! r c \ rS rSrSr\R " S\R R S9r \R " S\R R S9r
Sr g)rJ ii a An input of an instruction, as a reference to an output of a producer
instruction.
Fields:
outputNum: The output index (origin zero) within the producer.
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.
r r r r N) r r r r r r rG r r\ outputNumproducerInstructionIndexr r r! r" rJ rJ i sF $$Q 0A0A0G0GH) & 3 3Ay?P?P?V?V Wr! rJ c F \ rS rSrSr\R " S5 " S S\R 5 5 r \R " SS5 r \R " S5 r
\R " S5 r\R " S 5 r\R " S
5 r\R " S 5 rS rg
)InstructionOutputiy a An output of an instruction.
Messages:
CodecValue: The codec to use to encode data being written via this output.
Fields:
codec: The codec to use to encode data being written via this output.
name: The user-provided name of this output.
onlyCountKeyBytes: For system-generated byte and mean byte metrics,
certain instructions should only report the key size.
onlyCountValueBytes: For system-generated byte and mean byte metrics,
certain instructions should only report the value size.
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.
systemName: System-defined name of this output. Unique across the
workflow.
rz c f \ rS rSrSr " S S\R 5 r\R " SSSS9r Sr
g )
InstructionOutput.CodecValuei zThe codec to use to encode data being written via this output.
Messages:
AdditionalProperty: An additional property for a CodecValue object.
Fields:
additionalProperties: Properties of the object.
c b \ rS rSrSr\R " S5 r\R " SS5 r Sr
g)/InstructionOutput.CodecValue.AdditionalPropertyi An additional property for a CodecValue object.
Fields:
key: Name of the additional property.
value: A extra_types.JsonValue attribute.
r r r r Nr r r! r" r r r r! r r Trs r Nr r r! r"
CodecValuer r r! r r r r r' rD rE r N)r r r r r r r r r r r codecr r r onlyCountKeyBytesonlyCountValueBytes originalNamer r r r! r" r r y s & !!"89Z9$$ Z :Z.
q
1% q !$ ,,Q/!..q1&&q),$$Q'*r! r c b \ rS rSrSr\R " S5 r\R " SS5 r Sr
g)r i zA metric value representing temporal values of a variable.
Fields:
timestamp: The time at which this value was measured. Measured as msecs
from epoch.
value: The value of the variable represented by this gauge.
r r r r N) r r r r r r r r r r r r r! r" r r s+ ##A&)
q
1%r! r c < \ rS rSrSr\R " SSSS9rSrg) r i z[A metric value representing a list of integers.
Fields:
elements: Elements of the list.
r r Trs r N) r r r r r r r r r r r! r" r r s
#
#L!d
C(r! r c d \ rS rSrSr\R " SS5 r\R " SS5 rSr g)r i zA representation of an integer mean metric contribution.
Fields:
count: The number of values being aggregated.
sum: The sum of all values being aggregated.
r r r r N)
r r r r r r r rq r r r r! r" r r s-
q
1% |Q/#r! r c B \ rS rSrSr " S S\R 5 r " S S\R 5 r " S S\R 5 r \
R " S 5 " S
S \R 5 5 r
\
R " S 5 " S S
\R 5 5 r\R " S5 r\R " S5 r\R " S5 r\R& " SS5 r\R " S5 r\R, " SS5 r\R, " SS5 r\R " S5 r\R, " SS5 r\R, " S S5 r\R " S5 r \R " S 5 r \R, " S S 5 r \R " S 5 r \R " S 5 r \R " S!5 r!\R& " SS"5 r"\R, " S#S$5 r#\RH " S%5 r%\RH " S&5 r&\R, " S'S(5 r'\R, " S)S*S+S,9r(\R " S-5 r)\R, " S.S/S+S,9r*\R " S05 r+\R " S1S+S,9r,\R, " S
S25 r-\R& " SS35 r.S4r/g5)6r i aP Defines a job to be run by the Cloud Dataflow service. Do not enter
confidential information when you supply string values using the API.
Enums:
CurrentStateValueValuesEnum: 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.
RequestedStateValueValuesEnum: 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.
TypeValueValuesEnum: Optional. The type of Dataflow job.
Messages:
LabelsValue: 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.
TransformNameMappingValue: Optional. The map of transform name prefixes of
the job to be replaced to the corresponding name prefixes of the new
job.
Fields:
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.
createTime: The timestamp when the job was initially created. Immutable
and set by the Cloud Dataflow service.
createdFromSnapshotId: If this is specified, the job's initial state is
populated from the given snapshot.
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.
currentStateTime: The timestamp associated with the current state.
environment: Optional. The environment for the job.
executionInfo: Deprecated.
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.
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.
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.
location: Optional. The [regional endpoint]
(https://cloud.google.com/dataflow/docs/concepts/regional-endpoints)
that contains this job.
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])?`
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.
projectId: The ID of the Google Cloud project that the job belongs to.
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.
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.
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.
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.
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.
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.
serviceResources: Output only. Resources used by the Dataflow Service to
run the job.
stageStates: This field may be mutated by the Cloud Dataflow service;
callers cannot mutate it.
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.
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.
stepsLocation: The Cloud Storage location where the steps are stored.
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}
transformNameMapping: Optional. The map of transform name prefixes of the
job to be replaced to the corresponding name prefixes of the new job.
type: Optional. The type of Dataflow job.
c T \ rS rSrSrSrSrSrSrSr Sr
S r S
r S r
S rS
rSrSrSrSrSrg) Job.CurrentStateValueValuesEnumiM aU 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.
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.
JOB_STATE_PAUSING: `JOB_STATE_PAUSING` is not implemented yet.
JOB_STATE_PAUSED: `JOB_STATE_PAUSED` is not implemented yet.
r r r r r' rD rE r r r r r r r r r Nr r r! r" CurrentStateValueValuesEnumr M sc ;x N %'"r! r c T \ rS rSrSrSrSrSrSrSr Sr
S r S
r S r
S rS
rSrSrSrSrSrg)!Job.RequestedStateValueValuesEnumi a 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.
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.
JOB_STATE_PAUSING: `JOB_STATE_PAUSING` is not implemented yet.
JOB_STATE_PAUSED: `JOB_STATE_PAUSED` is not implemented yet.
r r r r r' rD rE r r r r r r r r r Nr r r! r" RequestedStateValueValuesEnumr sc <z N %'"r! r c $ \ rS rSrSrSrSrSrSrg)Job.TypeValueValuesEnumi ap Optional. The type of Dataflow job.
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.
r r r r N) r r r r r JOB_TYPE_UNKNOWNr r r r r! r" TypeValueValuesEnumr s Nr! r rz c f \ rS rSrSr " S S\R 5 r\R " SSSS9r Sr
g )
Job.LabelsValuei a
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.
Messages:
AdditionalProperty: An additional property for a LabelsValue object.
Fields:
additionalProperties: Additional properties of type LabelsValue
c ` \ rS rSrSr\R " S5 r\R " S5 rSr g)"Job.LabelsValue.AdditionalPropertyi An additional property for a LabelsValue object.
Fields:
key: Name of the additional property.
value: A string attribute.
r r r Nr r r! r" r r r! r! r r Trs r Nr r r! r" LabelsValuer 2 'Y . . ' %112FTXYr! r c f \ rS rSrSr " S S\R 5 r\R " SSSS9r Sr
g )
Job.TransformNameMappingValuei a; Optional. The map of transform name prefixes of the job to be replaced
to the corresponding name prefixes of the new job.
Messages:
AdditionalProperty: An additional property for a
TransformNameMappingValue object.
Fields:
additionalProperties: Additional properties of type
TransformNameMappingValue
c ` \ rS rSrSr\R " S5 r\R " S5 rSr g)0Job.TransformNameMappingValue.AdditionalPropertyi! An additional property for a TransformNameMappingValue object.
Fields:
key: Name of the additional property.
value: A string attribute.
r r r Nr r r! r" r r ! r! r! r r Trs r Nr r r! r" TransformNameMappingValuer rR r! r r r r r' rD r rE JobExecutionInfor r JobMetadatar r r r PipelineDescriptionr r r r r
RuntimeUpdatableParamsr r r ServiceResourcesrd r re Trs rf Steprg rh ri r N)0r r r r r r rF r r r r r r r r r clientRequestIdr createdFromSnapshotIdrJ currentStater* r r%
executionInfor? jobMetadatalabelsr( r pipelineDescriptionrg r replacedByJobIdrequestedStateruntimeUpdatableParamsr satisfiesPzi satisfiesPzsserviceResources stageStatesr steps
stepsLocation tempFilestransformNameMappingtyper r r! r" r r s zxKINN KZLinn L\ INN !!"89ZI%% Z :Z8 !!"89Z)"3"3 Z :Z4 ))!,/$$Q'*#//2$$%BAF, **1-&&}a8+(();Q?- Q "&&}a8+ ! !- 4&
"
"2
&( r "$!../DbI##B')&&r*, ))"-/ &&'FK.$112JBO''+,''+, ++,>C&&'DQ/ **+>DQ/ ++,@!dS&&DI+(():AM-%%lA6* ))*1t D'r! r c \ rS rSrSr\R " S5 r\R " S5 r\R " S5 r Sr
g)KeyRangeDataDiskAssignmenti a 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.
Fields:
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".
end: The end (exclusive) of the key range.
start: The start (inclusive) of the key range.
r r r r N) r r r r r r r dataDiskendstartr r r! r" r! r! s9
"
"1
%( a #
"%r! r! c \ rS rSrSr\R " S5 r\R " S5 r\R " S5 r \R " S5 r
\R " S5 r Sr g )
r i& a. Location information for a specific key-range of a sharded computation.
Currently we only support UTF-8 character splits to simplify encoding into
JSON.
Fields:
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".
deliveryEndpoint: The physical location of this range assignment to be
used for streaming computation cross-worker message delivery.
deprecatedPersistentDirectory: DEPRECATED. The location of the persistent
state for this range, as a persistent directory in the worker local
filesystem.
end: The end (exclusive) of the key range.
start: The start (inclusive) of the key range.
r r r r' rD r N)
r r r r r r r r" deliveryEndpoint deprecatedPersistentDirectoryr# r$ r r r! r" r r & s[ $
"
"1
%( **1-"+"7"7": a #
"%r! r c > \ rS rSrSr\R " S5 " S S\R 5 5 r \R " S5 " S S\R 5 5 r
\R " S5 " S S \R 5 5 r \R " S
S 5 r
\R " S 5 r\R " S
S5 r\R " S5 r\R " SS5 r\R " SS5 r\R " S S5 r\R* " S5 rSrg)LaunchFlexTemplateParameteri@ am Launch FlexTemplate Parameter.
Messages:
LaunchOptionsValue: 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.
ParametersValue: The parameters for FlexTemplate. Ex. {"num_workers":"5"}
TransformNameMappingsValue: Use this to pass transform_name_mappings for
streaming update jobs. Ex:{"oldTransformName":"newTransformName",...}'
Fields:
containerSpec: Spec about the container image to launch.
containerSpecGcsPath: Cloud Storage path to a file with json serialized
ContainerSpec as content.
environment: The runtime environment for the FlexTemplate job
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.
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.
parameters: The parameters for FlexTemplate. Ex. {"num_workers":"5"}
transformNameMappings: Use this to pass transform_name_mappings for
streaming update jobs. Ex:{"oldTransformName":"newTransformName",...}'
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.
rz c f \ rS rSrSr " S S\R 5 r\R " SSSS9r Sr
g )
.LaunchFlexTemplateParameter.LaunchOptionsValuei] rX c ` \ rS rSrSr\R " S5 r\R " S5 rSr g)ALaunchFlexTemplateParameter.LaunchOptionsValue.AdditionalPropertyik r[ r r r Nr r r! r" r r- k r! r! r r Trs r Nr r r! r" r\ r+ ] rR r! r\ c f \ rS rSrSr " S S\R 5 r\R " SSSS9r Sr
g )
+LaunchFlexTemplateParameter.ParametersValueix r_ c ` \ rS rSrSr\R " S5 r\R " S5 rSr g)>LaunchFlexTemplateParameter.ParametersValue.AdditionalPropertyi r r r r Nr r r! r" r r1 r! r! r r Trs r Nr r r! r" r" r/ x r# r! r" c f \ rS rSrSr " S S\R 5 r\R " SSSS9r Sr
g )
6LaunchFlexTemplateParameter.TransformNameMappingsValuei rd c ` \ rS rSrSr\R " S5 r\R " S5 rSr g)ILaunchFlexTemplateParameter.TransformNameMappingsValue.AdditionalPropertyi rP r r r Nr r r! r" r r5 r! r! r r Trs r Nr r r! r" rQ r3 rR r! rQ r2 r r r r r' rD rE r r r N)r r r r r r r r r r\ r" rQ r r4 r rg r% r' rh r) rS r updater r r! r" r) r) @ s) 8 !!"89Z9,, Z :Z4 !!"89Z )) Z :Z. !!"89Z9#4#4 Z :Z4 (( !<-"..q1&&'GK+ ! !! $'(()=qA-%%&7;*#001MqQ ! !! $&r! r) c b \ rS rSrSr\R " SS5 r\R " S5 r Sr
g)r
i zA request to launch a Cloud Dataflow job from a FlexTemplate.
Fields:
launchParameter: Required. Parameter to launch a job form Flex Template.
validateOnly: If true, the request is validated but not actually executed.
Defaults to false.
r) r r r N) r r r r r r r launchParameterr r r r r! r" r
r
s, **+H!L/''*,r! r
c > \ rS rSrSr\R " SS5 rSrg)LaunchFlexTemplateResponsei zResponse to the request to launch a job from Flex Template.
Fields:
job: The job that was launched, if the request was not a dry run and the
job was successfully launched.
r r r N r r r r r r r r r r r! r" r: r: ua(#r! r: c z \ rS rSrSr\R " S5 " S S\R 5 5 r \R " S5 " S S\R 5 5 r
\R " SS 5 r \R " S
5 r\R " SS 5 r\R " SS 5 r\R" " S
5 rSrg)rM i a( 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.
Messages:
ParametersValue: The runtime parameters to pass to the job.
TransformNameMappingValue: 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.
Fields:
environment: The runtime environment for the job.
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])?`
parameters: The runtime parameters to pass to the job.
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.
update: If set, replace the existing pipeline with the name specified by
jobName with this pipeline, preserving state.
rz c f \ rS rSrSr " S S\R 5 r\R " SSSS9r Sr
g )
(LaunchTemplateParameters.ParametersValuei r c ` \ rS rSrSr\R " S5 r\R " S5 rSr g);LaunchTemplateParameters.ParametersValue.AdditionalPropertyi r r r r Nr r r! r" r rA r! r! r r Trs r Nr r r! r" r" r? r# r! r" c f \ rS rSrSr " S S\R 5 r\R " SSSS9r Sr
g )
2LaunchTemplateParameters.TransformNameMappingValuei aW 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.
Messages:
AdditionalProperty: An additional property for a
TransformNameMappingValue object.
Fields:
additionalProperties: Additional properties of type
TransformNameMappingValue
c ` \ rS rSrSr\R " S5 r\R " S5 rSr g)ELaunchTemplateParameters.TransformNameMappingValue.AdditionalPropertyi r r r r Nr r r! r" r rE r! r! r r Trs r Nr r r! r" r rC 2 'Y . . ' %112FTXYr! r r$ r r r r' rD r N)r r r r r r r r r r" r r r% r r' r) r r r6 r r r! r" rM rM s . !!"89Z )) Z :Z. !!"89Z)"3"3 Z :Z6 &&';Q?+ ! !! $'%%&7;*"//0KQO ! !! $&r! rM c > \ rS rSrSr\R " SS5 rSrg)LaunchTemplateResponsei zResponse to the request to launch a template.
Fields:
job: The job that was launched, if the request was not a dry run and the
job was successfully launched.
r r r Nr; r r! r" rH rH r< r! rH c \ rS rSrSr\R " S5 " S S\R 5 5 r \R " S5 r \R " S5 r \R " S5 r\R " S 5 r\R " SS
5 r\R " S S S
9r\R " SS S
9r\R " S5 rSrg)r i+ aI Request to lease WorkItems.
Messages:
UnifiedWorkerRequestValue: Untranslated bag-of-bytes WorkRequest from
UnifiedWorker.
Fields:
currentWorkerTime: The current timestamp at the worker.
location: The [regional endpoint]
(https://cloud.google.com/dataflow/docs/concepts/regional-endpoints)
that contains the WorkItem's job.
projectNumber: Optional. The project number of the project this worker
belongs to.
requestedLeaseDuration: The initial lease period.
unifiedWorkerRequest: Untranslated bag-of-bytes WorkRequest from
UnifiedWorker.
workItemTypes: Filter for WorkItem type.
workerCapabilities: Worker capabilities. WorkItems might be limited to
workers with specific capabilities.
workerId: Identifies the worker leasing work -- typically the ID of the
virtual machine running the worker.
rz c f \ rS rSrSr " S S\R 5 r\R " SSSS9r Sr
g )
.LeaseWorkItemRequest.UnifiedWorkerRequestValueiC a Untranslated bag-of-bytes WorkRequest from UnifiedWorker.
Messages:
AdditionalProperty: An additional property for a
UnifiedWorkerRequestValue object.
Fields:
additionalProperties: Properties of the object. Contains field @type
with type URL.
c b \ rS rSrSr\R " S5 r\R " SS5 r Sr
g)ALeaseWorkItemRequest.UnifiedWorkerRequestValue.AdditionalPropertyiP An additional property for a UnifiedWorkerRequestValue object.
Fields:
key: Name of the additional property.
value: A extra_types.JsonValue attribute.
r r r r Nr r r! r" r rM P r r! r r Trs r Nr r r! r" UnifiedWorkerRequestValuerK C r r! rO r r r r' rD rE Trs r r r N)r r r r r r r r r rO r currentWorkerTimer( rG
projectNumberrequestedLeaseDurationr unifiedWorkerRequest
workItemTypesworkerCapabilitiesr r r r! r" r r + s . !!"89Z)"3"3 Z :Z2 ++A.
"
"1
%(((+-$003"//0KQO''D9- ,,Q>
"
"1
%(r! r c \ rS rSrSr\R " S5 " S S\R 5 5 r \R " SS5 r \R " SSS S
9r S r
g )
LeaseWorkItemResponseig a Response to a request to lease WorkItems.
Messages:
UnifiedWorkerResponseValue: Untranslated bag-of-bytes WorkResponse for
UnifiedWorker.
Fields:
unifiedWorkerResponse: Untranslated bag-of-bytes WorkResponse for
UnifiedWorker.
workItems: A list of the leased WorkItems.
rz c f \ rS rSrSr " S S\R 5 r\R " SSSS9r Sr
g )
0LeaseWorkItemResponse.UnifiedWorkerResponseValueit a Untranslated bag-of-bytes WorkResponse for UnifiedWorker.
Messages:
AdditionalProperty: An additional property for a
UnifiedWorkerResponseValue object.
Fields:
additionalProperties: Properties of the object. Contains field @type
with type URL.
c b \ rS rSrSr\R " S5 r\R " SS5 r Sr
g)CLeaseWorkItemResponse.UnifiedWorkerResponseValue.AdditionalPropertyi An additional property for a UnifiedWorkerResponseValue object.
Fields:
key: Name of the additional property.
value: A extra_types.JsonValue attribute.
r r r r Nr r r! r" r r[ r r! r r Trs r Nr r r! r" UnifiedWorkerResponseValuerY t r r! r] r WorkItemr Trs r N)r r r r r r r r r r] r unifiedWorkerResponse workItemsr r r! r" rW rW g sa
!!"89Z9#4#4 Z :Z2 $001MqQ$$ZTB)r! rW c \ rS rSrSr\R " S\R R S9r \R " S5 r \R " S5 r Sr
g) r i a# 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)
Fields:
numberOfBuckets: Must be greater than 0.
start: Lower bound of the first bucket.
width: Distance between bucket boundaries. Must be greater than 0.
r r r r r N)r r r r r r rG r r\ ra r r$ widthr r r! r" r r sG **1i6G6G6M6MN/
q
!%
q
!%r! r c ` \ rS rSrSr\R " SSSS9r\R " S5 r Sr
g )
ListDeploymentRevisionsResponsei ai Response of a request to list `Cloud Dataflow job deployment revisions`.
Fields:
deployments: The deployments from the specified publisher.
nextPageToken: A token, which can be sent as `page_token` to retrieve the
next page. If this field is omitted, there are no subsequent pages. Use
`next_token.SerializeAsString` + `absl::WebSafeBase64Escape`.
r r Trs r r N r r r r r r r deploymentsr r r r r! r" rd rd s- &&|QF+''*-r! rd c ` \ rS rSrSr\R " SSSS9r\R " S5 r Sr
g )
ListDeploymentsResponsei am Response of a request to list `Cloud Dataflow job deployments` in a
project.
Fields:
deployments: The deployments from the specified publisher.
nextPageToken: A token, which can be sent as `page_token` to retrieve the
next page. If this field is omitted, there are no subsequent pages. Use
`next_token.SerializeAsString` + `absl::WebSafeBase64Escape`.
r r Trs r r Nre r r! r" rh rh s- &&|QF+''*-r! rh c \ rS rSrSr\R " SSSS9r\R " SSSS9r\R " S 5 r
S
r g ) ListJobMessagesResponsei a Response to a request to list job messages.
Fields:
autoscalingEvents: Autoscaling events in ascending timestamp order.
jobMessages: Messages in ascending timestamp order.
nextPageToken: The token to obtain the next page of results if there are
more.
r8 r Trs r r r r N) r r r r r r r autoscalingEvents jobMessagesr r r r r! r" rj rj sC ,,-?TR&&|QF+''*-r! rj c \ rS rSrSr\R " SSSS9r\R " SSSS9r\R " S 5 r
S
r g ) ListJobsResponsei a] 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 {}.
Fields:
failedLocation: Zero or more messages describing the [regional endpoints]
(https://cloud.google.com/dataflow/docs/concepts/regional-endpoints)
that failed to respond.
jobs: A subset of the requested job information.
nextPageToken: Set if there may be more results than fit in this response.
rD r Trs r r r r N) r r r r r r r failedLocationjobsr r r r r! r" rn rn sB ))*:AM. q4 8$''*-r! rn c < \ rS rSrSr\R " SSSS9rSrg) ListSnapshotsResponsei z=List of snapshots.
Fields:
snapshots: Returned snapshots.
Snapshotr Trs r N) r r r r r r r snapshotsr r r! r" rr rr s $$ZTB)r! rr c ` \ rS rSrSr\R " S5 r\R " SSSS9r Sr
g )
ListTemplateVersionsResponsei zRespond a list of TemplateVersions.
Fields:
nextPageToken: A token that can be sent as `page_token` to retrieve the
next page. If this field is omitted, there are no subsequent pages.
templateVersions: A list of TemplateVersions.
r r r Trs r N) r r r r r r r r r templateVersionsr r r! r" rv rv s/ ''*- ++,=q4Pr! rv c \ rS rSrSr\R " S5 r\R " SSSS9r \R " S5 r
\R " S 5 r S
r g ) MapTaski as 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.
Fields:
counterPrefix: Counter prefix that can be used to prefix counters. Not
currently used in Dataflow.
instructions: The instructions in the MapTask.
stageName: System-defined name of the stage containing this MapTask.
Unique across the workflow.
systemName: System-defined name of this MapTask. Unique across the
workflow.
r ParallelInstructionr Trs r r' r N)
r r r r r r r
counterPrefixr instructions stageNamer r r r! r" ry ry sN
''*-''(=q4P,##A&)$$Q'*r! ry c > \ rS rSrSr\R " S\R R S9r \R " S5 r
\R " S\R R S9r \R " S5 r
\R " S\R R S9rS rg
) MemInfoi a Information about the memory usage of a worker or a container within a
worker.
Fields:
currentLimitBytes: Instantenous memory limit in bytes.
currentOoms: Number of Out of Memory (OOM) events recorded since the
previous measurement.
currentRssBytes: Instantenous memory (RSS) size in bytes.
timestamp: Timestamp of the measurement.
totalGbMs: Total memory (RSS) usage since start up in GB * ms.
r r r r r' rD r N)r r r r r r rG r r currentLimitBytes currentOomscurrentRssBytesr r totalGbMsr r r! r" r r s
,,Q 8I8I8P8PQ&&q)+ **1i6G6G6N6NO/##A&)$$Q 0A0A0H0HI)r! r c \ rS rSrSr\R " S\R R S9r \R " S5 r
Sr g)
MetricShortIdi" a The metric short id is returned to the user alongside an offset into
ReportWorkItemStatusRequest
Fields:
metricIndex: The index of the corresponding metric in the
ReportWorkItemStatusRequest. Required.
shortId: The service-generated short identifier for the metric.
r r r r N) r r r r r r rG r r\ metricIndexr r r r! r" r r " s7 &&q)2C2C2I2IJ+ " "1 %'r! r c \ rS rSrSr\R " S5 " S S\R 5 5 r \R " SS5 r \R " S5 r
\R " S5 rS rg
) MetricStructuredNamei0 a Identifies a metric, by describing the source which generated the
metric.
Messages:
ContextValue: 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'] = .
Fields:
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'] = .
name: Worker-defined metric name.
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.
rz c f \ rS rSrSr " S S\R 5 r\R " SSSS9r Sr
g )
!MetricStructuredName.ContextValueiG a 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'] = .
Messages:
AdditionalProperty: An additional property for a ContextValue object.
Fields:
additionalProperties: Additional properties of type ContextValue
c ` \ rS rSrSr\R " S5 r\R " S5 rSr g)4MetricStructuredName.ContextValue.AdditionalPropertyiV zAn additional property for a ContextValue object.
Fields:
key: Name of the additional property.
value: A string attribute.
r r r Nr r r! r" r r V r! r! r r Trs r Nr r r! r" ContextValuer G rF r! r r r r r N)r r r r r r r r r r r contextr r r r r r! r" r r 0 sk , !!"89ZY&& Z :Z6
" ">1 5' q !$ #&r! r c \ rS rSrSr\R " SS5 r\R " S5 r \R " SS5 r
\R " SS5 r \R " SS5 r \R " S 5 r\R " SS
5 r\R " SS 5 r\R " S S
5 r\R " SS5 r\R " SS5 r\R " SS5 r\R " S5 rSrg)r ih a Describes the state of a metric.
Fields:
boundedTrie: Worker-computed aggregate value for the "Trie" aggregation
kind. The only possible value type is a BoundedTrieNode. Introduced this
field to avoid breaking older SDKs when Dataflow service starts to
populate the `bounded_trie` field.
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.
distribution: A struct value describing properties of a distribution of
numeric values.
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.
internal: Worker-computed aggregate value for internal use by the Dataflow
service.
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.
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.
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.
name: Name of the metric.
scalar: Worker-computed aggregate value for aggregation kinds "Sum",
"Max", "Min", "And", and "Or". The possible value types are Long,
Double, and Boolean.
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, String, or BoundedTrie according to the metric's type. All
Values in the list must be of the same type.
trie: Worker-computed aggregate value for the "Trie" aggregation kind. The
only possible value type is a BoundedTrieNode.
updateTime: Timestamp associated with the metric value. Optional when
workers are reporting work progress; it will be filled in responses from
the metrics API.
r r r r r' rD rE r r r r r r r r r N)r r r r r r r r r r
r gauger r r meanCountmeanSumr scalarsettrier r r r! r" r r h s +Z &&'>B+%%a(*''(?C,
!8!
<%
#
#$;Q
?( q !$$$%' 6 :$ ! !"92 >& 6;# 7 <$$$R(*r! r c & \ rS rSrSr\R " S5 " S S\R 5 5 r \R " S5 r \R " SS5 r
\R " SS 5 r\R " S
S 5 r\R " S 5 rS
rg) MetricValuei a The value of a metric along with its name and labels.
Messages:
MetricLabelsValue: Optional. Set of metric labels for this metric.
Fields:
metric: Base name for this metric.
metricLabels: Optional. Set of metric labels for this metric.
valueGauge64: Non-cumulative int64 value of this metric.
valueHistogram: Histogram value of this metric.
valueInt64: Integer value of this metric.
rz c f \ rS rSrSr " S S\R 5 r\R " SSSS9r Sr
g )
MetricValue.MetricLabelsValuei zOptional. Set of metric labels for this metric.
Messages:
AdditionalProperty: An additional property for a MetricLabelsValue
object.
Fields:
additionalProperties: Additional properties of type MetricLabelsValue
c ` \ rS rSrSr\R " S5 r\R " S5 rSr g)0MetricValue.MetricLabelsValue.AdditionalPropertyi zAn additional property for a MetricLabelsValue object.
Fields:
key: Name of the additional property.
value: A string attribute.
r r r Nr r r! r" r r r! r! r r Trs r Nr r r! r" MetricLabelsValuer 2 'Y . . ' %112FTXYr! r r r rj r rm r' rD r N)r r r r r r r r r r r metricr metricLabels valueGauge64valueHistogramrG
valueInt64r r r! r" r r s !!"89Z)++ Z :Z0 #&''(;Q?,''( >@ !!"89ZI - - Z :Z0 ))*?C.&&q),&&'DaRVW+##A&)
"
"1
%(
#
#A
&(%%a(*
"% q !$!!"
''
q4H, **1-&&q),r! r- c < \ rS rSrSr\R " SSSS9rSrg) PerWorkerMetricsic z{Per worker metrics.
Fields:
perStepNamespaceMetrics: Optional. Metrics for a particular unfused step
and namespace.
r- r Trs r N) r r r r r r r perStepNamespaceMetricsr r r! r" r2 r2 c s & 2 23LaZ^ _r! r2 c \ rS rSrSr\R " SSSS9r\R " SSSS9r\R " S S
SS9r \R " S 5 r S r g
)r in a) 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.
Fields:
displayData: Pipeline level display data.
executionPipelineStage: Description of each stage of execution of the
pipeline.
originalPipelineTransform: Description of each transform in the pipeline
and collections between them.
stepNamesHash: A hash value of the submitted pipeline portable graph step
names if exists.
r r Trs r. r TransformSummaryr r' r N)
r r r r r r r displayDataexecutionPipelineStageoriginalPipelineTransformr
stepNamesHashr r r! r" r r n s[ &&}a$G+$112I1W[\ ' 4 45GUY Z''*-r! r c ` \ rS rSrSr\R " S5 r\R " S5 r Sr
g)Pointi ziA point in the timeseries.
Fields:
time: The timestamp of the point.
value: The value of the point.
r r r N) r r r r r r r rM r r r r r! r" r; r; s)
q !$
q
!%r! r; c \ rS rSrSr\R " S5 r\R " SS5 r \R " S5 r \R " S5 r
\R " S5 r\R " S 5 rS
rg ) r i aI 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.
Fields:
byteOffset: Position is a byte offset.
concatPosition: CloudPosition is a concat position.
end: Position is past all other positions. Also useful for the end
position of an unbounded range.
key: Position is a string key, ordered lexicographically.
recordIndex: Position is a record index.
shufflePosition: CloudPosition is a base64 encoded BatchShufflePosition
(with FIXED sharding).
r r r r r' rD rE r N)r r r r r r rG
byteOffsetr concatPositionr r# r r recordIndexshufflePositionr r r! r" r r sl
%%a(* ))*:A>. q!# a #&&q)+ ))!,/r! r c ` \ rS rSrSr\R " S5 r\R " SSSS9r Sr
g )
ProgressTimeseriesi zInformation about the progress of some component of job execution.
Fields:
currentProgress: The current progress of the component, in the range
[0,1].
dataPoints: History of progress for the component. Points are sorted by
time.
r r; r Trs r N) r r r r r r r currentProgressr
dataPointsr r r! r" rB rB s- ((+/%%gq4@*r! rB c ` \ rS rSrSr\R " S5 r\R " S5 rSr g)r i zMetadata for a Pub/Sub connector used by the job.
Fields:
subscription: Subscription used in the connection.
topic: Topic accessed in the connection.
r r r N)
r r r r r r r subscriptiontopicr r r! r" r r s) &&q),
"%r! r c 8 \ rS rSrSr\R " S5 r\R " S5 r\R " S5 r
\R " S5 r \R " S5 r \R " S5 r
\R " S 5 r\R " S
5 rS rg )
PubsubLocationi a Identifies a pubsub location to use for transferring data into or out of
a streaming Dataflow job.
Fields:
dropLateData: Indicates whether the pipeline allows late-arriving data.
dynamicDestinations: If true, then this location represents dynamic
topics.
idLabel: If set, contains a pubsub label from which to extract record ids.
If left empty, record deduplication will be strictly best effort.
subscription: A pubsub subscription, in the form of
"pubsub.googleapis.com/subscriptions//"
timestampLabel: If set, contains a pubsub label from which to extract
record timestamps. If left empty, record timestamps will be generated
upon arrival.
topic: A pubsub topic, in the form of "pubsub.googleapis.com/topics//"
trackingSubscription: If set, specifies the pubsub subscription that will
be used for tracking custom time timestamps for watermark estimation.
withAttributes: If true, then the client has requested to get pubsub
attributes.
r r r r' rD rE r r r N)r r r r r r r dropLateDatadynamicDestinationsr idLabelrF timestampLabelrG trackingSubscriptionwithAttributesr r r! r" rI rI s * ''*,!..q1 ! !! $'&&q), ((+.
"%"..q1 ))!,.r! rI c \ rS rSrSr\R " S5 r\R " S5 r\R " S5 r Sr
g)PubsubSnapshotMetadatai zRepresents a Pubsub snapshot.
Fields:
expireTime: The expire time of the Pubsub snapshot.
snapshotName: The name of the Pubsub snapshot.
topicName: The name of the Pubsub topic.
r r r r N) r r r r r r r
expireTime snapshotName topicNamer r r! r" rQ rQ s9 $$Q'*&&q),##A&)r! rQ c > \ rS rSrSr\R " SS5 rSrg)r i zuAn instruction that reads records. Takes no inputs, produces one output.
Fields:
source: The source to read from.
r r r N r r r r r r r r r r r! r" r r ! !(A .&r! r c F \ rS rSrSr\R " S5 " S S\R 5 5 r \R " S5 r \R " S5 r \R " S5 r\R " SS 5 r\R " S
S S S
9r\R " S5 rSrg)r i a Request to report the status of WorkItems.
Messages:
UnifiedWorkerRequestValue: Untranslated bag-of-bytes
WorkProgressUpdateRequest from UnifiedWorker.
Fields:
currentWorkerTime: The current timestamp at the worker.
location: The [regional endpoint]
(https://cloud.google.com/dataflow/docs/concepts/regional-endpoints)
that contains the WorkItem's job.
projectNumber: Optional. The project number of the project which owns the
WorkItem's job.
unifiedWorkerRequest: Untranslated bag-of-bytes WorkProgressUpdateRequest
from UnifiedWorker.
workItemStatuses: The order is unimportant, except that the order of the
WorkItemServiceState messages in the ReportWorkItemStatusResponse
corresponds to the order of WorkItemStatus messages here.
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).
rz c f \ rS rSrSr " S S\R 5 r\R " SSSS9r Sr
g )
5ReportWorkItemStatusRequest.UnifiedWorkerRequestValuei a Untranslated bag-of-bytes WorkProgressUpdateRequest from
UnifiedWorker.
Messages:
AdditionalProperty: An additional property for a
UnifiedWorkerRequestValue object.
Fields:
additionalProperties: Properties of the object. Contains field @type
with type URL.
c b \ rS rSrSr\R " S5 r\R " SS5 r Sr
g)HReportWorkItemStatusRequest.UnifiedWorkerRequestValue.AdditionalPropertyi rN r r r r Nr r r! r" r r\ r r! r r Trs r Nr r r! r" rO rZ 4
AY . . A %112FTXYr! rO r r r r' WorkItemStatusrD Trs rE r N)r r r r r r r r r rO r rP r( rG rQ r rS workItemStatusesr r r r! r" r r s 0 !!"89Z)"3"3 Z :Z4 ++A.
"
"1
%(((+-"//0KQO ++,( ! !! $'r! r c ` \ rS rSrSr\R " S5 r\R " SSSS9r Sr
g )
r i zA structured representation of an SDK.
Fields:
sdkId: The SDK harness id.
stacks: The stacktraces for the processes running on the SDK harness.
r Stackr Trs r N) r r r r r r r sdkIdr stacksr r r! r" r r s-
"% ! !'1t <&r! r c \ rS rSrSr " S S\R 5 r " S S\R 5 r\R " SS5 r
\R " SS5 r \R " S 5 r
S
rg ) SdkBugi ag A bug found in the Dataflow SDK.
Enums:
SeverityValueValuesEnum: Output only. How severe the SDK bug is.
TypeValueValuesEnum: Output only. Describes the impact of this SDK bug.
Fields:
severity: Output only. How severe the SDK bug is.
type: Output only. Describes the impact of this SDK bug.
uri: Output only. Link to more information on the bug.
c ( \ rS rSrSrSrSrSrSrSr g) SdkBug.SeverityValueValuesEnumi a Output only. How severe the SDK bug is.
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.
r r r r r N)
r r r r r SEVERITY_UNSPECIFIEDNOTICEWARNINGSEVEREr r r! r" SeverityValueValuesEnumr s
FG
Fr! r c ( \ rS rSrSrSrSrSrSrSr g) SdkBug.TypeValueValuesEnumi aK Output only. Describes the impact of this SDK bug.
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.
r r r r r N)
r r r r r TYPE_UNSPECIFIEDGENERAL PERFORMANCEDATALOSSr r r! r" r r s GKHr! r r r r r N)r r r r r r rF r r rJ severityr r urir r r! r" r r s_
$
INN
!:A
>( 2A 6$ a #r! r c \ rS rSrSr\R " SSS9r\R " S5 r\R " S5 r \R " S5 r S r g
) SdkHarnessContainerImagei az Defines an SDK harness container for executing Dataflow pipelines.
Fields:
capabilities: The set of capabilities enumerated in the above Environment
proto. See also [beam_runner_api.proto](https://github.com/apache/beam/b
lob/master/model/pipeline/src/main/proto/org/apache/beam/model/pipeline/
v1/beam_runner_api.proto)
containerImage: A docker container image that resides in Google Container
Registry.
environmentId: Environment ID for the Beam runner API proto Environment
that corresponds to the current SDK Harness.
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.
r Trs r r r' r N)
r r r r r r r capabilitiescontainerImage
environmentIdr useSingleCorePerContainerr r r! r" r r sL $ &&q48, ((+.''*- ' 4 4Q 7r! r c \ rS rSrSr " S S\R 5 r\R " SSSS9r \R " SS 5 r \R " S
5 r
\R " S 5 rS rg
)r i a The version of the SDK used to run the job.
Enums:
SdkSupportStatusValueValuesEnum: The support status for this SDK version.
Fields:
bugs: Output only. Known bugs found in this SDK version.
sdkSupportStatus: The support status for this SDK version.
version: The version of the SDK used to run the job.
versionDisplayName: A readable string describing the version of the SDK.
c , \ rS rSrSrSrSrSrSrSr Sr
g )
*SdkVersion.SdkSupportStatusValueValuesEnumi a The support status for this SDK version.
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.
r r r r r' r N) r r r r r r SUPPORTEDSTALE
DEPRECATED UNSUPPORTEDr r r! r" SdkSupportStatusValueValuesEnumr s" GI
EJKr! r r r Trs r r r' r N)r r r r r r rF r r bugsrJ sdkSupportStatusr r versionDisplayNamer r r! r" r r sb
&
!d ;$ (()JAN ! !! $' ,,Q/r! r c \ rS rSrSr " S S\R 5 r\R " S5 r \R " S5 r
\R " SS5 r \R " S5 r
\R " S 5 rS
rg ) r i+ a Request to send encoded debug information. Next ID: 8
Enums:
DataFormatValueValuesEnum: Format for the data field above (id=5).
Fields:
componentId: The internal component id for which debug information is
sent.
data: The encoded debug information.
dataFormat: Format for the data field above (id=5).
location: The [regional endpoint]
(https://cloud.google.com/dataflow/docs/concepts/regional-endpoints)
that contains the job specified by job_id.
workerId: The worker id, i.e., VM hostname.
c , \ rS rSrSrSrSrSrSrSr Sr
g )
1SendDebugCaptureRequest.DataFormatValueValuesEnumi< a Format for the data field above (id=5).
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.
r r r r r' r N) r r r r r DATA_FORMAT_UNSPECIFIEDRAWJSONZLIBBROTLIr r r! r" DataFormatValueValuesEnumr < s#
C D D
Fr! r r r r r' rD r N)r r r r r r rF r r r datarJ
dataFormatr( r r r r! r" r r + sl ).. $ %%a(+ q !$""#>B*
"
"1
%(
"
"1
%(r! r c \ rS rSrSrSrg)SendDebugCaptureResponseiU z+Response to a send capture request. nothingr Nro r r! r" r r U s 4r! r c ` \ rS rSrSr\R " S5 r\R " SSSS9r Sr
g )
rT iY zA request for sending worker messages to the service.
Fields:
location: The [regional endpoint]
(https://cloud.google.com/dataflow/docs/concepts/regional-endpoints)
that contains the job.
workerMessages: The WorkerMessages to send.
r
WorkerMessager Trs r N) r r r r r r r r( r workerMessagesr r r! r" rT rT Y s-
"
"1
%( ))/1tL.r! rT c < \ rS rSrSr\R " SSSS9rSrg) SendWorkerMessagesResponseig zuThe response to the worker messages.
Fields:
workerMessageResponses: The servers response to the worker messages.
WorkerMessageResponser Trs r N) r r r r r r r workerMessageResponsesr r r! r" r r g s %112I1W[\r! r c F \ rS rSrSr\R " S5 " S S\R 5 5 r \R " SSSS 9r \R " S
5 r
\R " S S SS 9r\R " S
5 r\R " S5 r\R " SS5 rSrg)
SeqMapTaskiq a Describes a particular function to invoke.
Messages:
UserFnValue: The user function to invoke.
Fields:
inputs: Information about each of the inputs.
name: The user-provided name of the SeqDo operation.
outputInfos: Information about each of the outputs.
stageName: System-defined name of the stage containing the SeqDo
operation. Unique across the workflow.
systemName: System-defined name of the SeqDo operation. Unique across the
workflow.
userFn: The user function to invoke.
rz c f \ rS rSrSr " S S\R 5 r\R " SSSS9r Sr
g )
SeqMapTask.UserFnValuei r c b \ rS rSrSr\R " S5 r\R " SS5 r Sr
g))SeqMapTask.UserFnValue.AdditionalPropertyi r r r r r Nr r r! r" r r r r! r r Trs r Nr r r! r" r r r r! r r r Trs r SeqMapTaskOutputInfor r' rD rE r N)r r r r r r r r r r r r r r outputInfosr} r r r r r! r" r r q s !!"89ZI%% Z :Z. ! !/1t D& q !$&&'=q4P+##A&)$$Q'* ! !- 3&r! r c b \ rS rSrSr\R " SS5 r\R " S5 r Sr
g)r i zInformation about an output of a SeqMapTask.
Fields:
sink: The sink to write the output value to.
tag: The id of the TupleTag the user code will tag the output value by.
Sinkr r r N) r r r r r r r sinkr r r r r! r" r r s+
*$ a #r! r c : \ rS rSrSr\R " SSS9rSrg)r i zResources used by the Dataflow Service to run the job.
Fields:
zones: Output only. List of Cloud Zones being used by the Dataflow Service
for this job. Example: us-central1-c
r Trs r N) r r r r r r r zonesr r r! r" r r s
D
1%r! r c \ rS rSrSr\R " S5 r\R " S\R R S9r Sr g) ShellTaski zA task which consists of a shell command for the worker to execute.
Fields:
command: The shell command to run.
exitCode: Exit code for the task.
r r r r N)
r r r r r r r commandrG r r\ exitCoder r r! r" r r s7
! !! $'
#
#Ay/@/@/F/F
G(r! r c \ rS rSrSr\R " S5 " S S\R 5 5 r \R " SS5 r \R " SSS S
9r \R " S 5 rS rg
)r i aa Information about a side input of a DoFn or an input of a SeqDoFn.
Messages:
KindValue: How to interpret the source element(s) as a side input value.
Fields:
kind: How to interpret the source element(s) as a side input value.
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.
tag: The id of the tag the user code will access this side input by; this
should correspond to the tag of some MultiOutputInfo.
rz c f \ rS rSrSr " S S\R 5 r\R " SSSS9r Sr
g )
SideInputInfo.KindValuei zHow to interpret the source element(s) as a side input value.
Messages:
AdditionalProperty: An additional property for a KindValue object.
Fields:
additionalProperties: Properties of the object.
c b \ rS rSrSr\R " S5 r\R " SS5 r Sr
g)*SideInputInfo.KindValue.AdditionalPropertyi zAn additional property for a KindValue object.
Fields:
key: Name of the additional property.
value: A extra_types.JsonValue attribute.
r r r r Nr r r! r" r r r r! r r Trs r Nr r r! r" KindValuer r r! r r r r Trs r r N)r r r r r r r r r r r r sourcesr r r r r! r" r r so
!!"89Z)## Z :Z.
Q /$ " "8Q >' a #r! r c \ rS rSrSr\R " S5 " S S\R 5 5 r \R " S5 " S S\R 5 5 r
\R " SS5 r \R " SS 5 r
S
rg ) r i a3 A sink that records can be encoded and written to.
Messages:
CodecValue: The codec to use to encode data written to the sink.
SpecValue: The sink to write to, plus its parameters.
Fields:
codec: The codec to use to encode data written to the sink.
spec: The sink to write to, plus its parameters.
rz c f \ rS rSrSr " S S\R 5 r\R " SSSS9r Sr
g )
Sink.CodecValuei zThe codec to use to encode data written to the sink.
Messages:
AdditionalProperty: An additional property for a CodecValue object.
Fields:
additionalProperties: Properties of the object.
c b \ rS rSrSr\R " S5 r\R " SS5 r Sr
g)"Sink.CodecValue.AdditionalPropertyi r r r r r Nr r r! r" r r r r! r r Trs r Nr r r! r" r r r r! r c f \ rS rSrSr " S S\R 5 r\R " SSSS9r Sr
g )
Sink.SpecValuei zThe sink to write to, plus its parameters.
Messages:
AdditionalProperty: An additional property for a SpecValue object.
Fields:
additionalProperties: Properties of the object.
c b \ rS rSrSr\R " S5 r\R " SS5 r Sr
g)!Sink.SpecValue.AdditionalPropertyi! An additional property for a SpecValue object.
Fields:
key: Name of the additional property.
value: A extra_types.JsonValue attribute.
r r r r Nr r r! r" r r ! r r! r r Trs r Nr r r! r" SpecValuer r r! r r r r N)r r r r r r r r r r r r r specr r r! r" r r s !!"89Z9$$ Z :Z. !!"89Z)## Z :Z.
q
1% Q /$r! r c \ rS rSrSr " S S\R 5 r\R " S5 r \R " S5 r
\R " S5 r \R " S5 r
\R " S 5 r\R " S
S S S
9r\R " S5 r\R " S5 r\R& " SS5 r\R " S5 rSrg)rs i2 a Represents a snapshot of a job.
Enums:
StateValueValuesEnum: State of the snapshot.
Fields:
creationTime: The time this snapshot was created.
description: User specified description of the snapshot. Maybe empty.
diskSizeBytes: The disk byte size of the snapshot. Only available for
snapshots in READY state.
id: The unique ID of this snapshot.
projectId: The project this snapshot belongs to.
pubsubMetadata: Pub/Sub snapshot metadata.
region: Cloud region where this snapshot lives in, e.g., "us-central1".
sourceJobId: The job this snapshot was created from.
state: State of the snapshot.
ttl: The time after which this snapshot will be automatically deleted.
c 0 \ rS rSrSrSrSrSrSrSr Sr
S r g
) Snapshot.StateValueValuesEnumiF ah State of the snapshot.
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.
r r r r r' rD r N) r r r r r UNKNOWN_SNAPSHOT_STATEPENDINGRUNNINGREADYFAILEDDELETEDr r r! r" StateValueValuesEnumr F s(
GG
E
FGr! r r r r r' rD rQ rE Trs r r r r r N)r r r r r r rF r r creationTimerI rG
diskSizeBytesr? rg r pubsubMetadataregion sourceJobIdrJ statettlr r r! r" rs rs 2 s &Y^^ & &&q),%%a(+((+- Q "##A&) ))*BAPTU. #&%%a(+
4a
8% b!#r! rs c \ rS rSrSr\R " S5 r\R " S5 r\R " S5 r
\R " S5 r Sr g) r ie a Request to create a snapshot of a job.
Fields:
description: User specified description of the snapshot. Maybe empty.
location: The location that contains this job.
snapshotSources: If true, perform snapshots for sources which support
this.
ttl: TTL for the snapshot.
r r r r' r N)
r r r r r r r rI r( r snapshotSourcesr r r r! r" r r e sI %%a(+
"
"1
%( **1-/ a #r! r c \ rS rSrSr\R " S5 r\R " S5 r \R " S5 r
\R " S5 r Sr g) r iv a Snapshot policies to take a snapshot of the existing dataflow job before
beginning the deployment.
Fields:
description: User specified description of the snapshot. Maybe empty.
snapshot: If true, task a snapshot of the existing dataflow job before
beginning the deployment.
snapshotSources: If true, perform snapshots for sources which support
this.
ttl: TTL for the snapshot.
r r r r' r N)
r r r r r r r rI r snapshotr r r r r! r" r r v sI
%%a(+
#
#A
&( **1-/ a #r! r c \ rS rSrSr\R " S5 " S S\R 5 5 r \R " S5 " S S\R 5 5 r
\R " S5 " S S \R 5 5 r \R " SS
S S 9r
\R " SS
5 r\R " S5 r\R " SS5 r\R " S S5 rSrg)r i a A source that records can be read and decoded from.
Messages:
BaseSpecsValueListEntry: A BaseSpecsValueListEntry object.
CodecValue: The codec to use to decode data read from the source.
SpecValue: The source to read from, plus its parameters.
Fields:
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).
codec: The codec to use to decode data read from the source.
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.
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.
spec: The source to read from, plus its parameters.
rz c f \ rS rSrSr " S S\R 5 r\R " SSSS9r Sr
g )
Source.BaseSpecsValueListEntryi zA BaseSpecsValueListEntry object.
Messages:
AdditionalProperty: An additional property for a BaseSpecsValueListEntry
object.
Fields:
additionalProperties: Properties of the object.
c b \ rS rSrSr\R " S5 r\R " SS5 r Sr
g)1Source.BaseSpecsValueListEntry.AdditionalPropertyi zAn additional property for a BaseSpecsValueListEntry object.
Fields:
key: Name of the additional property.
value: A extra_types.JsonValue attribute.
r r r r Nr r r! r" r r r r! r r Trs r Nr r r! r" BaseSpecsValueListEntryr r r! r c f \ rS rSrSr " S S\R 5 r\R " SSSS9r Sr
g )
Source.CodecValuei zThe codec to use to decode data read from the source.
Messages:
AdditionalProperty: An additional property for a CodecValue object.
Fields:
additionalProperties: Properties of the object.
c b \ rS rSrSr\R " S5 r\R " SS5 r Sr
g)$Source.CodecValue.AdditionalPropertyi r r r r r Nr r r! r" r r r r! r r Trs r Nr r r! r" r r r r! r c f \ rS rSrSr " S S\R 5 r\R " SSSS9r Sr
g )
Source.SpecValuei zThe source to read from, plus its parameters.
Messages:
AdditionalProperty: An additional property for a SpecValue object.
Fields:
additionalProperties: Properties of the object.
c b \ rS rSrSr\R " S5 r\R " SS5 r Sr
g)#Source.SpecValue.AdditionalPropertyi r r r r r Nr r r! r" r r r r! r r Trs r Nr r r! r" r r
r r! r r Trs r r SourceMetadatar' rD r N)r r r r r r r r r r r r r baseSpecsr r doesNotNeedSplittingr6 r r r r! r" r r s #J !!"89Z 1 1 Z :Z0 !!"89Z9$$ Z :Z. !!"89Z)## Z :Z. $$%>DQ)
q
1%"//2
#
#$4a
8( Q /$r! r c \ rS rSrSr\R " SS5 r\R " SS5 r\R " SS5 r \R " SS5 r
S r g
)
SourceForki zDEPRECATED in favor of DynamicSourceSplit.
Fields:
primary: DEPRECATED
primarySource: DEPRECATED
residual: DEPRECATED
residualSource: DEPRECATED
SourceSplitShardr r r r r' r N) r r r r r r r r
primarySourcer residualSourcer r r! r" r r sS
" "#5q 9'(( !<-
#
#$6
:( ))/1=.r! r c > \ rS rSrSr\R " SS5 rSrg)SourceGetMetadataRequesti zA request to compute the SourceMetadata of a Source.
Fields:
source: Specification of the source whose metadata should be computed.
r r r NrV r r! r" r r rW r! r c > \ rS rSrSr\R " SS5 rSrg)SourceGetMetadataResponsei zXThe result of a SourceGetMetadataOperation.
Fields:
metadata: The computed metadata.
r r r N) r r r r r r r r6 r r r! r" r r s
#
#$4a
8(r! r c \ rS rSrSr\R " S5 r\R " S5 r \R " S5 r
Sr g)r i# aN Metadata about a Source useful for automatically optimizing and tuning
the pipeline, etc.
Fields:
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.
infinite: Specifies that the size of this source is known to be infinite
(this is a streaming source).
producesSortedKeys: Whether this source is known to produce key/value
pairs with the (encoded) keys in lexicographically sorted order.
r r r r N) r r r r r r rG estimatedSizeBytesr infiniteproducesSortedKeysr r r! r" r r # s; !--a0
#
#A
&( --a0r! r c \ rS rSrSr\R " SS5 r\R " S5 r \R " S5 r
\R " SS5 r \R " S 5 r \R " S
5 r
S rg )
SourceOperationRequesti7 a A work item that represents the different operations that can be
performed on a user-defined Source specification.
Fields:
getMetadata: Information about a request to get metadata about a source.
name: User-provided name of the Read instruction for this source.
originalName: System-defined name for the Read instruction for this source
in the original workflow graph.
split: Information about a request to split a source.
stageName: System-defined name of the stage containing the source
operation. Unique across the workflow.
systemName: System-defined name of the Read instruction for this source.
Unique across the workflow.
r r r r SourceSplitRequestr' rD rE r N)r r r r r r r getMetadatar r r splitr} r r r r! r" r! r! 7 so
&&'A1E+ q !$&&q),
!5q
9%##A&)$$Q'*r! r! c d \ rS rSrSr\R " SS5 r\R " SS5 rSr g) SourceOperationResponseiO a The result of a SourceOperationRequest, specified in
ReportWorkItemStatusRequest.source_operation when the work item is
completed.
Fields:
getMetadata: A response to a request to get metadata about a source.
split: A response to a request to split a source.
r r SourceSplitResponser r N)
r r r r r r r r# r$ r r r! r" r& r& O s/ &&'BAF+
!6
:%r! r& c ` \ rS rSrSr\R " S5 r\R " S5 rSr g)SourceSplitOptionsi] aJ Hints for splitting a Source into bundles (parts for parallel
processing) using SourceSplitRequest.
Fields:
desiredBundleSizeBytes: The source should be split into a set of bundles
where the estimated size of each is approximately this many bytes.
desiredShardSizeBytes: DEPRECATED in favor of desired_bundle_size_bytes.
r r r N)
r r r r r r rG desiredBundleSizeBytesdesiredShardSizeBytesr r r! r" r) r) ] s+ %11!4#003r! r) c d \ rS rSrSr\R " SS5 r\R " SS5 rSr g) r" ik a; 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.
Fields:
options: Hints for tuning the splitting process.
source: Specification of the source to be split.
r) r r r r N)
r r r r r r r optionsr r r r! r" r" r" k s.
" "#7 ;' ! !(A .&r! r" c \ rS rSrSr " S S\R 5 r\R " SSSS9r \R " SS 5 r \R " S
S SS9r S r
g
)r' i a The response to a SourceSplitRequest.
Enums:
OutcomeValueValuesEnum: 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.
Fields:
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.
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.
shards: DEPRECATED in favor of bundles.
c $ \ rS rSrSrSrSrSrSrg)*SourceSplitResponse.OutcomeValueValuesEnumi aZ 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.
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.
r r r r N) r r r r r SOURCE_SPLIT_OUTCOME_UNKNOWN SOURCE_SPLIT_OUTCOME_USE_CURRENT'SOURCE_SPLIT_OUTCOME_SPLITTING_HAPPENEDr r r! r" OutcomeValueValuesEnumr0 s
$% '($./+r! r4 r r Trs r r r r N)r r r r r r rF r4 r bundlesrJ outcomeshardsr r r! r" r' r' sU *0y~~ 0&
" "?A E' 8! <' ! !"4a$ G&r! r' c \ rS rSrSr " S S\R 5 r\R " SS5 r \R " SS5 r Sr g )
r i zDEPRECATED in favor of DerivedSource.
Enums:
DerivationModeValueValuesEnum: DEPRECATED
Fields:
derivationMode: DEPRECATED
source: DEPRECATED
c ( \ rS rSrSrSrSrSrSrSr g) .SourceSplitShard.DerivationModeValueValuesEnumi a DEPRECATED
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.
r r r r r Nr r r! r" r r: r r! r r r r r Nr r r! r" r r s> 2inn 2$ &&'FJ. ! !(A .&r! r c \ rS rSrSr\R " S5 r\R " S5 r\R " S5 r Sr
g)r i zMetadata for a Spanner connector used by the job.
Fields:
databaseId: DatabaseId accessed in the connection.
instanceId: InstanceId accessed in the connection.
projectId: ProjectId accessed in the connection.
r r r r N) r r r r r r r
databaseIdrm rg r r r! r" r r s9 $$Q'*$$Q'*##A&)r! r c \ rS rSrSr\R " S\R R S9r \R " S\R R S9r Sr g)r i zA representation of an int64, n, that is immune to precision loss when
encoded in JSON.
Fields:
highBits: The high order bits, including the sign: n >> 32.
lowBits: The low order bits: n & 0xffffffff.
r r r r N)
r r r r r r rG r r\ highBitsUINT32lowBitsr r r! r" r r sE
#
#Ay/@/@/F/F
G( " "1i.?.?.F.F G'r! r c \ rS rSrSr\R " S5 r\R " S\R R S9r \R " S5 r \R " S5 r
\R " S5 rS rg
) r i a A structuredstacktrace for a process running on the worker.
Fields:
stackContent: The raw stack trace.
threadCount: With java thread dumps we may get collapsed stacks e.g., N
threads in stack "". Instead of having to copy over the same stack trace
N times, this int field captures this.
threadName: Thread name. For example, "CommitThread-0,10,main"
threadState: The state of the thread. For example, "WAITING".
timestamp: Timestamp at which the stack was captured.
r r r r r' rD r N)r r r r r r r stackContentrG r r\ threadCount
threadName threadStater r r r! r" r r sg
&&q),&&q)2C2C2I2IJ+$$Q'*%%a(+##A&)r! r c ` \ rS rSrSr\R " S5 r\R " SSSS9r Sr
g )
StageExecutionDetailsi a. Information about the workers and work items within a stage.
Fields:
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.
workers: Workers that have done work on the stage.
r
WorkerDetailsr Trs r N) r r r r r r r r r workersr r r! r" rG rG s- ''*- " "?A E'r! rG c \ rS rSrSr\R " S5 r\R " S5 r\R " S5 r
\R " S5 r Sr g) r< i a Description of an input or output of an execution stage.
Fields:
name: Dataflow service generated name for this source.
originalTransformOrCollection: User name for the original user transform
or collection with which this source is most closely associated.
sizeBytes: Size of the source, if measurable.
userName: Human-readable name for this source; may be user or system
generated.
r r r r' r N)
r r r r r r r r r rG sizeBytesr r r r! r" r< r< sJ
q !$"+"7"7": $$Q')
"
"1
%(r! r< c D \ rS rSrSr " S S\R 5 r\R " S5 r \R " SSSS 9r \R " S
S 5 r \R " S 5 r
\R " S
5 r\R " SS5 r\R " SS5 rSrg)r i a Information about a particular execution stage of a job.
Enums:
StateValueValuesEnum: State of this stage.
Fields:
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.
metrics: Metrics for this stage.
progress: Progress for this stage. Only applicable to Batch jobs.
stageId: ID of this stage
startTime: Start time of this stage.
state: State of this stage.
stragglerSummary: Straggler summary for this stage.
c 0 \ rS rSrSrSrSrSrSrSr Sr
S r g
) !StageSummary.StateValueValuesEnumi0 a State of this stage.
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.
r r r r r' rD r N r r r r r EXECUTION_STATE_UNKNOWNEXECUTION_STATE_NOT_STARTEDEXECUTION_STATE_RUNNINGEXECUTION_STATE_SUCCEEDEDEXECUTION_STATE_FAILEDEXECUTION_STATE_CANCELLEDr r r! r" r rN 0 - "# ! ! r! r r r r Trs rB r r' rD rE StragglerSummaryr r N)r r r r r r rF r r r r r progressr1 r rJ r stragglerSummaryr r r! r" r r s ""Y^^ "$
! !! $' " ">1t D'
#
#$8!
<( ! !! $'##A&)
4a
8% ++,>Br! r c \ rS rSrSr " S S\R 5 r " S S\R 5 r\R " SS5 r
\R " S5 r \R " SS S
S 9r
\R " S 5 r\R " S
5 r\R " S5 r\R " S5 r\R$ " SSS 9r\R " S5 r\R " S5 r\R " S5 r\R " S5 rSrg)StandardQueryParametersiK a Query parameters accepted by all methods.
Enums:
FXgafvValueValuesEnum: V1 error format.
AltValueValuesEnum: Data format for response.
Fields:
f__xgafv: V1 error format.
access_token: OAuth access token.
alt: Data format for response.
callback: JSONP
fields: Selector specifying which fields to include in a partial response.
key: API key. Your API key identifies your project and provides you with
API access, quota, and reports. Required unless you provide an OAuth 2.0
token.
oauth_token: OAuth 2.0 token for the current user.
prettyPrint: Returns response with indentations and line breaks.
quotaUser: Available to use for quota purposes for server-side
applications. Can be any arbitrary string assigned to a user, but should
not exceed 40 characters.
trace: A tracing token of the form "token:" to include in api
requests.
uploadType: Legacy upload protocol for media (e.g. "media", "multipart").
upload_protocol: Upload protocol for media (e.g. "raw", "multipart").
c $ \ rS rSrSrSrSrSrSrg)*StandardQueryParameters.AltValueValuesEnumif zData format for response.
Values:
json: Responses with Content-Type of application/json
media: Media download with context-dependent Content-Type
proto: Responses with Content-Type of application/x-protobuf
r r r r N) r r r r r jsonmediaprotor r r! r" AltValueValuesEnumr] f s
D
E
Er! ra c \ rS rSrSrSrSrSrg)-StandardQueryParameters.FXgafvValueValuesEnumir zFV1 error format.
Values:
_1: v1 error format
_2: v2 error format
r r r N)r r r r r _1_2r r r! r" FXgafvValueValuesEnumrc r s
B
Br! rf r r r r^ )defaultr' rD rE r r Tr r r r r N)r r r r r r rF ra rf rJ f__xgafvr access_tokenaltcallbackfieldsr oauth_tokenr prettyPrint quotaUsertrace
uploadTypeupload_protocolr r r! r" r[ r[ K s 4
9>>
inn
!8!
<(&&q), 0!VD#
"
"1
%( #& a #%%a(+&&q$7+##A&)
#%$$R(* ))"-/r! r[ c ` \ rS rSrSr\R " S5 r\R " S5 r Sr
g)r i zState family configuration.
Fields:
isRead: If true, this family corresponds to a read operation.
stateFamily: The state family value.
r r r N) r r r r r r r isReadr stateFamilyr r r! r" r r s) ! !! $&%%a(+r! r c \ rS rSrSr\R " S5 " S S\R 5 5 r \R " S\R R S9r
\R " SSS S
9r\R " S 5 rS rg
)r i a 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).
Messages:
DetailsValueListEntry: A DetailsValueListEntry object.
Fields:
code: The status code, which should be an enum value of google.rpc.Code.
details: A list of messages that carry the error details. There is a
common set of message types for APIs to use.
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.
rz c f \ rS rSrSr " S S\R 5 r\R " SSSS9r Sr
g )
Status.DetailsValueListEntryi zA DetailsValueListEntry object.
Messages:
AdditionalProperty: An additional property for a DetailsValueListEntry
object.
Fields:
additionalProperties: Properties of the object. Contains field @type
with type URL.
c b \ rS rSrSr\R " S5 r\R " SS5 r Sr
g)/Status.DetailsValueListEntry.AdditionalPropertyi zAn additional property for a DetailsValueListEntry object.
Fields:
key: Name of the additional property.
value: A extra_types.JsonValue attribute.
r r r r Nr r r! r" r rz r r! r r Trs r Nr r r! r" DetailsValueListEntryrx r r! r{ r r r Trs r r N)r r r r r r r r r r{ rG r r\ coder detailsr messager r r! r" r r s| & !!"89Zi / / Z :Z2
9+<+<+B+B C$ " "#:A M' ! !! $'r! r c \ rS rSrSr\R " S5 " S S\R 5 5 r \R " S5 r \R " S5 r \R " SS5 rS rg
) r i a 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.
Messages:
PropertiesValue: 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.
Fields:
kind: The kind of step in the Cloud Dataflow job.
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.
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.
rz c f \ rS rSrSr " S S\R 5 r\R " SSSS9r Sr
g )
Step.PropertiesValuei a? 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.
Messages:
AdditionalProperty: An additional property for a PropertiesValue object.
Fields:
additionalProperties: Properties of the object.
c b \ rS rSrSr\R " S5 r\R " SS5 r Sr
g)'Step.PropertiesValue.AdditionalPropertyi zAn additional property for a PropertiesValue object.
Fields:
key: Name of the additional property.
value: A extra_types.JsonValue attribute.
r r r r Nr r r! r" r r r r! r r Trs r Nr r r! r" PropertiesValuer r r! r r r r r N)r r r r r r r r r r r r r r
propertiesr r r! r" r r sl 8 !!"89Z )) Z :Z2
q !$ q !$%%&7;*r! r c d \ rS rSrSr\R " SS5 r\R " SS5 rSr g) Straggleri zInformation for a straggler.
Fields:
batchStraggler: Batch straggler identification and debugging information.
streamingStraggler: Streaming straggler identification and debugging
information.
StragglerInfor StreamingStragglerInfor r N)
r r r r r r r batchStragglerstreamingStragglerr r r! r" r r s/ ))/1=. --.FJr! r c > \ rS rSrSr\R " SS5 rSrg)StragglerDebuggingInfoi a 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.
Fields:
hotKey: Hot key debugging details.
r r r N) r r r r r r r hotKeyr r r! r" r r s ! !"7 ;&r! r c \ rS rSrSr\R " S5 " S S\R 5 5 r \R " SS5 r \R " S5 r
Srg )
r i a Information useful for straggler identification and debugging.
Messages:
CausesValue: The straggler causes, keyed by the string representation of
the StragglerCause enum and contains specialized debugging information
for each straggler cause.
Fields:
causes: The straggler causes, keyed by the string representation of the
StragglerCause enum and contains specialized debugging information for
each straggler cause.
startTime: The time when the work item attempt became a straggler.
rz c f \ rS rSrSr " S S\R 5 r\R " SSSS9r Sr
g )
StragglerInfo.CausesValuei- a: The straggler causes, keyed by the string representation of the
StragglerCause enum and contains specialized debugging information for
each straggler cause.
Messages:
AdditionalProperty: An additional property for a CausesValue object.
Fields:
additionalProperties: Additional properties of type CausesValue
c b \ rS rSrSr\R " S5 r\R " SS5 r Sr
g),StragglerInfo.CausesValue.AdditionalPropertyi: zAn additional property for a CausesValue object.
Fields:
key: Name of the additional property.
value: A StragglerDebuggingInfo attribute.
r r r r Nr r r! r" r r : s,
! !! $c$$%=qAer! r r Trs r Nr r r! r" CausesValuer - s4 BY . . B %112FTXYr! r r r r N)r r r r r r r r r r r causesr r r r r! r" r r s[ !!"89ZI%% Z :Z2 ! !- 3&##A&)r! r c \ rS rSrSr\R " S5 " S S\R 5 5 r \R " SSSS 9r \R " SS
5 r \R " S 5 rS rg
)rW iK a Summarized straggler identification details.
Messages:
StragglerCauseCountValue: Aggregated counts of straggler causes, keyed by
the string representation of the StragglerCause enum.
Fields:
recentStragglers: The most recent stragglers.
stragglerCauseCount: Aggregated counts of straggler causes, keyed by the
string representation of the StragglerCause enum.
totalStragglerCount: The total count of stragglers.
rz c f \ rS rSrSr " S S\R 5 r\R " SSSS9r Sr
g )
)StragglerSummary.StragglerCauseCountValueiY a% Aggregated counts of straggler causes, keyed by the string
representation of the StragglerCause enum.
Messages:
AdditionalProperty: An additional property for a
StragglerCauseCountValue object.
Fields:
additionalProperties: Additional properties of type
StragglerCauseCountValue
c ` \ rS rSrSr\R " S5 r\R " S5 r Sr
g). ,,-I1M$112JANr! r c ` \ rS rSrSr\R " S5 r\R " S5 rSr g) StreamingApplianceSnapshotConfigi zStreaming appliance snapshot configuration.
Fields:
importStateEndpoint: Indicates which endpoint is used to import appliance
state.
snapshotId: If set, indicates the snapshot id for the snapshot being
performed.
r r r N)
r r r r r r r importStateEndpointr r r r! r" r r s* "--a0$$Q'*r! r c " \ rS rSrSr\R " S5 " S S\R 5 5 r \R " S5 r \R " SSS S
9r
\R " S 5 r\R " S 5 r\R " SS
5 rSrg)StreamingComputationConfigi a Configuration information for a single streaming computation.
Messages:
TransformUserNameToStateFamilyValue: Map from user name of stateful
transforms in this stage to their state family.
Fields:
computationId: Unique identifier for this computation.
instructions: Instructions that comprise the computation.
stageName: Stage name of this computation.
systemName: System defined name for this computation.
transformUserNameToStateFamily: Map from user name of stateful transforms
in this stage to their state family.
rz c f \ rS rSrSr " S S\R 5 r\R " SSSS9r Sr
g )
>StreamingComputationConfig.TransformUserNameToStateFamilyValuei a$ Map from user name of stateful transforms in this stage to their state
family.
Messages:
AdditionalProperty: An additional property for a
TransformUserNameToStateFamilyValue object.
Fields:
additionalProperties: Additional properties of type
TransformUserNameToStateFamilyValue
c ` \ rS rSrSr\R " S5 r\R " S5 rSr g)QStreamingComputationConfig.TransformUserNameToStateFamilyValue.AdditionalPropertyi zAn additional property for a TransformUserNameToStateFamilyValue
object.
Fields:
key: Name of the additional property.
value: A string attribute.
r r r Nr r r! r" r r )
! !! $c##A&er! r r Trs r Nr r r! r" #TransformUserNameToStateFamilyValuer s2
'Y . .
' %112FTXYr! r r rz r Trs r r' rD r N)r r r r r r r r r r r r r r| r} r transformUserNameToStateFamilyr r r! r" r r s
!!"89ZI,=,= Z :Z6 ''*-''(=q4P,##A&)$$Q'*#,#9#9:_ab#c r! r c ` \ rS rSrSr\R " S5 r\R " SSSS9r Sr
g )
StreamingComputationRangesi zDescribes full or partial data disk assignment information of the
computation ranges.
Fields:
computationId: The ID of the computation.
rangeAssignments: Data disk assignments for ranges from this computation.
r r! r Trs r N) r r r r r r r r r rangeAssignmentsr r r! r" r r s0 ''*- ++,H!VZ[r! r c \ rS rSrSr " S S\R 5 r\R " SSSS9r \R " S S
SS9r
\R " SS 5 r S r
g
)StreamingComputationTaski a A task which describes what action should be performed for the specified
streaming computation ranges.
Enums:
TaskTypeValueValuesEnum: A type of streaming computation task.
Fields:
computationRanges: Contains ranges of a streaming computation this task
should apply to.
dataDisks: Describes the set of data disks this task should apply to.
taskType: A type of streaming computation task.
c $ \ rS rSrSrSrSrSrSrg)0StreamingComputationTask.TaskTypeValueValuesEnumi aX A type of streaming computation task.
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).
r r r r N) r r r r r "STREAMING_COMPUTATION_TASK_UNKNOWN STREAMING_COMPUTATION_TASK_STOP STREAMING_COMPUTATION_TASK_STARTr r r! r" TaskTypeValueValuesEnumr s *+&&'#'($r! r r r Trs r r r r N)r r r r r r rF r r computationRangesr1 rJ taskTyper r r! r" r r sX
)
) ,,-I1W[\$$%6DI)
!:A
>(r! r c \ rS rSrSr\R " S5 " S S\R 5 5 r \R " S5 r \R " S5 r \R " S5 r
\R " S S
5 r\R " S S S
S9r\R " SS5 r\R$ " S5 r\R$ " S5 r\R* " S5 r\R " S5 rSrg)StreamingConfigTaski ad A task that carries configuration information for streaming
computations.
Messages:
UserStepToStateFamilyNameMapValue: Map from user step names to state
families.
Fields:
commitStreamChunkSizeBytes: Chunk size for commit streams from the harness
to windmill.
getDataStreamChunkSizeBytes: Chunk size for get data streams from the
harness to windmill.
maxWorkItemCommitBytes: Maximum size for work item commit supported
windmill storage layer.
operationalLimits: Operational limits for the streaming job. Can be used
by the worker to validate outputs sent to the backend.
streamingComputationConfigs: Set of computation configuration information.
userStepToStateFamilyNameMap: Map from user step names to state families.
userWorkerRunnerV1Settings: Binary encoded proto to control runtime
behavior of the java runner v1 user worker.
userWorkerRunnerV2Settings: Binary encoded proto to control runtime
behavior of the runner v2 user worker.
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.
windmillServicePort: If present, the worker must use this port to
communicate with Windmill Service dispatchers. Only applicable when
windmill_service_endpoint is specified.
rz c f \ rS rSrSr " S S\R 5 r\R " SSSS9r Sr
g )
5StreamingConfigTask.UserStepToStateFamilyNameMapValuei zMap from user step names to state families.
Messages:
AdditionalProperty: An additional property for a
UserStepToStateFamilyNameMapValue object.
Fields:
additionalProperties: Additional properties of type
UserStepToStateFamilyNameMapValue
c ` \ rS rSrSr\R " S5 r\R " S5 rSr g)HStreamingConfigTask.UserStepToStateFamilyNameMapValue.AdditionalPropertyi' zAn additional property for a UserStepToStateFamilyNameMapValue
object.
Fields:
key: Name of the additional property.
value: A string attribute.
r r r Nr r r! r" r r ' r r! r r Trs r Nr r r! r" !UserStepToStateFamilyNameMapValuer 2
'Y . .
' %112FTXYr! r r r r StreamingOperationalLimitsr' r rD Trs rE r r r r r N)r r r r r r r r r r rG commitStreamChunkSizeBytesgetDataStreamChunkSizeBytesmaxWorkItemCommitBytesr operationalLimitsstreamingComputationConfigs userStepToStateFamilyNameMap
BytesFielduserWorkerRunnerV1SettingsuserWorkerRunnerV2Settingsr windmillServiceEndpointwindmillServicePortr r r! r" r r s < !!"89Z)*;*; Z :Z4 ) 5 5a 8 ) 6 6q 9 $11!4 ,,-I1M ) 6 67SUVae f !*!7!78[]^!_ ( 3 3A 6 ( 3 3A 6 % 1 1! 4!..r2r! r c 8 \ rS rSrSr\R " S5 r\R " S5 r\R " S5 r \R " S5 r
\R " S5 r \R " S5 r \R " S 5 r
\R " S
5 rS rg )
r iA aS Operational limits imposed on streaming jobs by the backend.
Fields:
maxBagElementBytes: The maximum size for an element in bag state.
maxGlobalDataBytes: The maximum size for an element in global data.
maxKeyBytes: The maximum size allowed for a key.
maxProductionOutputBytes: The maximum size for a single output element.
maxSortedListElementBytes: The maximum size for an element in sorted list
state.
maxSourceStateBytes: The maximum size for a source state update.
maxTagBytes: The maximum size for a state tag.
maxValueBytes: The maximum size for a value state field.
r r r r' rD rE r r r N)r r r r r r rG maxBagElementBytesmaxGlobalDataBytes maxKeyBytesmaxProductionOutputBytesmaxSortedListElementBytesmaxSourceStateBytes maxTagBytes
maxValueBytesr r r! r" r r A s !--a0 --a0&&q)+ & 3 3A 6 ' 4 4Q 7!..q1&&q)+((+-r! r c f \ rS rSrSr\R " S\R R S9r \R " S\R R S9r
\R " S\R R S9r \R " S5 r \R " S\R R S9r
\R " S \R R S9r\R " S
\R R S9r\R " S 5 r\R " S \R R S9rS
rg)StreamingScalingReportiZ a Contains per-user worker telemetry used in streaming autoscaling.
Fields:
activeBundleCount: A integer attribute.
activeThreadCount: Current acive thread count.
maximumBundleCount: Maximum bundle count.
maximumBytes: Maximum bytes.
maximumBytesCount: A integer attribute.
maximumThreadCount: Maximum thread count limit.
outstandingBundleCount: Current outstanding bundle count.
outstandingBytes: Current outstanding bytes.
outstandingBytesCount: A integer attribute.
r r r r r' rD rE r r r r N)r r r r r r rG r r\ activeBundleCountactiveThreadCountmaximumBundleCount maximumBytesmaximumBytesCountmaximumThreadCountoutstandingBundleCountoutstandingBytesoutstandingBytesCountr r r! r" r r Z s ,,Q 8I8I8O8OP ,,Q 8I8I8O8OP --a9J9J9P9PQ''*, ,,Q 8I8I8O8OP --a9J9J9P9PQ$11!Y=N=N=T=TU ++A.#00I r> s $"Y^^ "$ ##A&) ! !! $' " ">1t D'
#
#$8!
<(##A&)
4a
8%(( !<- #&r! r> c \ rS rSrSr\R " S5 " S S\R 5 5 r \R " SS5 r \R " SS5 r \R " S S
5 r
\R " S 5 r\R " S S
SS9r\R" " S5 r\R " S5 r\R " SS5 r\R " SS5 r\R " SS5 rSrg)rf iK a The Dataflow service's idea of the current state of a WorkItem being
processed by a worker.
Messages:
HarnessDataValue: Other data returned by the service, specific to the
particular worker harness.
Fields:
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.
harnessData: Other data returned by the service, specific to the
particular worker harness.
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.
leaseExpireTime: Time at which the current lease will expire.
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.
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.
reportStatusInterval: New recommended reporting interval.
splitRequest: The progress point in the WorkItem where the Dataflow
service suggests that the worker truncate the task.
suggestedStopPoint: DEPRECATED in favor of split_request.
suggestedStopPosition: Obsolete, always empty.
rz c f \ rS rSrSr " S S\R 5 r\R " SSSS9r Sr
g )
%WorkItemServiceState.HarnessDataValuein zOther data returned by the service, specific to the particular worker
harness.
Messages:
AdditionalProperty: An additional property for a HarnessDataValue
object.
Fields:
additionalProperties: Properties of the object.
c b \ rS rSrSr\R " S5 r\R " SS5 r Sr
g)8WorkItemServiceState.HarnessDataValue.AdditionalPropertyi{ zAn additional property for a HarnessDataValue object.
Fields:
key: Name of the additional property.
value: A extra_types.JsonValue attribute.
r r r r Nr r r! r" r rH { r r! r r Trs r Nr r r! r" HarnessDataValuerF n r r! rI r r r r r r' r rD Trs rE r r, r r r r r r N)r r r r r r r r r rI r completeWorkStatus harnessDatahotKeyDetectionr r3
metricShortIdrG nextReportIndexr6 splitRequestsuggestedStopPointsuggestedStopPositionr r r! r" rf rf K s D !!"89Z** Z :Z2 !--h:&&'91=+ **+ r Trs r r N) r r r r r r r r` r r r r r! r" rH rH s. $$%6DI)$$Q'*r! rH c h \ rS rSrSr\R " S5 " S S\R 5 5 r \R " S5 r \R " SSSS 9r
\R " S
5 r\R " S 5 r\R " S 5 r\R " S
5 r\R " S5 rSrg)WorkerHealthReporti a; 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.
Messages:
PodsValueListEntry: A PodsValueListEntry object.
Fields:
msg: Message describing any unusual health reports.
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.
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.
vmBrokenCode: Code to describe a specific reason, if known, that a VM has
reported broken state.
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.
vmIsHealthy: Whether the VM is currently healthy.
vmStartupTime: The time the VM was booted.
rz c f \ rS rSrSr " S S\R 5 r\R " SSSS9r Sr
g )
%WorkerHealthReport.PodsValueListEntryi! zA PodsValueListEntry object.
Messages:
AdditionalProperty: An additional property for a PodsValueListEntry
object.
Fields:
additionalProperties: Properties of the object.
c b \ rS rSrSr\R " S5 r\R " SS5 r Sr
g)8WorkerHealthReport.PodsValueListEntry.AdditionalPropertyi! zAn additional property for a PodsValueListEntry object.
Fields:
key: Name of the additional property.
value: A extra_types.JsonValue attribute.
r r r r Nr r r! r" r re ! r r! r r Trs r Nr r r! r" PodsValueListEntryrc ! r r! rf r r Trs r r' rD rE r r N)r r r r r r r r r rf r msgr podsreportInterval vmBrokenCoder
vmIsBroken vmIsHealthy
vmStartupTimer r r! r" ra ra s 2 !!"89Z9,, Z :Z0 a # 4a$ G$ ((+.&&q),%%a(*&&q)+''*-r! ra c < \ rS rSrSr\R " S5 rSrg)WorkerHealthReportResponsei&! a@ WorkerHealthReportResponse contains information returned to the worker
in response to a health ping.
Fields:
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.
r r N) r r r r r r r ri r r r! r" ro ro &! s ((+.r! ro c \ rS rSrSr " S S\R 5 r\R " S5 " S S\R 5 5 r \R " S5 r
\R " SS 5 r\R " SS
5 rS rg )
WorkerLifecycleEventi3! a9 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.
Enums:
EventValueValuesEnum: The event being reported.
Messages:
MetadataValue: Other stats that can accompany an event. E.g. {
"downloaded_bytes" : "123456" }
Fields:
containerStartTime: The start time of this container. All events will
report this so that events can be grouped together across container/VM
restarts.
event: The event being reported.
metadata: Other stats that can accompany an event. E.g. {
"downloaded_bytes" : "123456" }
c 8 \ rS rSrSrSrSrSrSrSr Sr
S r S
r S r
g )
)WorkerLifecycleEvent.EventValueValuesEnumiJ! aT The event being reported.
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.
r r r r r' rD rE r r N)r r r r r
UNKNOWN_EVENTOS_STARTCONTAINER_START
NETWORK_UP STAGING_FILES_DOWNLOAD_START STAGING_FILES_DOWNLOAD_FINISHSDK_INSTALL_STARTSDK_INSTALL_FINISHr r r! r" EventValueValuesEnumrs J! s5
MHOJ#$ $%!r! r| rz c f \ rS rSrSr " S S\R 5 r\R " SSSS9r Sr
g )
"WorkerLifecycleEvent.MetadataValueib! zOther stats that can accompany an event. E.g. { "downloaded_bytes" :
"123456" }
Messages:
AdditionalProperty: An additional property for a MetadataValue object.
Fields:
additionalProperties: Additional properties of type MetadataValue
c ` \ rS rSrSr\R " S5 r\R " S5 rSr g)5WorkerLifecycleEvent.MetadataValue.AdditionalPropertyin! An additional property for a MetadataValue object.
Fields:
key: Name of the additional property.
value: A string attribute.
r r r Nr r r! r" r r n! r! r! r r Trs r Nr r r! r" r r~ b! r r! r r r r r N)r r r r r r rF r| r r r r r containerStartTimerJ eventr r6 r r r! r" rq rq 3! s ,Y^^ 0 !!"89Zi'' Z :Z0 !,,Q/
4a
8%
#
#OQ
7(r! rq c \ rS rSrSr\R " S5 " S S\R 5 5 r \R " SS5 r \R " SS5 r \R " S S
5 r
\R " S S 5 r\R " S
5 r\R " SS5 r\R " SS5 r\R " SS5 r\R " SS5 r\R " SS5 r\R " SS5 rSrg) r i! aI WorkerMessage provides information to the backend about a worker.
Messages:
LabelsValue: 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.
Fields:
dataSamplingReport: Optional. Contains metrics related to go/dataflow-
data-sampling-telemetry.
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.
perWorkerMetrics: System defined metrics for this worker.
streamingScalingReport: Contains per-user worker telemetry used in
streaming autoscaling.
time: The timestamp of the worker_message.
workerHealthReport: The health of a worker.
workerLifecycleEvent: Record of worker lifecycle events.
workerMessageCode: A worker message code.
workerMetrics: Resource metrics reported by workers.
workerShutdownNotice: Shutdown notice by workers.
workerThreadScalingReport: Thread scaling information reported by workers.
rz c f \ rS rSrSr " S S\R 5 r\R " SSSS9r Sr
g )
WorkerMessage.LabelsValuei! a4 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.
Messages:
AdditionalProperty: An additional property for a LabelsValue object.
Fields:
additionalProperties: Additional properties of type LabelsValue
c ` \ rS rSrSr\R " S5 r\R " S5 rSr g),WorkerMessage.LabelsValue.AdditionalPropertyi! r r r r Nr r r! r" r r ! r! r! r r Trs r Nr r r! r" r r ! r r! r r> r r r2 r r r' rD ra rE rq r WorkerMessageCoder rk r WorkerShutdownNoticer WorkerThreadScalingReportr r N)r r r r r r r r r r r dataSamplingReportr perWorkerMetricsstreamingScalingReportr rM workerHealthReportworkerLifecycleEventworkerMessageCode
workerMetricsworkerShutdownNoticeworkerThreadScalingReportr r r! r" r r ! s B !!"89ZI%% Z :Z8 !--.BAF ! !- 3& ++,>B$112JAN q !$ --.BAF"//0FJ ,,-@!D(()DaH-"//0FK ' 4 45PRT Ur! r c \ rS rSrSr\R " S5 " S S\R 5 5 r \R " S5 r \R " SS5 r
Srg )
r i! a
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).
Messages:
ParametersValue: 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.
Fields:
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.
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.
rz c f \ rS rSrSr " S S\R 5 r\R " SSSS9r Sr
g )
!WorkerMessageCode.ParametersValuei! a 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.
Messages:
AdditionalProperty: An additional property for a ParametersValue object.
Fields:
additionalProperties: Properties of the object.
c b \ rS rSrSr\R " S5 r\R " SS5 r Sr
g)4WorkerMessageCode.ParametersValue.AdditionalPropertyi" zAn additional property for a ParametersValue object.
Fields:
key: Name of the additional property.
value: A extra_types.JsonValue attribute.
r r r r Nr r r! r" r r " r r! r r Trs r Nr r r! r" r" r ! s4 ( AY . . A %112FTXYr! r" r r r N)r r r r r r r r r r" r r| r r) r r r! r" r r ! s^ +Z !!"89 Z )) Z : ZD
q !$%%&7;*r! r c \ rS rSrSr\R " SS5 r\R " SS5 r\R " SS5 r \R " S S
5 r
\R " S S 5 r S
r g)r i!" a A worker_message response allows the server to pass information to the
sender.
Fields:
streamingScalingReportResponse: Service's streaming scaling response for
workers.
workerHealthReportResponse: The service's response to a worker's health
report.
workerMetricsResponse: Service's response to reporting worker metrics
(currently empty).
workerShutdownNoticeResponse: Service's response to shutdown notice
(currently empty).
workerThreadScalingReportResponse: Service's thread scaling recommendation
for workers.
r r ro r rv r WorkerShutdownNoticeResponser' !WorkerThreadScalingReportResponserD r N)
r r r r r r r streamingScalingReportResponseworkerHealthReportResponseworkerMetricsResponse workerShutdownNoticeResponse!workerThreadScalingReportResponser r r! r" r r !" sr $-#9#9:Z\]#^ ( 5 56RTU V #001TVWX!*!7!78VXY!Z &/&<&<=`bc&d#r! r c \ rS rSrSr " S S\R 5 r " S S\R 5 r " S S\R 5 r \
R " S 5 " S
S \R 5 5 r
\
R " S 5 " S S
\R 5 5 r\R " SS5 r\R " SSSS9r\R$ " SS5 r\R( " S\R* R, S9r\R0 " S5 r\R0 " S5 r\R$ " SS5 r\R0 " S5 r \R0 " S5 r \R " S S 5 r \R0 " S 5 r \R( " S \R* R, S9r \R( " S \R* R, S9r!\R0 " S 5 r"\R " S!S"SS9r#\R " S
S#5 r$\R " S$S%SS9r%\R0 " S&5 r&\R " S'S(5 r'\R$ " SS)5 r(\R0 " S*5 r)\R0 " S+5 r*S,r+g-).r i9" a 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.
Enums:
DefaultPackageSetValueValuesEnum: 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.
IpConfigurationValueValuesEnum: Configuration for VM IPs.
TeardownPolicyValueValuesEnum: 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.
Messages:
MetadataValue: Metadata to set on the Google Compute Engine VMs.
PoolArgsValue: Extra arguments for this worker pool.
Fields:
autoscalingSettings: Settings for autoscaling of this WorkerPool.
dataDisks: Data disks that are used by a VM in this workflow.
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.
diskSizeGb: Size of root disk for VMs, in GB. If zero or unspecified, the
service will attempt to choose a reasonable default.
diskSourceImage: Fully qualified source image for disks.
diskType: Type of root disk for VMs. If empty or unspecified, the service
will attempt to choose a reasonable default.
ipConfiguration: Configuration for VM IPs.
kind: The kind of the worker pool; currently only `harness` and `shuffle`
are supported.
machineType: Machine type (e.g. "n1-standard-1"). If empty or unspecified,
the service will attempt to choose a reasonable default.
metadata: Metadata to set on the Google Compute Engine VMs.
network: Network to which VMs will be assigned. If empty or unspecified,
the service will use the network "default".
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).
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.
onHostMaintenance: The action to take on host maintenance, as defined by
the Google Compute Engine API.
packages: Packages to be installed on workers.
poolArgs: Extra arguments for this worker pool.
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.
subnetwork: Subnetwork to which VMs will be assigned, if desired. Expected
to be of the form "regions/REGION/subnetworks/SUBNETWORK".
taskrunnerSettings: Settings passed through to Google Compute Engine
workers when using the standard Dataflow task runner. Users should
ignore this field.
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.
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.
zone: Zone to run the worker pools in. If empty or unspecified, the
service will attempt to choose a reasonable default.
c ( \ rS rSrSrSrSrSrSrSr g) +WorkerPool.DefaultPackageSetValueValuesEnumi" aR 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.
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.
r r r r r N)
r r r r r DEFAULT_PACKAGE_SET_UNKNOWNDEFAULT_PACKAGE_SET_NONEDEFAULT_PACKAGE_SET_JAVADEFAULT_PACKAGE_SET_PYTHONr r r! r" DefaultPackageSetValueValuesEnumr " s!
#$ !" r! r c $ \ rS rSrSrSrSrSrSrg))WorkerPool.IpConfigurationValueValuesEnumi" rT r r r r NrU r r! r" rY r " rZ r! rY c ( \ rS rSrSrSrSrSrSrSr g) (WorkerPool.TeardownPolicyValueValuesEnumi" aI 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.
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.
r r r r r N)
r r r r r TEARDOWN_POLICY_UNKNOWNTEARDOWN_ALWAYSTEARDOWN_ON_SUCCESSTEARDOWN_NEVERr r r! r" TeardownPolicyValueValuesEnumr " s * ONr! r rz c f \ rS rSrSr " S S\R 5 r\R " SSSS9r Sr
g )
WorkerPool.MetadataValuei" zMetadata to set on the Google Compute Engine VMs.
Messages:
AdditionalProperty: An additional property for a MetadataValue object.
Fields:
additionalProperties: Additional properties of type MetadataValue
c ` \ rS rSrSr\R " S5 r\R " S5 rSr g)+WorkerPool.MetadataValue.AdditionalPropertyi" r r r r Nr r r! r" r r " r! r! r r Trs r Nr r r! r" r r " r# r! r c f \ rS rSrSr " S S\R 5 r\R " SSSS9r Sr
g )
WorkerPool.PoolArgsValuei" zExtra arguments for this worker pool.
Messages:
AdditionalProperty: An additional property for a PoolArgsValue object.
Fields:
additionalProperties: Properties of the object. Contains field @type
with type URL.
c b \ rS rSrSr\R " S5 r\R " SS5 r Sr
g)+WorkerPool.PoolArgsValue.AdditionalPropertyi" zAn additional property for a PoolArgsValue object.
Fields:
key: Name of the additional property.
value: A extra_types.JsonValue attribute.
r r r r Nr r r! r" r r " r r! r r Trs r Nr r r! r"
PoolArgsValuer " r r! r rP r r r Trs r r' r rD rE r r r r r r r r r r r r r
r r r r rd re r N),r r r r r r rF r rY r r r r r r r autoscalingSettingsr1 rJ defaultPackageSetrG r r\ rn r diskSourceImager rs r rv r6 rx numThreadsPerWorkerry onHostMaintenancer5 poolArgssdkHarnessContainerImagesr} taskrunnerSettingsteardownPolicyworkerHarnessContainerImager r r r! r" r r 9" sN Tl# #(
y~~
inn 6 !!"89Zi'' Z :Z. !!"89Zi'' Z :Z0 "../DaH$$VQ>) ))*LaP%%a1B1B1H1HI* ))!,/
"
"1
%( ''(H!L/ q !$%%a(+
#
#OR
8( ! !" %'!..r9;L;L;R;RS%%b)2C2C2I2IJ* ++B/
#
#IrD
A(
#
#OR
8( ' 4 45OQS^b c$$R(* --.BBG &&'FK. ) 5 5b 9 r "$r! r c \ rS rSrSr\R " S5 r\R " S5 r \R " S5 r
\R " S5 r \R " S5 r \R " S5 r
S rg
) r i# a+ Provides data to pass through to the worker harness.
Fields:
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/"
reportingEnabled: Whether to send work progress updates to the service.
servicePath: The Cloud Dataflow service path relative to the root URL, for
example, "dataflow/v1b3/projects".
shuffleServicePath: The Shuffle service path relative to the root URL, for
example, "shuffle/v1beta1".
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}
workerId: The ID of the worker running this pipeline.
r r r r' rD rE r N)r r r r r r r r r reportingEnabled servicePathshuffleServicePathr
r r r r! r" r r # sl *
! !! $' ++A.%%a(+ ,,Q/ ++A.
"
"1
%(r! r c < \ rS rSrSr\R " S5 rSrg)r i2# a| 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.
Fields:
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.
r r N) r r r r r r r reasonr r r! r" r r 2# s #&r! r c \ rS rSrSrSrg)r i@# z?Service-side response to WorkerMessage issuing shutdown notice.r Nro r r! r" r r @# s Hr! r c b \ rS rSrSr\R " S\R R S9r Sr
g)r iD# zContains information about the thread scaling information of a worker.
Fields:
currentThreadCount: Current number of active threads in a worker.
r r r N) r r r r r r rG r r\ currentThreadCountr r r! r" r r D# s( !--a9J9J9P9PQr! r c b \ rS rSrSr\R " S\R R S9r Sr
g)r iN# zContains the thread scaling recommendation for a worker from the
backend.
Fields:
recommendedThreadCount: Recommended number of threads for a worker.
r r r N) r r r r r r rG r r\ recommendedThreadCountr r r! r" r r N# s( %11!Y=N=N=T=TUr! r c d \ rS rSrSr\R " SS5 r\R " SS5 rSr g) r iY# zAn instruction that writes records. Takes one input, produces no
outputs.
Fields:
input: The input.
sink: The sink to write to.
rJ r r r r N)
r r r r r r r r r r r r! r" r r Y# s.
!3Q
7% *$r! r rh z$.xgafvrd 1re 2rO zdynamicTemplate.gcsPathrP z dynamicTemplate.stagingLocationN( r
__future__r apitools.base.protorpcliter r apitools.base.pyr r packager r r$ r, r0 r8 rP r_ rd rk rp rr r r r r r r r r2 r r r r r r+ r- r0 r4 r> rG rU rj rm rt ry r| r~ r r r r r r r r r r r r r r r r r r r r r r r r
r r r r r r r! r' r+ r- r0 r3 r5 r7 r9 r< r> r@ rC rL rS rW rY r[ r] r_ rc re rg rj rn r r r r r r r r r r r. rD rF rI r r r r r r r r r r r r r r rJ r r r r r r r r r r r r! r r) r
r: rM rH r rW r rd rh rj rn rr rv ry r r r r r r r r r r r r r rn r r rz r r r r r- r2 r r; r rB r rI rQ r r ra r& rk rv r r$ r r r r r r r r r rT r r r r r r r rs r r r r r r r r! r& r) r" r' r r r r rG r< r r[ r r r r r r rW r r r r r r r r r r r r r r rC r r3 r r r5 r^ r> rf r^ rH ra ro rq r r r r r r r r r r AddCustomJsonFieldMappingAddCustomJsonEnumMappingrf r r! r" r s ' < % ( +)++ + &J)"3"3 &JR3i / / 3$ ;y ; 5(y(( 5(pM)++ M8
EI%%
E
# ))
# % )) % 6)## 6 %(i'' %(P /I%% /
Hi
H A9#4#4 A&i'' &"
&**
& -)++ -( 3Y&& 3 1I%% 14DIi'' DIN?'I - - ?'D
-> ( J7I,=,= J7Z,7 (9(9 ,7^ 6 0A0A 6 Q)2C2C Q 'I,=,= '&*7Y%6%6 *7ZJ7i&7&7 J7ZF'i.?.? F'R G)*;*; G ( (9(9 (2 6 0A0A 6 Yy7H7H Y + 8I8I +0+ 8I8I +. 7Y5F5F 7B3i6G6G 3*'y?P?P '*+y7H7H +2 U):K:K U 6):K:K 6$,71B1B ,7^69J9J 6&6IDUDU 6&Q9;L;L Q&6i>O>O 60'Y5F5F '&*7i.?.? *7ZJ7y/@/@ J7ZF'y7H7H F'RG93D3D G" 6 8I8I 6 'IDUDU '<(1B1B (269J9J 6&Y @Q@Q Y& 7i6G6G 7 793D3D 7 6I4E4E 6 6i6G6G 6$ 793D3D 7@ +i6G6G +>UY5F5F U" 7)*;*; 7 69+<+< 6 3)2C2C 3$ 6Y->-> 6 7)*;*; 7@ +Y->-> +>
UI,=,=
U '** ' 29$$ 2 ,Y . . ,m)"" m)`+?y 0 0 +?\"/I%% "/JF9 F8%")## %"P)** ),
8**
8 I I))## I)XXU)++ XUv5>I - - 5>p "Y&& " )I%% )H** HZ#Y%6%6 Z#z4 )) 4 )) =)
=0!Y
0!f8y 0 0 82#0"" #0L'&i / / '&T5y 0 0 5 M 1 1 M ]!2!2 ].4"" .4b !9,, !2y(( 2 H !! H*!I%% *!Z=09 =0@0"y 0"f!** !"!Y&& !&s0Y
s0l
>""
> /y 0 0 /9 1 1 91Y&& 1((Y . . (0 ;i / / ; 4** 4 /** /*+H)++ +H\ /y(( /B 'y(( '
H""
H'I '( FI - - F &)## &$*C9$$ *CZ<.i / / <.~ ) )) )0%Y
0%f9<9 9 ! !114> " "35NPik " "35VXy{ " "*,EG`b " "*,MOprr!