docs: update docs (#916)
* fix: re-run script
* test: fix noxfile
diff --git a/docs/dyn/dataflow_v1b3.projects.locations.html b/docs/dyn/dataflow_v1b3.projects.locations.html
index 83befcd..94d3277 100644
--- a/docs/dyn/dataflow_v1b3.projects.locations.html
+++ b/docs/dyn/dataflow_v1b3.projects.locations.html
@@ -121,88 +121,29 @@
# contains the job.
"workerMessages": [ # The WorkerMessages to send.
{ # WorkerMessage provides information to the backend about a worker.
- "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.
- "a_key": "A String",
- },
- "time": "A String", # The timestamp of the worker_message.
- "workerLifecycleEvent": { # A report of an event in a worker's lifecycle. # Record of worker lifecycle events.
- # 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.
- "event": "A String", # The event being reported.
- "containerStartTime": "A String", # The start time of this container. All events will report this so that
- # events can be grouped together across container/VM restarts.
- "metadata": { # Other stats that can accompany an event. E.g.
- # { "downloaded_bytes" : "123456" }
- "a_key": "A String",
- },
- },
- "workerShutdownNotice": { # Shutdown notification from workers. This is to be sent by the shutdown # Shutdown notice by workers.
- # script of the worker VM so that the backend knows that the VM is being
- # shut down.
- "reason": "A String", # 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.
- },
- "workerHealthReport": { # WorkerHealthReport contains information about the health of a worker. # The health of a worker.
- #
- # The VM should be identified by the labels attached to the WorkerMessage that
- # this health ping belongs to.
- "vmIsHealthy": True or False, # Whether the VM is currently healthy.
- "reportInterval": "A String", # 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.
- "vmStartupTime": "A String", # The time the VM was booted.
- "vmIsBroken": True or False, # Whether the VM is in a permanently broken state.
- # Broken VMs should be abandoned or deleted ASAP to avoid assigning or
- # completing any work.
- "msg": "A String", # A 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.
- {
- "a_key": "", # Properties of the object.
- },
- ],
- },
"workerMetrics": { # Worker metrics exported from workers. This contains resource utilization # Resource metrics reported by workers.
# metrics accumulated from a variety of sources. For more information, see
# go/df-resource-signals.
- "memoryInfo": [ # Memory utilization samples.
- { # Information about the memory usage of a worker or a container within a
- # worker.
- "currentRssBytes": "A String", # Instantenous memory (RSS) size in bytes.
- "currentLimitBytes": "A String", # Instantenous memory limit in bytes.
- "totalGbMs": "A String", # Total memory (RSS) usage since start up in GB * ms.
- "timestamp": "A String", # Timestamp of the measurement.
- },
- ],
"containers": { # Per container information.
# Key: container name.
"a_key": # Object with schema name: ResourceUtilizationReport
},
+ "memoryInfo": [ # Memory utilization samples.
+ { # Information about the memory usage of a worker or a container within a
+ # worker.
+ "timestamp": "A String", # Timestamp of the measurement.
+ "currentLimitBytes": "A String", # Instantenous memory limit in bytes.
+ "currentRssBytes": "A String", # Instantenous memory (RSS) size in bytes.
+ "totalGbMs": "A String", # Total memory (RSS) usage since start up in GB * ms.
+ },
+ ],
"cpuTime": [ # CPU utilization samples.
{ # Modeled after information exposed by /proc/stat.
- "totalMs": "A String", # Total active CPU time across all cores (ie., non-idle) in milliseconds
- # since start-up.
"rate": 3.14, # Average CPU utilization rate (% non-idle cpu / second) since previous
# sample.
"timestamp": "A String", # Timestamp of the measurement.
+ "totalMs": "A String", # Total active CPU time across all cores (ie., non-idle) in milliseconds
+ # since start-up.
},
],
},
@@ -215,6 +156,16 @@
# 1. Worker processes reporting successful startup.
# 2. Worker processes reporting specific errors (e.g. package staging
# failure).
+ "code": "A String", # The code is a string intended for consumption by a machine that identifies
+ # the type of message being sent.
+ # Examples:
+ # 1. "HARNESS_STARTED" might be used to indicate the worker harness has
+ # started.
+ # 2. "GCS_DOWNLOAD_ERROR" might be used to indicate an error downloading
+ # a GCS file as part of the boot process of one of the worker containers.
+ #
+ # This is a string and not an enum to make it easy to add new codes without
+ # waiting for an API change.
"parameters": { # Parameters contains specific information about the code.
#
# This is a struct to allow parameters of different types.
@@ -237,16 +188,65 @@
# as labels since they will be included on most messages.
"a_key": "", # Properties of the object.
},
- "code": "A String", # The code is a string intended for consumption by a machine that identifies
- # the type of message being sent.
- # Examples:
- # 1. "HARNESS_STARTED" might be used to indicate the worker harness has
- # started.
- # 2. "GCS_DOWNLOAD_ERROR" might be used to indicate an error downloading
- # a GCS file as part of the boot process of one of the worker containers.
+ },
+ "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.
+ "a_key": "A String",
+ },
+ "time": "A String", # The timestamp of the worker_message.
+ "workerLifecycleEvent": { # A report of an event in a worker's lifecycle. # Record of worker lifecycle events.
+ # 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.
+ "containerStartTime": "A String", # The start time of this container. All events will report this so that
+ # events can be grouped together across container/VM restarts.
+ "event": "A String", # The event being reported.
+ "metadata": { # Other stats that can accompany an event. E.g.
+ # { "downloaded_bytes" : "123456" }
+ "a_key": "A String",
+ },
+ },
+ "workerShutdownNotice": { # Shutdown notification from workers. This is to be sent by the shutdown # Shutdown notice by workers.
+ # script of the worker VM so that the backend knows that the VM is being
+ # shut down.
+ "reason": "A String", # 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.
+ },
+ "workerHealthReport": { # WorkerHealthReport contains information about the health of a worker. # The health of a worker.
+ #
+ # The VM should be identified by the labels attached to the WorkerMessage that
+ # this health ping belongs to.
+ "pods": [ # The pods running on the worker. See:
+ # http://kubernetes.io/v1.1/docs/api-reference/v1/definitions.html#_v1_pod
#
- # This is a string and not an enum to make it easy to add new codes without
- # waiting for an API change.
+ # This field is used by the worker to send the status of the indvidual
+ # containers running on each worker.
+ {
+ "a_key": "", # Properties of the object.
+ },
+ ],
+ "reportInterval": "A String", # 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.
+ "vmIsHealthy": True or False, # Whether the VM is currently healthy.
+ "vmIsBroken": True or False, # Whether the VM is in a permanently broken state.
+ # Broken VMs should be abandoned or deleted ASAP to avoid assigning or
+ # completing any work.
+ "vmStartupTime": "A String", # The time the VM was booted.
+ "msg": "A String", # A message describing any unusual health reports.
},
},
],
@@ -264,10 +264,6 @@
"workerMessageResponses": [ # The servers response to the worker messages.
{ # A worker_message response allows the server to pass information to the
# sender.
- "workerMetricsResponse": { # Service-side response to WorkerMessage reporting resource utilization. # Service's response to reporting worker metrics (currently empty).
- },
- "workerShutdownNoticeResponse": { # Service-side response to WorkerMessage issuing shutdown notice. # Service's response to shutdown notice (currently empty).
- },
"workerHealthReportResponse": { # WorkerHealthReportResponse contains information returned to the worker # The service's response to a worker's health report.
# in response to a health ping.
"reportInterval": "A String", # A positive value indicates the worker should change its reporting interval
@@ -276,6 +272,10 @@
# The default value of zero means no change in report rate is requested by
# the server.
},
+ "workerShutdownNoticeResponse": { # Service-side response to WorkerMessage issuing shutdown notice. # Service's response to shutdown notice (currently empty).
+ },
+ "workerMetricsResponse": { # Service-side response to WorkerMessage reporting resource utilization. # Service's response to reporting worker metrics (currently empty).
+ },
},
],
}</pre>