docs: docs update (#911)
Thank you for opening a Pull Request! Before submitting your PR, there are a few things you can do to make sure it goes smoothly:
- [ ] Make sure to open an issue as a [bug/issue](https://github.com/googleapis/google-api-python-client/issues/new/choose) before writing your code! That way we can discuss the change, evaluate designs, and agree on the general idea
- [ ] Ensure the tests and linter pass
- [ ] Code coverage does not decrease (if any source code was changed)
- [ ] Appropriate docs were updated (if necessary)
Fixes #<issue_number_goes_here> 🦕
diff --git a/docs/dyn/dataflow_v1b3.projects.jobs.messages.html b/docs/dyn/dataflow_v1b3.projects.jobs.messages.html
index 5d9683f..32db446 100644
--- a/docs/dyn/dataflow_v1b3.projects.jobs.messages.html
+++ b/docs/dyn/dataflow_v1b3.projects.jobs.messages.html
@@ -75,14 +75,14 @@
<h1><a href="dataflow_v1b3.html">Dataflow API</a> . <a href="dataflow_v1b3.projects.html">projects</a> . <a href="dataflow_v1b3.projects.jobs.html">jobs</a> . <a href="dataflow_v1b3.projects.jobs.messages.html">messages</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
- <code><a href="#list">list(projectId, jobId, startTime=None, pageSize=None, x__xgafv=None, pageToken=None, location=None, minimumImportance=None, endTime=None)</a></code></p>
+ <code><a href="#list">list(projectId, jobId, startTime=None, pageToken=None, pageSize=None, minimumImportance=None, endTime=None, location=None, x__xgafv=None)</a></code></p>
<p class="firstline">Request the job status.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
- <code class="details" id="list">list(projectId, jobId, startTime=None, pageSize=None, x__xgafv=None, pageToken=None, location=None, minimumImportance=None, endTime=None)</code>
+ <code class="details" id="list">list(projectId, jobId, startTime=None, pageToken=None, pageSize=None, minimumImportance=None, endTime=None, location=None, x__xgafv=None)</code>
<pre>Request the job status.
To request the status of a job, we recommend using
@@ -96,61 +96,61 @@
jobId: string, The job to get messages about. (required)
startTime: string, If specified, return only messages with timestamps >= start_time.
The default is the job creation time (i.e. beginning of messages).
+ pageToken: string, 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.
pageSize: integer, 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.
+ minimumImportance: string, Filter to only get messages with importance >= level
+ endTime: string, Return only messages with timestamps < end_time. The default is now
+(i.e. return up to the latest messages available).
+ location: string, The [regional endpoint]
+(https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that
+contains the job specified by job_id.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
- pageToken: string, 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.
- location: string, The [regional endpoint]
-(https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that
-contains the job specified by job_id.
- minimumImportance: string, Filter to only get messages with importance >= level
- endTime: string, Return only messages with timestamps < end_time. The default is now
-(i.e. return up to the latest messages available).
Returns:
An object of the form:
{ # Response to a request to list job messages.
- "nextPageToken": "A String", # The token to obtain the next page of results if there are more.
- "autoscalingEvents": [ # Autoscaling events in ascending timestamp order.
+ "jobMessages": [ # Messages in ascending timestamp order.
+ { # A particular message pertaining to a Dataflow job.
+ "messageText": "A String", # The text of the message.
+ "messageImportance": "A String", # Importance level of the message.
+ "time": "A String", # The timestamp of the message.
+ "id": "A String", # Deprecated.
+ },
+ ],
+ "nextPageToken": "A String", # The token to obtain the next page of results if there are more.
+ "autoscalingEvents": [ # Autoscaling events in ascending timestamp order.
{ # A structured message reporting an autoscaling decision made by the Dataflow
# service.
- "description": { # A rich message format, including a human readable string, a key for # A message describing why the system decided to adjust the current
+ "currentNumWorkers": "A String", # The current number of workers the job has.
+ "time": "A String", # The time this event was emitted to indicate a new target or current
+ # num_workers value.
+ "description": { # A rich message format, including a human readable string, a key for # 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.
# identifying the message, and structured data associated with the message for
# programmatic consumption.
- "messageKey": "A String", # Identifier for this message type. Used by external systems to
- # internationalize or personalize message.
- "messageText": "A String", # Human-readable version of message.
- "parameters": [ # The structured data associated with this message.
+ "messageText": "A String", # Human-readable version of message.
+ "parameters": [ # The structured data associated with this message.
{ # Structured data associated with this message.
- "value": "", # Value for this parameter.
- "key": "A String", # Key or name for this parameter.
+ "key": "A String", # Key or name for this parameter.
+ "value": "", # Value for this parameter.
},
],
+ "messageKey": "A String", # Identifier for this message type. Used by external systems to
+ # internationalize or personalize message.
},
- "targetNumWorkers": "A String", # The target number of workers the worker pool wants to resize to use.
- "eventType": "A String", # The type of autoscaling event to report.
- "workerPool": "A String", # A short and friendly name for the worker pool this event refers to,
+ "workerPool": "A String", # A short and friendly name for the worker pool this event refers to,
# populated from the value of PoolStageRelation::user_pool_name.
- "time": "A String", # The time this event was emitted to indicate a new target or current
- # num_workers value.
- "currentNumWorkers": "A String", # The current number of workers the job has.
- },
- ],
- "jobMessages": [ # Messages in ascending timestamp order.
- { # A particular message pertaining to a Dataflow job.
- "messageImportance": "A String", # Importance level of the message.
- "messageText": "A String", # The text of the message.
- "id": "A String", # Deprecated.
- "time": "A String", # The timestamp of the message.
+ "targetNumWorkers": "A String", # The target number of workers the worker pool wants to resize to use.
+ "eventType": "A String", # The type of autoscaling event to report.
},
],
}</pre>
@@ -165,7 +165,7 @@
previous_response: The response from the request for the previous page. (required)
Returns:
- A request object that you can call 'execute()' on to request the next
+ A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>