docs: update docs/dyn (#1096)
This PR was generated using Autosynth. :rainbow:
Synth log will be available here:
https://source.cloud.google.com/results/invocations/6f0f288a-a1e8-4b2d-a85f-00b1c6150185/targets
- [ ] To automatically regenerate this PR, check this box.
Source-Link: https://github.com/googleapis/synthtool/commit/39b7149da4026765385403632db3c6f63db96b2c
Source-Link: https://github.com/googleapis/synthtool/commit/9a7d9fbb7045c34c9d3d22c1ff766eeae51f04c9
Source-Link: https://github.com/googleapis/synthtool/commit/dc9903a8c30c3662b6098f0e4a97f221d67268b2
Source-Link: https://github.com/googleapis/synthtool/commit/7fcc405a579d5d53a726ff3da1b7c8c08f0f2d58
Source-Link: https://github.com/googleapis/synthtool/commit/d5fc0bcf9ea9789c5b0e3154a9e3b29e5cea6116
Source-Link: https://github.com/googleapis/synthtool/commit/e89175cf074dccc4babb4eca66ae913696e47a71
Source-Link: https://github.com/googleapis/synthtool/commit/7d652819519dfa24da9e14548232e4aaba71a11c
Source-Link: https://github.com/googleapis/synthtool/commit/7db8a6c5ffb12a6e4c2f799c18f00f7f3d60e279
Source-Link: https://github.com/googleapis/synthtool/commit/1f1148d3c7a7a52f0c98077f976bd9b3c948ee2b
Source-Link: https://github.com/googleapis/synthtool/commit/2c8aecedd55b0480fb4e123b6e07fa5b12953862
Source-Link: https://github.com/googleapis/synthtool/commit/3d3e94c4e02370f307a9a200b0c743c3d8d19f29
Source-Link: https://github.com/googleapis/synthtool/commit/c7824ea48ff6d4d42dfae0849aec8a85acd90bd9
Source-Link: https://github.com/googleapis/synthtool/commit/ba9918cd22874245b55734f57470c719b577e591
Source-Link: https://github.com/googleapis/synthtool/commit/b19b401571e77192f8dd38eab5fb2300a0de9324
Source-Link: https://github.com/googleapis/synthtool/commit/6542bd723403513626f61642fc02ddca528409aa
diff --git a/docs/dyn/dataflow_v1b3.projects.html b/docs/dyn/dataflow_v1b3.projects.html
index bb0f93b..af0e6a6 100644
--- a/docs/dyn/dataflow_v1b3.projects.html
+++ b/docs/dyn/dataflow_v1b3.projects.html
@@ -108,7 +108,7 @@
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
- <code><a href="#deleteSnapshots">deleteSnapshots(projectId, snapshotId=None, location=None, x__xgafv=None)</a></code></p>
+ <code><a href="#deleteSnapshots">deleteSnapshots(projectId, location=None, snapshotId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes a snapshot.</p>
<p class="toc_element">
<code><a href="#workerMessages">workerMessages(projectId, body=None, x__xgafv=None)</a></code></p>
@@ -120,13 +120,13 @@
</div>
<div class="method">
- <code class="details" id="deleteSnapshots">deleteSnapshots(projectId, snapshotId=None, location=None, x__xgafv=None)</code>
+ <code class="details" id="deleteSnapshots">deleteSnapshots(projectId, location=None, snapshotId=None, x__xgafv=None)</code>
<pre>Deletes a snapshot.
Args:
projectId: string, The ID of the Cloud Platform project that the snapshot belongs to. (required)
- snapshotId: string, The ID of the snapshot.
location: string, The location that contains this snapshot.
+ snapshotId: string, The ID of the snapshot.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -152,58 +152,58 @@
"location": "A String", # The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains the job.
"workerMessages": [ # The WorkerMessages to send.
{ # WorkerMessage provides information to the backend about a worker.
- "workerMetrics": { # Worker metrics exported from workers. This contains resource utilization metrics accumulated from a variety of sources. For more information, see go/df-resource-signals. # Resource metrics reported by workers.
- "containers": { # Per container information. Key: container name.
- "a_key": # Object with schema name: ResourceUtilizationReport
+ "workerLifecycleEvent": { # A report of an event in a worker's lifecycle. The proto contains one event, because the worker is expected to asynchronously send each message immediately after the event. Due to this asynchrony, messages may arrive out of order (or missing), and it is up to the consumer to interpret. The timestamp of the event is in the enclosing WorkerMessage proto. # Record of worker lifecycle events.
+ "metadata": { # Other stats that can accompany an event. E.g. { "downloaded_bytes" : "123456" }
+ "a_key": "A String",
},
- "memoryInfo": [ # Memory utilization samples.
- { # Information about the memory usage of a worker or a container within a worker.
- "currentLimitBytes": "A String", # Instantenous memory limit in bytes.
- "currentRssBytes": "A String", # Instantenous memory (RSS) size in bytes.
- "timestamp": "A String", # Timestamp of the measurement.
- "totalGbMs": "A String", # Total memory (RSS) usage since start up in GB * ms.
- },
- ],
- "cpuTime": [ # CPU utilization samples.
- { # Modeled after information exposed by /proc/stat.
- "timestamp": "A String", # Timestamp of the measurement.
- "rate": 3.14, # Average CPU utilization rate (% non-idle cpu / second) since previous sample.
- "totalMs": "A String", # Total active CPU time across all cores (ie., non-idle) in milliseconds since start-up.
- },
- ],
+ "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.
+ },
+ "time": "A String", # The timestamp of the worker_message.
+ "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",
},
"workerHealthReport": { # WorkerHealthReport contains information about the health of a worker. The VM should be identified by the labels attached to the WorkerMessage that this health ping belongs to. # The health of a worker.
+ "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.
+ "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.
"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.
},
],
"vmStartupTime": "A String", # The time the VM was booted.
- "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.
"msg": "A String", # A message describing any unusual health reports.
- "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.
+ "vmIsHealthy": True or False, # Whether the VM is currently healthy.
},
- "workerMessageCode": { # A message code is used to report status and error messages to the service. The message codes are intended to be machine readable. The service will take care of translating these into user understandable messages if necessary. Example use cases: 1. Worker processes reporting successful startup. 2. Worker processes reporting specific errors (e.g. package staging failure). # A worker message code.
- "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 GCS objects being downloaded and fields containing errors. In general complex data structures should be avoided. If a worker needs to send a specific and complicated data structure then please consider defining a new proto and adding it to the data oneof in WorkerMessageResponse. Conventions: Parameters should only be used for information that isn't typically passed as a label. hostname and other worker identifiers should almost always be passed as labels since they will be included on most messages.
- "a_key": "", # Properties of the object.
+ "workerMetrics": { # Worker metrics exported from workers. This contains resource utilization metrics accumulated from a variety of sources. For more information, see go/df-resource-signals. # Resource metrics reported by workers.
+ "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.
+ "timestamp": "A String", # Timestamp of the measurement.
+ "totalGbMs": "A String", # Total memory (RSS) usage since start up in GB * ms.
+ "currentLimitBytes": "A String", # Instantenous memory limit in bytes.
+ },
+ ],
+ "containers": { # Per container information. Key: container name.
+ "a_key": # Object with schema name: ResourceUtilizationReport
},
- "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.
- },
- "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",
+ "cpuTime": [ # CPU utilization samples.
+ { # Modeled after information exposed by /proc/stat.
+ "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.
+ "rate": 3.14, # Average CPU utilization rate (% non-idle cpu / second) since previous sample.
+ },
+ ],
},
"workerShutdownNotice": { # Shutdown notification from workers. This is to be sent by the shutdown script of the worker VM so that the backend knows that the VM is being shut down. # Shutdown notice by workers.
"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.
},
- "workerLifecycleEvent": { # A report of an event in a worker's lifecycle. The proto contains one event, because the worker is expected to asynchronously send each message immediately after the event. Due to this asynchrony, messages may arrive out of order (or missing), and it is up to the consumer to interpret. The timestamp of the event is in the enclosing WorkerMessage proto. # Record of worker lifecycle events.
- "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",
+ "workerMessageCode": { # A message code is used to report status and error messages to the service. The message codes are intended to be machine readable. The service will take care of translating these into user understandable messages if necessary. Example use cases: 1. Worker processes reporting successful startup. 2. Worker processes reporting specific errors (e.g. package staging failure). # A worker message code.
+ "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. Examples: 1. For a "HARNESS_STARTED" message parameters might provide the name of the worker and additional data like timing information. 2. For a "GCS_DOWNLOAD_ERROR" parameters might contain fields listing the GCS objects being downloaded and fields containing errors. In general complex data structures should be avoided. If a worker needs to send a specific and complicated data structure then please consider defining a new proto and adding it to the data oneof in WorkerMessageResponse. Conventions: Parameters should only be used for information that isn't typically passed as a label. hostname and other worker identifiers should almost always be passed as labels since they will be included on most messages.
+ "a_key": "", # Properties of the object.
},
- "event": "A String", # The event being reported.
},
- "time": "A String", # The timestamp of the worker_message.
},
],
}
@@ -219,13 +219,13 @@
{ # The response to the worker messages.
"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).
- },
"workerHealthReportResponse": { # WorkerHealthReportResponse contains information returned to the worker in response to a health ping. # The service's response to a worker's health report.
"reportInterval": "A String", # 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.
},
"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>