Index: discovery/googleapis_beta/dataflow__v1b3.json |
diff --git a/discovery/googleapis_beta/dataflow__v1b3.json b/discovery/googleapis_beta/dataflow__v1b3.json |
index 464fe7937adb5e4a279181efb5c139f42af8e999..bf7ba219867df865229fcbf24a21f6dc31cf7c85 100644 |
--- a/discovery/googleapis_beta/dataflow__v1b3.json |
+++ b/discovery/googleapis_beta/dataflow__v1b3.json |
@@ -2,6 +2,9 @@ |
"auth": { |
"oauth2": { |
"scopes": { |
+ "https://www.googleapis.com/auth/compute.readonly": { |
+ "description": "View your Google Compute Engine resources" |
+ }, |
"https://www.googleapis.com/auth/compute": { |
"description": "View and manage your Google Compute Engine resources" |
}, |
@@ -30,18 +33,55 @@ |
"ownerDomain": "google.com", |
"ownerName": "Google", |
"parameters": { |
- "fields": { |
- "description": "Selector specifying which fields to include in a partial response.", |
+ "key": { |
+ "description": "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.", |
+ "location": "query", |
+ "type": "string" |
+ }, |
+ "access_token": { |
+ "description": "OAuth access token.", |
+ "location": "query", |
+ "type": "string" |
+ }, |
+ "quotaUser": { |
+ "description": "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.", |
+ "location": "query", |
+ "type": "string" |
+ }, |
+ "pp": { |
+ "default": "true", |
+ "description": "Pretty-print response.", |
+ "location": "query", |
+ "type": "boolean" |
+ }, |
+ "oauth_token": { |
+ "description": "OAuth 2.0 token for the current user.", |
+ "location": "query", |
+ "type": "string" |
+ }, |
+ "bearer_token": { |
+ "description": "OAuth bearer token.", |
+ "location": "query", |
+ "type": "string" |
+ }, |
+ "upload_protocol": { |
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", |
"location": "query", |
"type": "string" |
}, |
+ "prettyPrint": { |
+ "default": "true", |
+ "description": "Returns response with indentations and line breaks.", |
+ "location": "query", |
+ "type": "boolean" |
+ }, |
"uploadType": { |
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", |
"location": "query", |
"type": "string" |
}, |
- "callback": { |
- "description": "JSONP", |
+ "fields": { |
+ "description": "Selector specifying which fields to include in a partial response.", |
"location": "query", |
"type": "string" |
}, |
@@ -58,6 +98,11 @@ |
"location": "query", |
"type": "string" |
}, |
+ "callback": { |
+ "description": "JSONP", |
+ "location": "query", |
+ "type": "string" |
+ }, |
"alt": { |
"default": "json", |
"description": "Data format for response.", |
@@ -73,48 +118,6 @@ |
], |
"location": "query", |
"type": "string" |
- }, |
- "key": { |
- "description": "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.", |
- "location": "query", |
- "type": "string" |
- }, |
- "access_token": { |
- "description": "OAuth access token.", |
- "location": "query", |
- "type": "string" |
- }, |
- "quotaUser": { |
- "description": "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.", |
- "location": "query", |
- "type": "string" |
- }, |
- "pp": { |
- "default": "true", |
- "description": "Pretty-print response.", |
- "location": "query", |
- "type": "boolean" |
- }, |
- "bearer_token": { |
- "description": "OAuth bearer token.", |
- "location": "query", |
- "type": "string" |
- }, |
- "oauth_token": { |
- "description": "OAuth 2.0 token for the current user.", |
- "location": "query", |
- "type": "string" |
- }, |
- "upload_protocol": { |
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", |
- "location": "query", |
- "type": "string" |
- }, |
- "prettyPrint": { |
- "default": "true", |
- "description": "Returns response with indentations and line breaks.", |
- "location": "query", |
- "type": "boolean" |
} |
}, |
"protocol": "rest", |
@@ -146,6 +149,7 @@ |
"scopes": [ |
"https://www.googleapis.com/auth/cloud-platform", |
"https://www.googleapis.com/auth/compute", |
+ "https://www.googleapis.com/auth/compute.readonly", |
"https://www.googleapis.com/auth/userinfo.email" |
] |
} |
@@ -153,10 +157,10 @@ |
"resources": { |
"templates": { |
"methods": { |
- "launch": { |
- "description": "Launch a template.", |
- "httpMethod": "POST", |
- "id": "dataflow.projects.templates.launch", |
+ "get": { |
+ "description": "Get the template associated with a template.", |
+ "httpMethod": "GET", |
+ "id": "dataflow.projects.templates.get", |
"parameterOrder": [ |
"projectId" |
], |
@@ -166,40 +170,41 @@ |
"location": "query", |
"type": "string" |
}, |
- "validateOnly": { |
- "description": "If true, the request is validated but not actually executed.\nDefaults to false.", |
- "location": "query", |
- "type": "boolean" |
- }, |
"projectId": { |
"description": "Required. The ID of the Cloud Platform project that the job belongs to.", |
"location": "path", |
"required": true, |
"type": "string" |
}, |
+ "view": { |
+ "description": "The view to retrieve. Defaults to METADATA_ONLY.", |
+ "enum": [ |
+ "METADATA_ONLY" |
+ ], |
+ "location": "query", |
+ "type": "string" |
+ }, |
"gcsPath": { |
- "description": "Required. A Cloud Storage path to the template from which to create\nthe job.\nMust be valid Cloud Storage URL, beginning with 'gs://'.", |
+ "description": "Required. A Cloud Storage path to the template from which to\ncreate the job.\nMust be a valid Cloud Storage URL, beginning with `gs://`.", |
"location": "query", |
"type": "string" |
} |
}, |
- "path": "v1b3/projects/{projectId}/templates:launch", |
- "request": { |
- "$ref": "LaunchTemplateParameters" |
- }, |
+ "path": "v1b3/projects/{projectId}/templates:get", |
"response": { |
- "$ref": "LaunchTemplateResponse" |
+ "$ref": "GetTemplateResponse" |
}, |
"scopes": [ |
"https://www.googleapis.com/auth/cloud-platform", |
"https://www.googleapis.com/auth/compute", |
+ "https://www.googleapis.com/auth/compute.readonly", |
"https://www.googleapis.com/auth/userinfo.email" |
] |
}, |
- "get": { |
- "description": "Get the template associated with a template.", |
- "httpMethod": "GET", |
- "id": "dataflow.projects.templates.get", |
+ "create": { |
+ "description": "Creates a Cloud Dataflow job from a template.", |
+ "httpMethod": "POST", |
+ "id": "dataflow.projects.templates.create", |
"parameterOrder": [ |
"projectId" |
], |
@@ -209,61 +214,63 @@ |
"location": "path", |
"required": true, |
"type": "string" |
- }, |
- "view": { |
- "description": "The view to retrieve. Defaults to METADATA_ONLY.", |
- "enum": [ |
- "METADATA_ONLY" |
- ], |
- "location": "query", |
- "type": "string" |
- }, |
- "gcsPath": { |
- "description": "Required. A Cloud Storage path to the template from which to\ncreate the job.\nMust be a valid Cloud Storage URL, beginning with `gs://`.", |
- "location": "query", |
- "type": "string" |
- }, |
- "location": { |
- "description": "The location to which to direct the request.", |
- "location": "query", |
- "type": "string" |
} |
}, |
- "path": "v1b3/projects/{projectId}/templates:get", |
+ "path": "v1b3/projects/{projectId}/templates", |
+ "request": { |
+ "$ref": "CreateJobFromTemplateRequest" |
+ }, |
"response": { |
- "$ref": "GetTemplateResponse" |
+ "$ref": "Job" |
}, |
"scopes": [ |
"https://www.googleapis.com/auth/cloud-platform", |
"https://www.googleapis.com/auth/compute", |
+ "https://www.googleapis.com/auth/compute.readonly", |
"https://www.googleapis.com/auth/userinfo.email" |
] |
}, |
- "create": { |
- "description": "Creates a Cloud Dataflow job from a template.", |
+ "launch": { |
+ "description": "Launch a template.", |
"httpMethod": "POST", |
- "id": "dataflow.projects.templates.create", |
+ "id": "dataflow.projects.templates.launch", |
"parameterOrder": [ |
"projectId" |
], |
"parameters": { |
+ "location": { |
+ "description": "The location to which to direct the request.", |
+ "location": "query", |
+ "type": "string" |
+ }, |
+ "validateOnly": { |
+ "description": "If true, the request is validated but not actually executed.\nDefaults to false.", |
+ "location": "query", |
+ "type": "boolean" |
+ }, |
"projectId": { |
"description": "Required. The ID of the Cloud Platform project that the job belongs to.", |
"location": "path", |
"required": true, |
"type": "string" |
+ }, |
+ "gcsPath": { |
+ "description": "Required. A Cloud Storage path to the template from which to create\nthe job.\nMust be valid Cloud Storage URL, beginning with 'gs://'.", |
+ "location": "query", |
+ "type": "string" |
} |
}, |
- "path": "v1b3/projects/{projectId}/templates", |
+ "path": "v1b3/projects/{projectId}/templates:launch", |
"request": { |
- "$ref": "CreateJobFromTemplateRequest" |
+ "$ref": "LaunchTemplateParameters" |
}, |
"response": { |
- "$ref": "Job" |
+ "$ref": "LaunchTemplateResponse" |
}, |
"scopes": [ |
"https://www.googleapis.com/auth/cloud-platform", |
"https://www.googleapis.com/auth/compute", |
+ "https://www.googleapis.com/auth/compute.readonly", |
"https://www.googleapis.com/auth/userinfo.email" |
] |
} |
@@ -280,14 +287,14 @@ |
"location" |
], |
"parameters": { |
- "location": { |
- "description": "The location which contains the job", |
+ "projectId": { |
+ "description": "The project to send the WorkerMessages to.", |
"location": "path", |
"required": true, |
"type": "string" |
}, |
- "projectId": { |
- "description": "The project to send the WorkerMessages to.", |
+ "location": { |
+ "description": "The location which contains the job", |
"location": "path", |
"required": true, |
"type": "string" |
@@ -303,6 +310,7 @@ |
"scopes": [ |
"https://www.googleapis.com/auth/cloud-platform", |
"https://www.googleapis.com/auth/compute", |
+ "https://www.googleapis.com/auth/compute.readonly", |
"https://www.googleapis.com/auth/userinfo.email" |
] |
} |
@@ -319,6 +327,11 @@ |
"location" |
], |
"parameters": { |
+ "gcsPath": { |
+ "description": "Required. A Cloud Storage path to the template from which to create\nthe job.\nMust be valid Cloud Storage URL, beginning with 'gs://'.", |
+ "location": "query", |
+ "type": "string" |
+ }, |
"location": { |
"description": "The location to which to direct the request.", |
"location": "path", |
@@ -335,11 +348,6 @@ |
"location": "path", |
"required": true, |
"type": "string" |
- }, |
- "gcsPath": { |
- "description": "Required. A Cloud Storage path to the template from which to create\nthe job.\nMust be valid Cloud Storage URL, beginning with 'gs://'.", |
- "location": "query", |
- "type": "string" |
} |
}, |
"path": "v1b3/projects/{projectId}/locations/{location}/templates:launch", |
@@ -352,6 +360,7 @@ |
"scopes": [ |
"https://www.googleapis.com/auth/cloud-platform", |
"https://www.googleapis.com/auth/compute", |
+ "https://www.googleapis.com/auth/compute.readonly", |
"https://www.googleapis.com/auth/userinfo.email" |
] |
}, |
@@ -397,6 +406,7 @@ |
"scopes": [ |
"https://www.googleapis.com/auth/cloud-platform", |
"https://www.googleapis.com/auth/compute", |
+ "https://www.googleapis.com/auth/compute.readonly", |
"https://www.googleapis.com/auth/userinfo.email" |
] |
}, |
@@ -432,6 +442,7 @@ |
"scopes": [ |
"https://www.googleapis.com/auth/cloud-platform", |
"https://www.googleapis.com/auth/compute", |
+ "https://www.googleapis.com/auth/compute.readonly", |
"https://www.googleapis.com/auth/userinfo.email" |
] |
} |
@@ -439,51 +450,6 @@ |
}, |
"jobs": { |
"methods": { |
- "getMetrics": { |
- "description": "Request the job status.", |
- "httpMethod": "GET", |
- "id": "dataflow.projects.locations.jobs.getMetrics", |
- "parameterOrder": [ |
- "projectId", |
- "location", |
- "jobId" |
- ], |
- "parameters": { |
- "projectId": { |
- "description": "A project id.", |
- "location": "path", |
- "required": true, |
- "type": "string" |
- }, |
- "jobId": { |
- "description": "The job to get messages for.", |
- "location": "path", |
- "required": true, |
- "type": "string" |
- }, |
- "location": { |
- "description": "The location which contains the job specified by job_id.", |
- "location": "path", |
- "required": true, |
- "type": "string" |
- }, |
- "startTime": { |
- "description": "Return only metric data that has changed since this time.\nDefault is to return all information about all metrics for the job.", |
- "format": "google-datetime", |
- "location": "query", |
- "type": "string" |
- } |
- }, |
- "path": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/metrics", |
- "response": { |
- "$ref": "JobMetrics" |
- }, |
- "scopes": [ |
- "https://www.googleapis.com/auth/cloud-platform", |
- "https://www.googleapis.com/auth/compute", |
- "https://www.googleapis.com/auth/userinfo.email" |
- ] |
- }, |
"get": { |
"description": "Gets the state of the specified Cloud Dataflow job.", |
"httpMethod": "GET", |
@@ -531,6 +497,7 @@ |
"scopes": [ |
"https://www.googleapis.com/auth/cloud-platform", |
"https://www.googleapis.com/auth/compute", |
+ "https://www.googleapis.com/auth/compute.readonly", |
"https://www.googleapis.com/auth/userinfo.email" |
] |
}, |
@@ -543,32 +510,9 @@ |
"location" |
], |
"parameters": { |
- "projectId": { |
- "description": "The project which owns the jobs.", |
- "location": "path", |
- "required": true, |
- "type": "string" |
- }, |
- "filter": { |
- "description": "The kind of filter to use.", |
- "enum": [ |
- "UNKNOWN", |
- "ALL", |
- "TERMINATED", |
- "ACTIVE" |
- ], |
- "location": "query", |
- "type": "string" |
- }, |
- "location": { |
- "description": "The location that contains this job.", |
- "location": "path", |
- "required": true, |
- "type": "string" |
- }, |
- "pageToken": { |
- "description": "Set this to the 'next_page_token' field of a previous response\nto request additional results in a long list.", |
- "location": "query", |
+ "pageToken": { |
+ "description": "Set this to the 'next_page_token' field of a previous response\nto request additional results in a long list.", |
+ "location": "query", |
"type": "string" |
}, |
"pageSize": { |
@@ -587,6 +531,29 @@ |
], |
"location": "query", |
"type": "string" |
+ }, |
+ "projectId": { |
+ "description": "The project which owns the jobs.", |
+ "location": "path", |
+ "required": true, |
+ "type": "string" |
+ }, |
+ "filter": { |
+ "description": "The kind of filter to use.", |
+ "enum": [ |
+ "UNKNOWN", |
+ "ALL", |
+ "TERMINATED", |
+ "ACTIVE" |
+ ], |
+ "location": "query", |
+ "type": "string" |
+ }, |
+ "location": { |
+ "description": "The location that contains this job.", |
+ "location": "path", |
+ "required": true, |
+ "type": "string" |
} |
}, |
"path": "v1b3/projects/{projectId}/locations/{location}/jobs", |
@@ -596,6 +563,7 @@ |
"scopes": [ |
"https://www.googleapis.com/auth/cloud-platform", |
"https://www.googleapis.com/auth/compute", |
+ "https://www.googleapis.com/auth/compute.readonly", |
"https://www.googleapis.com/auth/userinfo.email" |
] |
}, |
@@ -609,12 +577,6 @@ |
"jobId" |
], |
"parameters": { |
- "location": { |
- "description": "The location that contains this job.", |
- "location": "path", |
- "required": true, |
- "type": "string" |
- }, |
"projectId": { |
"description": "The ID of the Cloud Platform project that the job belongs to.", |
"location": "path", |
@@ -626,6 +588,12 @@ |
"location": "path", |
"required": true, |
"type": "string" |
+ }, |
+ "location": { |
+ "description": "The location that contains this job.", |
+ "location": "path", |
+ "required": true, |
+ "type": "string" |
} |
}, |
"path": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}", |
@@ -638,6 +606,7 @@ |
"scopes": [ |
"https://www.googleapis.com/auth/cloud-platform", |
"https://www.googleapis.com/auth/compute", |
+ "https://www.googleapis.com/auth/compute.readonly", |
"https://www.googleapis.com/auth/userinfo.email" |
] |
}, |
@@ -689,6 +658,53 @@ |
"scopes": [ |
"https://www.googleapis.com/auth/cloud-platform", |
"https://www.googleapis.com/auth/compute", |
+ "https://www.googleapis.com/auth/compute.readonly", |
+ "https://www.googleapis.com/auth/userinfo.email" |
+ ] |
+ }, |
+ "getMetrics": { |
+ "description": "Request the job status.", |
+ "httpMethod": "GET", |
+ "id": "dataflow.projects.locations.jobs.getMetrics", |
+ "parameterOrder": [ |
+ "projectId", |
+ "location", |
+ "jobId" |
+ ], |
+ "parameters": { |
+ "location": { |
+ "description": "The location which contains the job specified by job_id.", |
+ "location": "path", |
+ "required": true, |
+ "type": "string" |
+ }, |
+ "startTime": { |
+ "description": "Return only metric data that has changed since this time.\nDefault is to return all information about all metrics for the job.", |
+ "format": "google-datetime", |
+ "location": "query", |
+ "type": "string" |
+ }, |
+ "projectId": { |
+ "description": "A project id.", |
+ "location": "path", |
+ "required": true, |
+ "type": "string" |
+ }, |
+ "jobId": { |
+ "description": "The job to get messages for.", |
+ "location": "path", |
+ "required": true, |
+ "type": "string" |
+ } |
+ }, |
+ "path": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/metrics", |
+ "response": { |
+ "$ref": "JobMetrics" |
+ }, |
+ "scopes": [ |
+ "https://www.googleapis.com/auth/cloud-platform", |
+ "https://www.googleapis.com/auth/compute", |
+ "https://www.googleapis.com/auth/compute.readonly", |
"https://www.googleapis.com/auth/userinfo.email" |
] |
} |
@@ -706,12 +722,6 @@ |
"jobId" |
], |
"parameters": { |
- "location": { |
- "description": "The location which contains the job specified by job_id.", |
- "location": "path", |
- "required": true, |
- "type": "string" |
- }, |
"projectId": { |
"description": "The project id.", |
"location": "path", |
@@ -723,6 +733,12 @@ |
"location": "path", |
"required": true, |
"type": "string" |
+ }, |
+ "location": { |
+ "description": "The location which contains the job specified by job_id.", |
+ "location": "path", |
+ "required": true, |
+ "type": "string" |
} |
}, |
"path": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/debug/getConfig", |
@@ -735,6 +751,7 @@ |
"scopes": [ |
"https://www.googleapis.com/auth/cloud-platform", |
"https://www.googleapis.com/auth/compute", |
+ "https://www.googleapis.com/auth/compute.readonly", |
"https://www.googleapis.com/auth/userinfo.email" |
] |
}, |
@@ -777,6 +794,7 @@ |
"scopes": [ |
"https://www.googleapis.com/auth/cloud-platform", |
"https://www.googleapis.com/auth/compute", |
+ "https://www.googleapis.com/auth/compute.readonly", |
"https://www.googleapis.com/auth/userinfo.email" |
] |
} |
@@ -784,52 +802,53 @@ |
}, |
"workItems": { |
"methods": { |
- "lease": { |
- "description": "Leases a dataflow WorkItem to run.", |
+ "reportStatus": { |
+ "description": "Reports the status of dataflow WorkItems leased by a worker.", |
"httpMethod": "POST", |
- "id": "dataflow.projects.locations.jobs.workItems.lease", |
+ "id": "dataflow.projects.locations.jobs.workItems.reportStatus", |
"parameterOrder": [ |
"projectId", |
"location", |
"jobId" |
], |
"parameters": { |
- "location": { |
- "description": "The location which contains the WorkItem's job.", |
+ "projectId": { |
+ "description": "The project which owns the WorkItem's job.", |
"location": "path", |
"required": true, |
"type": "string" |
}, |
- "projectId": { |
- "description": "Identifies the project this worker belongs to.", |
+ "jobId": { |
+ "description": "The job which the WorkItem is part of.", |
"location": "path", |
"required": true, |
"type": "string" |
}, |
- "jobId": { |
- "description": "Identifies the workflow job this worker belongs to.", |
+ "location": { |
+ "description": "The location which contains the WorkItem's job.", |
"location": "path", |
"required": true, |
"type": "string" |
} |
}, |
- "path": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/workItems:lease", |
+ "path": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/workItems:reportStatus", |
"request": { |
- "$ref": "LeaseWorkItemRequest" |
+ "$ref": "ReportWorkItemStatusRequest" |
}, |
"response": { |
- "$ref": "LeaseWorkItemResponse" |
+ "$ref": "ReportWorkItemStatusResponse" |
}, |
"scopes": [ |
"https://www.googleapis.com/auth/cloud-platform", |
"https://www.googleapis.com/auth/compute", |
+ "https://www.googleapis.com/auth/compute.readonly", |
"https://www.googleapis.com/auth/userinfo.email" |
] |
}, |
- "reportStatus": { |
- "description": "Reports the status of dataflow WorkItems leased by a worker.", |
+ "lease": { |
+ "description": "Leases a dataflow WorkItem to run.", |
"httpMethod": "POST", |
- "id": "dataflow.projects.locations.jobs.workItems.reportStatus", |
+ "id": "dataflow.projects.locations.jobs.workItems.lease", |
"parameterOrder": [ |
"projectId", |
"location", |
@@ -843,28 +862,29 @@ |
"type": "string" |
}, |
"projectId": { |
- "description": "The project which owns the WorkItem's job.", |
+ "description": "Identifies the project this worker belongs to.", |
"location": "path", |
"required": true, |
"type": "string" |
}, |
"jobId": { |
- "description": "The job which the WorkItem is part of.", |
+ "description": "Identifies the workflow job this worker belongs to.", |
"location": "path", |
"required": true, |
"type": "string" |
} |
}, |
- "path": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/workItems:reportStatus", |
+ "path": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/workItems:lease", |
"request": { |
- "$ref": "ReportWorkItemStatusRequest" |
+ "$ref": "LeaseWorkItemRequest" |
}, |
"response": { |
- "$ref": "ReportWorkItemStatusResponse" |
+ "$ref": "LeaseWorkItemResponse" |
}, |
"scopes": [ |
"https://www.googleapis.com/auth/cloud-platform", |
"https://www.googleapis.com/auth/compute", |
+ "https://www.googleapis.com/auth/compute.readonly", |
"https://www.googleapis.com/auth/userinfo.email" |
] |
} |
@@ -882,18 +902,6 @@ |
"jobId" |
], |
"parameters": { |
- "location": { |
- "description": "The location which contains the job specified by job_id.", |
- "location": "path", |
- "required": true, |
- "type": "string" |
- }, |
- "endTime": { |
- "description": "Return only messages with timestamps < end_time. The default is now\n(i.e. return up to the latest messages available).", |
- "format": "google-datetime", |
- "location": "query", |
- "type": "string" |
- }, |
"startTime": { |
"description": "If specified, return only messages with timestamps >= start_time.\nThe default is the job creation time (i.e. beginning of messages).", |
"format": "google-datetime", |
@@ -935,6 +943,18 @@ |
"location": "path", |
"required": true, |
"type": "string" |
+ }, |
+ "endTime": { |
+ "description": "Return only messages with timestamps < end_time. The default is now\n(i.e. return up to the latest messages available).", |
+ "format": "google-datetime", |
+ "location": "query", |
+ "type": "string" |
+ }, |
+ "location": { |
+ "description": "The location which contains the job specified by job_id.", |
+ "location": "path", |
+ "required": true, |
+ "type": "string" |
} |
}, |
"path": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/messages", |
@@ -944,6 +964,7 @@ |
"scopes": [ |
"https://www.googleapis.com/auth/cloud-platform", |
"https://www.googleapis.com/auth/compute", |
+ "https://www.googleapis.com/auth/compute.readonly", |
"https://www.googleapis.com/auth/userinfo.email" |
] |
} |
@@ -955,56 +976,53 @@ |
}, |
"jobs": { |
"methods": { |
- "getMetrics": { |
- "description": "Request the job status.", |
- "httpMethod": "GET", |
- "id": "dataflow.projects.jobs.getMetrics", |
+ "update": { |
+ "description": "Updates the state of an existing Cloud Dataflow job.", |
+ "httpMethod": "PUT", |
+ "id": "dataflow.projects.jobs.update", |
"parameterOrder": [ |
"projectId", |
"jobId" |
], |
"parameters": { |
- "location": { |
- "description": "The location which contains the job specified by job_id.", |
- "location": "query", |
- "type": "string" |
- }, |
- "startTime": { |
- "description": "Return only metric data that has changed since this time.\nDefault is to return all information about all metrics for the job.", |
- "format": "google-datetime", |
- "location": "query", |
- "type": "string" |
- }, |
"projectId": { |
- "description": "A project id.", |
+ "description": "The ID of the Cloud Platform project that the job belongs to.", |
"location": "path", |
"required": true, |
"type": "string" |
}, |
"jobId": { |
- "description": "The job to get messages for.", |
+ "description": "The job ID.", |
"location": "path", |
"required": true, |
"type": "string" |
+ }, |
+ "location": { |
+ "description": "The location that contains this job.", |
+ "location": "query", |
+ "type": "string" |
} |
}, |
- "path": "v1b3/projects/{projectId}/jobs/{jobId}/metrics", |
+ "path": "v1b3/projects/{projectId}/jobs/{jobId}", |
+ "request": { |
+ "$ref": "Job" |
+ }, |
"response": { |
- "$ref": "JobMetrics" |
+ "$ref": "Job" |
}, |
"scopes": [ |
"https://www.googleapis.com/auth/cloud-platform", |
"https://www.googleapis.com/auth/compute", |
+ "https://www.googleapis.com/auth/compute.readonly", |
"https://www.googleapis.com/auth/userinfo.email" |
] |
}, |
- "get": { |
- "description": "Gets the state of the specified Cloud Dataflow job.", |
- "httpMethod": "GET", |
- "id": "dataflow.projects.jobs.get", |
+ "create": { |
+ "description": "Creates a Cloud Dataflow job.", |
+ "httpMethod": "POST", |
+ "id": "dataflow.projects.jobs.create", |
"parameterOrder": [ |
- "projectId", |
- "jobId" |
+ "projectId" |
], |
"parameters": { |
"projectId": { |
@@ -1013,12 +1031,6 @@ |
"required": true, |
"type": "string" |
}, |
- "jobId": { |
- "description": "The job ID.", |
- "location": "path", |
- "required": true, |
- "type": "string" |
- }, |
"view": { |
"description": "The level of information requested in response.", |
"enum": [ |
@@ -1034,95 +1046,80 @@ |
"description": "The location that contains this job.", |
"location": "query", |
"type": "string" |
+ }, |
+ "replaceJobId": { |
+ "description": "Deprecated. This field is now in the Job message.", |
+ "location": "query", |
+ "type": "string" |
} |
}, |
- "path": "v1b3/projects/{projectId}/jobs/{jobId}", |
+ "path": "v1b3/projects/{projectId}/jobs", |
+ "request": { |
+ "$ref": "Job" |
+ }, |
"response": { |
"$ref": "Job" |
}, |
"scopes": [ |
"https://www.googleapis.com/auth/cloud-platform", |
"https://www.googleapis.com/auth/compute", |
+ "https://www.googleapis.com/auth/compute.readonly", |
"https://www.googleapis.com/auth/userinfo.email" |
] |
}, |
- "list": { |
- "description": "List the jobs of a project.", |
+ "getMetrics": { |
+ "description": "Request the job status.", |
"httpMethod": "GET", |
- "id": "dataflow.projects.jobs.list", |
+ "id": "dataflow.projects.jobs.getMetrics", |
"parameterOrder": [ |
- "projectId" |
+ "projectId", |
+ "jobId" |
], |
"parameters": { |
- "view": { |
- "description": "Level of information requested in response. Default is `JOB_VIEW_SUMMARY`.", |
- "enum": [ |
- "JOB_VIEW_UNKNOWN", |
- "JOB_VIEW_SUMMARY", |
- "JOB_VIEW_ALL", |
- "JOB_VIEW_DESCRIPTION" |
- ], |
- "location": "query", |
- "type": "string" |
+ "startTime": { |
+ "description": "Return only metric data that has changed since this time.\nDefault is to return all information about all metrics for the job.", |
+ "format": "google-datetime", |
+ "location": "query", |
+ "type": "string" |
}, |
"projectId": { |
- "description": "The project which owns the jobs.", |
+ "description": "A project id.", |
"location": "path", |
"required": true, |
"type": "string" |
}, |
- "filter": { |
- "description": "The kind of filter to use.", |
- "enum": [ |
- "UNKNOWN", |
- "ALL", |
- "TERMINATED", |
- "ACTIVE" |
- ], |
- "location": "query", |
+ "jobId": { |
+ "description": "The job to get messages for.", |
+ "location": "path", |
+ "required": true, |
"type": "string" |
}, |
"location": { |
- "description": "The location that contains this job.", |
- "location": "query", |
- "type": "string" |
- }, |
- "pageToken": { |
- "description": "Set this to the 'next_page_token' field of a previous response\nto request additional results in a long list.", |
+ "description": "The location which contains the job specified by job_id.", |
"location": "query", |
"type": "string" |
- }, |
- "pageSize": { |
- "description": "If there are many jobs, limit response to at most this many.\nThe actual number of jobs returned will be the lesser of max_responses\nand an unspecified server-defined limit.", |
- "format": "int32", |
- "location": "query", |
- "type": "integer" |
} |
}, |
- "path": "v1b3/projects/{projectId}/jobs", |
+ "path": "v1b3/projects/{projectId}/jobs/{jobId}/metrics", |
"response": { |
- "$ref": "ListJobsResponse" |
+ "$ref": "JobMetrics" |
}, |
"scopes": [ |
"https://www.googleapis.com/auth/cloud-platform", |
"https://www.googleapis.com/auth/compute", |
+ "https://www.googleapis.com/auth/compute.readonly", |
"https://www.googleapis.com/auth/userinfo.email" |
] |
}, |
- "update": { |
- "description": "Updates the state of an existing Cloud Dataflow job.", |
- "httpMethod": "PUT", |
- "id": "dataflow.projects.jobs.update", |
+ "get": { |
+ "description": "Gets the state of the specified Cloud Dataflow job.", |
+ "httpMethod": "GET", |
+ "id": "dataflow.projects.jobs.get", |
"parameterOrder": [ |
"projectId", |
"jobId" |
], |
"parameters": { |
- "location": { |
- "description": "The location that contains this job.", |
- "location": "query", |
- "type": "string" |
- }, |
"projectId": { |
"description": "The ID of the Cloud Platform project that the job belongs to.", |
"location": "path", |
@@ -1134,37 +1131,61 @@ |
"location": "path", |
"required": true, |
"type": "string" |
+ }, |
+ "view": { |
+ "description": "The level of information requested in response.", |
+ "enum": [ |
+ "JOB_VIEW_UNKNOWN", |
+ "JOB_VIEW_SUMMARY", |
+ "JOB_VIEW_ALL", |
+ "JOB_VIEW_DESCRIPTION" |
+ ], |
+ "location": "query", |
+ "type": "string" |
+ }, |
+ "location": { |
+ "description": "The location that contains this job.", |
+ "location": "query", |
+ "type": "string" |
} |
}, |
"path": "v1b3/projects/{projectId}/jobs/{jobId}", |
- "request": { |
- "$ref": "Job" |
- }, |
"response": { |
"$ref": "Job" |
}, |
"scopes": [ |
"https://www.googleapis.com/auth/cloud-platform", |
"https://www.googleapis.com/auth/compute", |
+ "https://www.googleapis.com/auth/compute.readonly", |
"https://www.googleapis.com/auth/userinfo.email" |
] |
}, |
- "create": { |
- "description": "Creates a Cloud Dataflow job.", |
- "httpMethod": "POST", |
- "id": "dataflow.projects.jobs.create", |
+ "list": { |
+ "description": "List the jobs of a project.", |
+ "httpMethod": "GET", |
+ "id": "dataflow.projects.jobs.list", |
"parameterOrder": [ |
"projectId" |
], |
"parameters": { |
- "projectId": { |
- "description": "The ID of the Cloud Platform project that the job belongs to.", |
- "location": "path", |
- "required": true, |
+ "location": { |
+ "description": "The location that contains this job.", |
+ "location": "query", |
+ "type": "string" |
+ }, |
+ "pageToken": { |
+ "description": "Set this to the 'next_page_token' field of a previous response\nto request additional results in a long list.", |
+ "location": "query", |
"type": "string" |
}, |
+ "pageSize": { |
+ "description": "If there are many jobs, limit response to at most this many.\nThe actual number of jobs returned will be the lesser of max_responses\nand an unspecified server-defined limit.", |
+ "format": "int32", |
+ "location": "query", |
+ "type": "integer" |
+ }, |
"view": { |
- "description": "The level of information requested in response.", |
+ "description": "Level of information requested in response. Default is `JOB_VIEW_SUMMARY`.", |
"enum": [ |
"JOB_VIEW_UNKNOWN", |
"JOB_VIEW_SUMMARY", |
@@ -1174,27 +1195,32 @@ |
"location": "query", |
"type": "string" |
}, |
- "location": { |
- "description": "The location that contains this job.", |
- "location": "query", |
+ "projectId": { |
+ "description": "The project which owns the jobs.", |
+ "location": "path", |
+ "required": true, |
"type": "string" |
}, |
- "replaceJobId": { |
- "description": "Deprecated. This field is now in the Job message.", |
+ "filter": { |
+ "description": "The kind of filter to use.", |
+ "enum": [ |
+ "UNKNOWN", |
+ "ALL", |
+ "TERMINATED", |
+ "ACTIVE" |
+ ], |
"location": "query", |
"type": "string" |
} |
}, |
"path": "v1b3/projects/{projectId}/jobs", |
- "request": { |
- "$ref": "Job" |
- }, |
"response": { |
- "$ref": "Job" |
+ "$ref": "ListJobsResponse" |
}, |
"scopes": [ |
"https://www.googleapis.com/auth/cloud-platform", |
"https://www.googleapis.com/auth/compute", |
+ "https://www.googleapis.com/auth/compute.readonly", |
"https://www.googleapis.com/auth/userinfo.email" |
] |
} |
@@ -1234,6 +1260,7 @@ |
"scopes": [ |
"https://www.googleapis.com/auth/cloud-platform", |
"https://www.googleapis.com/auth/compute", |
+ "https://www.googleapis.com/auth/compute.readonly", |
"https://www.googleapis.com/auth/userinfo.email" |
] |
}, |
@@ -1269,6 +1296,7 @@ |
"scopes": [ |
"https://www.googleapis.com/auth/cloud-platform", |
"https://www.googleapis.com/auth/compute", |
+ "https://www.googleapis.com/auth/compute.readonly", |
"https://www.googleapis.com/auth/userinfo.email" |
] |
} |
@@ -1308,6 +1336,7 @@ |
"scopes": [ |
"https://www.googleapis.com/auth/cloud-platform", |
"https://www.googleapis.com/auth/compute", |
+ "https://www.googleapis.com/auth/compute.readonly", |
"https://www.googleapis.com/auth/userinfo.email" |
] |
}, |
@@ -1343,6 +1372,7 @@ |
"scopes": [ |
"https://www.googleapis.com/auth/cloud-platform", |
"https://www.googleapis.com/auth/compute", |
+ "https://www.googleapis.com/auth/compute.readonly", |
"https://www.googleapis.com/auth/userinfo.email" |
] |
} |
@@ -1359,6 +1389,12 @@ |
"jobId" |
], |
"parameters": { |
+ "pageSize": { |
+ "description": "If specified, determines the maximum number of messages to\nreturn. If unspecified, the service may choose an appropriate\ndefault, or may return an arbitrarily large number of results.", |
+ "format": "int32", |
+ "location": "query", |
+ "type": "integer" |
+ }, |
"minimumImportance": { |
"description": "Filter to only get messages with importance >= level", |
"enum": [ |
@@ -1372,22 +1408,16 @@ |
"location": "query", |
"type": "string" |
}, |
- "projectId": { |
- "description": "A project id.", |
- "location": "path", |
- "required": true, |
- "type": "string" |
- }, |
"jobId": { |
"description": "The job to get messages about.", |
"location": "path", |
"required": true, |
"type": "string" |
}, |
- "endTime": { |
- "description": "Return only messages with timestamps < end_time. The default is now\n(i.e. return up to the latest messages available).", |
- "format": "google-datetime", |
- "location": "query", |
+ "projectId": { |
+ "description": "A project id.", |
+ "location": "path", |
+ "required": true, |
"type": "string" |
}, |
"location": { |
@@ -1395,8 +1425,9 @@ |
"location": "query", |
"type": "string" |
}, |
- "pageToken": { |
- "description": "If supplied, this should be the value of next_page_token returned\nby an earlier call. This will cause the next page of results to\nbe returned.", |
+ "endTime": { |
+ "description": "Return only messages with timestamps < end_time. The default is now\n(i.e. return up to the latest messages available).", |
+ "format": "google-datetime", |
"location": "query", |
"type": "string" |
}, |
@@ -1406,11 +1437,10 @@ |
"location": "query", |
"type": "string" |
}, |
- "pageSize": { |
- "description": "If specified, determines the maximum number of messages to\nreturn. If unspecified, the service may choose an appropriate\ndefault, or may return an arbitrarily large number of results.", |
- "format": "int32", |
+ "pageToken": { |
+ "description": "If supplied, this should be the value of next_page_token returned\nby an earlier call. This will cause the next page of results to\nbe returned.", |
"location": "query", |
- "type": "integer" |
+ "type": "string" |
} |
}, |
"path": "v1b3/projects/{projectId}/jobs/{jobId}/messages", |
@@ -1420,6 +1450,7 @@ |
"scopes": [ |
"https://www.googleapis.com/auth/cloud-platform", |
"https://www.googleapis.com/auth/compute", |
+ "https://www.googleapis.com/auth/compute.readonly", |
"https://www.googleapis.com/auth/userinfo.email" |
] |
} |
@@ -1430,9 +1461,58 @@ |
} |
} |
}, |
- "revision": "20170520", |
+ "revision": "20170606", |
"rootUrl": "https://dataflow.googleapis.com/", |
"schemas": { |
+ "CustomSourceLocation": { |
+ "description": "Identifies the location of a custom souce.", |
+ "id": "CustomSourceLocation", |
+ "properties": { |
+ "stateful": { |
+ "description": "Whether this source is stateful.", |
+ "type": "boolean" |
+ } |
+ }, |
+ "type": "object" |
+ }, |
+ "MapTask": { |
+ "description": "MapTask consists of an ordered set of instructions, each of which\ndescribes one particular low-level operation for the worker to\nperform in order to accomplish the MapTask's WorkItem.\n\nEach instruction must appear in the list before any instructions which\ndepends on its output.", |
+ "id": "MapTask", |
+ "properties": { |
+ "systemName": { |
+ "description": "System-defined name of this MapTask.\nUnique across the workflow.", |
+ "type": "string" |
+ }, |
+ "stageName": { |
+ "description": "System-defined name of the stage containing this MapTask.\nUnique across the workflow.", |
+ "type": "string" |
+ }, |
+ "instructions": { |
+ "description": "The instructions in the MapTask.", |
+ "items": { |
+ "$ref": "ParallelInstruction" |
+ }, |
+ "type": "array" |
+ } |
+ }, |
+ "type": "object" |
+ }, |
+ "FloatingPointMean": { |
+ "description": "A representation of a floating point mean metric contribution.", |
+ "id": "FloatingPointMean", |
+ "properties": { |
+ "count": { |
+ "$ref": "SplitInt64", |
+ "description": "The number of values being aggregated." |
+ }, |
+ "sum": { |
+ "description": "The sum of all values being aggregated.", |
+ "format": "double", |
+ "type": "number" |
+ } |
+ }, |
+ "type": "object" |
+ }, |
"ReportWorkItemStatusResponse": { |
"description": "Response from a request to report the status of WorkItems.", |
"id": "ReportWorkItemStatusResponse", |
@@ -1451,6 +1531,18 @@ |
"description": "An output of an instruction.", |
"id": "InstructionOutput", |
"properties": { |
+ "systemName": { |
+ "description": "System-defined name of this output.\nUnique across the workflow.", |
+ "type": "string" |
+ }, |
+ "onlyCountKeyBytes": { |
+ "description": "For system-generated byte and mean byte metrics, certain instructions\nshould only report the key size.", |
+ "type": "boolean" |
+ }, |
+ "onlyCountValueBytes": { |
+ "description": "For system-generated byte and mean byte metrics, certain instructions\nshould only report the value size.", |
+ "type": "boolean" |
+ }, |
"codec": { |
"additionalProperties": { |
"description": "Properties of the object.", |
@@ -1466,18 +1558,6 @@ |
"originalName": { |
"description": "System-defined name for this output in the original workflow graph.\nOutputs that do not contribute to an original instruction do not set this.", |
"type": "string" |
- }, |
- "systemName": { |
- "description": "System-defined name of this output.\nUnique across the workflow.", |
- "type": "string" |
- }, |
- "onlyCountKeyBytes": { |
- "description": "For system-generated byte and mean byte metrics, certain instructions\nshould only report the key size.", |
- "type": "boolean" |
- }, |
- "onlyCountValueBytes": { |
- "description": "For system-generated byte and mean byte metrics, certain instructions\nshould only report the value size.", |
- "type": "boolean" |
} |
}, |
"type": "object" |
@@ -1486,14 +1566,6 @@ |
"description": "A request to create a Cloud Dataflow job from a template.", |
"id": "CreateJobFromTemplateRequest", |
"properties": { |
- "jobName": { |
- "description": "Required. The job name to use for the created job.", |
- "type": "string" |
- }, |
- "gcsPath": { |
- "description": "Required. A Cloud Storage path to the template from which to\ncreate the job.\nMust be a valid Cloud Storage URL, beginning with `gs://`.", |
- "type": "string" |
- }, |
"environment": { |
"$ref": "RuntimeEnvironment", |
"description": "The runtime environment for the job." |
@@ -1508,6 +1580,14 @@ |
}, |
"description": "The runtime parameters to pass to the job.", |
"type": "object" |
+ }, |
+ "jobName": { |
+ "description": "Required. The job name to use for the created job.", |
+ "type": "string" |
+ }, |
+ "gcsPath": { |
+ "description": "Required. A Cloud Storage path to the template from which to\ncreate the job.\nMust be a valid Cloud Storage URL, beginning with `gs://`.", |
+ "type": "string" |
} |
}, |
"type": "object" |
@@ -1531,6 +1611,13 @@ |
"description": "Response to a request to list Cloud Dataflow jobs. This may be a partial\nresponse, depending on the page size in the ListJobsRequest.", |
"id": "ListJobsResponse", |
"properties": { |
+ "jobs": { |
+ "description": "A subset of the requested job information.", |
+ "items": { |
+ "$ref": "Job" |
+ }, |
+ "type": "array" |
+ }, |
"nextPageToken": { |
"description": "Set if there may be more results than fit in this response.", |
"type": "string" |
@@ -1541,13 +1628,6 @@ |
"$ref": "FailedLocation" |
}, |
"type": "array" |
- }, |
- "jobs": { |
- "description": "A subset of the requested job information.", |
- "items": { |
- "$ref": "Job" |
- }, |
- "type": "array" |
} |
}, |
"type": "object" |
@@ -1556,24 +1636,6 @@ |
"description": "All configuration data for a particular Computation.", |
"id": "ComputationTopology", |
"properties": { |
- "stateFamilies": { |
- "description": "The state family values.", |
- "items": { |
- "$ref": "StateFamilyConfig" |
- }, |
- "type": "array" |
- }, |
- "outputs": { |
- "description": "The outputs from the computation.", |
- "items": { |
- "$ref": "StreamLocation" |
- }, |
- "type": "array" |
- }, |
- "systemStageName": { |
- "description": "The system stage name.", |
- "type": "string" |
- }, |
"computationId": { |
"description": "The ID of the computation.", |
"type": "string" |
@@ -1591,6 +1653,24 @@ |
"$ref": "KeyRangeLocation" |
}, |
"type": "array" |
+ }, |
+ "stateFamilies": { |
+ "description": "The state family values.", |
+ "items": { |
+ "$ref": "StateFamilyConfig" |
+ }, |
+ "type": "array" |
+ }, |
+ "outputs": { |
+ "description": "The outputs from the computation.", |
+ "items": { |
+ "$ref": "StreamLocation" |
+ }, |
+ "type": "array" |
+ }, |
+ "systemStageName": { |
+ "description": "The system stage name.", |
+ "type": "string" |
} |
}, |
"type": "object" |
@@ -1599,15 +1679,15 @@ |
"description": "The environment values to set at runtime.", |
"id": "RuntimeEnvironment", |
"properties": { |
+ "zone": { |
+ "description": "The Compute Engine [availability\nzone](https://cloud.google.com/compute/docs/regions-zones/regions-zones)\nfor launching worker instances to run your pipeline.", |
+ "type": "string" |
+ }, |
"maxWorkers": { |
"description": "The maximum number of Google Compute Engine instances to be made\navailable to your pipeline during execution, from 1 to 1000.", |
"format": "int32", |
"type": "integer" |
}, |
- "bypassTempDirValidation": { |
- "description": "Whether to bypass the safety checks for the job's temporary directory.\nUse with caution.", |
- "type": "boolean" |
- }, |
"serviceAccountEmail": { |
"description": "The email address of the service account to run the job as.", |
"type": "string" |
@@ -1616,12 +1696,23 @@ |
"description": "The Cloud Storage path to use for temporary files.\nMust be a valid Cloud Storage URL, beginning with `gs://`.", |
"type": "string" |
}, |
+ "bypassTempDirValidation": { |
+ "description": "Whether to bypass the safety checks for the job's temporary directory.\nUse with caution.", |
+ "type": "boolean" |
+ }, |
"machineType": { |
"description": "The machine type to use for the job. Defaults to the value from the\ntemplate if not specified.", |
"type": "string" |
- }, |
- "zone": { |
- "description": "The Compute Engine [availability\nzone](https://cloud.google.com/compute/docs/regions-zones/regions-zones)\nfor launching worker instances to run your pipeline.", |
+ } |
+ }, |
+ "type": "object" |
+ }, |
+ "MountedDataDisk": { |
+ "description": "Describes mounted data disk.", |
+ "id": "MountedDataDisk", |
+ "properties": { |
+ "dataDisk": { |
+ "description": "The name of the data disk.\nThis name is local to the Google Cloud Platform project and uniquely\nidentifies the disk within that project, for example\n\"myproject-1014-104817-4c2-harness-0-disk-1\".", |
"type": "string" |
} |
}, |
@@ -1631,23 +1722,12 @@ |
"description": "Identifies the location of a streaming side input.", |
"id": "StreamingSideInputLocation", |
"properties": { |
- "stateFamily": { |
- "description": "Identifies the state family where this side input is stored.", |
- "type": "string" |
- }, |
"tag": { |
"description": "Identifies the particular side input within the streaming Dataflow job.", |
"type": "string" |
- } |
- }, |
- "type": "object" |
- }, |
- "MountedDataDisk": { |
- "description": "Describes mounted data disk.", |
- "id": "MountedDataDisk", |
- "properties": { |
- "dataDisk": { |
- "description": "The name of the data disk.\nThis name is local to the Google Cloud Platform project and uniquely\nidentifies the disk within that project, for example\n\"myproject-1014-104817-4c2-harness-0-disk-1\".", |
+ }, |
+ "stateFamily": { |
+ "description": "Identifies the state family where this side input is stored.", |
"type": "string" |
} |
}, |
@@ -1664,52 +1744,67 @@ |
}, |
"type": "object" |
}, |
- "DerivedSource": { |
- "description": "Specification of one of the bundles produced as a result of splitting\na Source (e.g. when executing a SourceSplitRequest, or when\nsplitting an active task using WorkItemStatus.dynamic_source_split),\nrelative to the source being split.", |
- "id": "DerivedSource", |
+ "Job": { |
+ "description": "Defines a job to be run by the Cloud Dataflow service.", |
+ "id": "Job", |
"properties": { |
- "source": { |
- "$ref": "Source", |
- "description": "Specification of the source." |
+ "currentStateTime": { |
+ "description": "The timestamp associated with the current state.", |
+ "format": "google-datetime", |
+ "type": "string" |
}, |
- "derivationMode": { |
- "description": "What source to base the produced source on (if any).", |
+ "transformNameMapping": { |
+ "additionalProperties": { |
+ "type": "string" |
+ }, |
+ "description": "The map of transform name prefixes of the job to be replaced to the\ncorresponding name prefixes of the new job.", |
+ "type": "object" |
+ }, |
+ "createTime": { |
+ "description": "The timestamp when the job was initially created. Immutable and set by the\nCloud Dataflow service.", |
+ "format": "google-datetime", |
+ "type": "string" |
+ }, |
+ "environment": { |
+ "$ref": "Environment", |
+ "description": "The environment for the job." |
+ }, |
+ "labels": { |
+ "additionalProperties": { |
+ "type": "string" |
+ }, |
+ "description": "User-defined labels for this job.\n\nThe labels map can contain no more than 64 entries. Entries of the labels\nmap are UTF8 strings that comply with the following restrictions:\n\n* Keys must conform to regexp: \\p{Ll}\\p{Lo}{0,62}\n* Values must conform to regexp: [\\p{Ll}\\p{Lo}\\p{N}_-]{0,63}\n* Both keys and values are additionally constrained to be <= 128 bytes in\nsize.", |
+ "type": "object" |
+ }, |
+ "stageStates": { |
+ "description": "This field may be mutated by the Cloud Dataflow service;\ncallers cannot mutate it.", |
+ "items": { |
+ "$ref": "ExecutionStageState" |
+ }, |
+ "type": "array" |
+ }, |
+ "projectId": { |
+ "description": "The ID of the Cloud Platform project that the job belongs to.", |
+ "type": "string" |
+ }, |
+ "type": { |
+ "description": "The type of Cloud Dataflow job.", |
"enum": [ |
- "SOURCE_DERIVATION_MODE_UNKNOWN", |
- "SOURCE_DERIVATION_MODE_INDEPENDENT", |
- "SOURCE_DERIVATION_MODE_CHILD_OF_CURRENT", |
- "SOURCE_DERIVATION_MODE_SIBLING_OF_CURRENT" |
+ "JOB_TYPE_UNKNOWN", |
+ "JOB_TYPE_BATCH", |
+ "JOB_TYPE_STREAMING" |
], |
"enumDescriptions": [ |
- "The source derivation is unknown, or unspecified.", |
- "Produce a completely independent Source with no base.", |
- "Produce a Source based on the Source being split.", |
- "Produce a Source based on the base of the Source being split." |
+ "The type of the job is unspecified, or unknown.", |
+ "A batch job with a well-defined end point: data is read, data is\nprocessed, data is written, and the job is done.", |
+ "A continuously streaming job with no end: data is read,\nprocessed, and written continuously." |
], |
"type": "string" |
- } |
- }, |
- "type": "object" |
- }, |
- "DynamicSourceSplit": { |
- "description": "When a task splits using WorkItemStatus.dynamic_source_split, this\nmessage describes the two parts of the split relative to the\ndescription of the current task's input.", |
- "id": "DynamicSourceSplit", |
- "properties": { |
- "primary": { |
- "$ref": "DerivedSource", |
- "description": "Primary part (continued to be processed by worker).\nSpecified relative to the previously-current source.\nBecomes current." |
}, |
- "residual": { |
- "$ref": "DerivedSource", |
- "description": "Residual part (returned to the pool of work).\nSpecified relative to the previously-current source." |
- } |
- }, |
- "type": "object" |
- }, |
- "Job": { |
- "description": "Defines a job to be run by the Cloud Dataflow service.", |
- "id": "Job", |
- "properties": { |
+ "pipelineDescription": { |
+ "$ref": "PipelineDescription", |
+ "description": "Preliminary field: The format of this data may change at any time.\nA description of the user pipeline and stages through which it is executed.\nCreated by Cloud Dataflow service. Only retrieved with\nJOB_VIEW_DESCRIPTION or JOB_VIEW_ALL." |
+ }, |
"replaceJobId": { |
"description": "If this job is an update of an existing job, this field is the job ID\nof the job it replaced.\n\nWhen sending a `CreateJobRequest`, you can update a job by specifying it\nhere. The job named here is stopped, and its intermediate state is\ntransferred to this job.", |
"type": "string" |
@@ -1759,6 +1854,10 @@ |
"description": "The user-specified Cloud Dataflow job name.\n\nOnly one Job with a given name may exist in a project at any\ngiven time. If a caller attempts to create a Job with the same\nname as an already-existing Job, the attempt returns the\nexisting Job.\n\nThe name must match the regular expression\n`[a-z]([-a-z0-9]{0,38}[a-z0-9])?`", |
"type": "string" |
}, |
+ "replacedByJobId": { |
+ "description": "If another job is an update of this job (and thus, this job is in\n`JOB_STATE_UPDATED`), this field contains the ID of that job.", |
+ "type": "string" |
+ }, |
"steps": { |
"description": "The top-level steps that constitute the entire job.", |
"items": { |
@@ -1766,18 +1865,14 @@ |
}, |
"type": "array" |
}, |
- "replacedByJobId": { |
- "description": "If another job is an update of this job (and thus, this job is in\n`JOB_STATE_UPDATED`), this field contains the ID of that job.", |
- "type": "string" |
+ "executionInfo": { |
+ "$ref": "JobExecutionInfo", |
+ "description": "Deprecated." |
}, |
"id": { |
"description": "The unique ID of this job.\n\nThis field is set by the Cloud Dataflow service when the Job is\ncreated, and is immutable for the life of the job.", |
"type": "string" |
}, |
- "executionInfo": { |
- "$ref": "JobExecutionInfo", |
- "description": "Deprecated." |
- }, |
"currentState": { |
"description": "The current state of the job.\n\nJobs are created in the `JOB_STATE_STOPPED` state unless otherwise\nspecified.\n\nA job in the `JOB_STATE_RUNNING` state may asynchronously enter a\nterminal state. After a job has reached a terminal state, no\nfurther state updates may be made.\n\nThis field may be mutated by the Cloud Dataflow service;\ncallers cannot mutate it.", |
"enum": [ |
@@ -1811,63 +1906,48 @@ |
"location": { |
"description": "The location that contains this job.", |
"type": "string" |
+ } |
+ }, |
+ "type": "object" |
+ }, |
+ "DynamicSourceSplit": { |
+ "description": "When a task splits using WorkItemStatus.dynamic_source_split, this\nmessage describes the two parts of the split relative to the\ndescription of the current task's input.", |
+ "id": "DynamicSourceSplit", |
+ "properties": { |
+ "primary": { |
+ "$ref": "DerivedSource", |
+ "description": "Primary part (continued to be processed by worker).\nSpecified relative to the previously-current source.\nBecomes current." |
}, |
- "currentStateTime": { |
- "description": "The timestamp associated with the current state.", |
- "format": "google-datetime", |
- "type": "string" |
- }, |
- "transformNameMapping": { |
- "additionalProperties": { |
- "type": "string" |
- }, |
- "description": "The map of transform name prefixes of the job to be replaced to the\ncorresponding name prefixes of the new job.", |
- "type": "object" |
- }, |
- "environment": { |
- "$ref": "Environment", |
- "description": "The environment for the job." |
- }, |
- "createTime": { |
- "description": "The timestamp when the job was initially created. Immutable and set by the\nCloud Dataflow service.", |
- "format": "google-datetime", |
- "type": "string" |
- }, |
- "labels": { |
- "additionalProperties": { |
- "type": "string" |
- }, |
- "description": "User-defined labels for this job.\n\nThe labels map can contain no more than 64 entries. Entries of the labels\nmap are UTF8 strings that comply with the following restrictions:\n\n* Keys must conform to regexp: \\p{Ll}\\p{Lo}{0,62}\n* Values must conform to regexp: [\\p{Ll}\\p{Lo}\\p{N}_-]{0,63}\n* Both keys and values are additionally constrained to be <= 128 bytes in\nsize.", |
- "type": "object" |
- }, |
- "stageStates": { |
- "description": "This field may be mutated by the Cloud Dataflow service;\ncallers cannot mutate it.", |
- "items": { |
- "$ref": "ExecutionStageState" |
- }, |
- "type": "array" |
- }, |
- "projectId": { |
- "description": "The ID of the Cloud Platform project that the job belongs to.", |
- "type": "string" |
- }, |
- "type": { |
- "description": "The type of Cloud Dataflow job.", |
+ "residual": { |
+ "$ref": "DerivedSource", |
+ "description": "Residual part (returned to the pool of work).\nSpecified relative to the previously-current source." |
+ } |
+ }, |
+ "type": "object" |
+ }, |
+ "DerivedSource": { |
+ "description": "Specification of one of the bundles produced as a result of splitting\na Source (e.g. when executing a SourceSplitRequest, or when\nsplitting an active task using WorkItemStatus.dynamic_source_split),\nrelative to the source being split.", |
+ "id": "DerivedSource", |
+ "properties": { |
+ "derivationMode": { |
+ "description": "What source to base the produced source on (if any).", |
"enum": [ |
- "JOB_TYPE_UNKNOWN", |
- "JOB_TYPE_BATCH", |
- "JOB_TYPE_STREAMING" |
+ "SOURCE_DERIVATION_MODE_UNKNOWN", |
+ "SOURCE_DERIVATION_MODE_INDEPENDENT", |
+ "SOURCE_DERIVATION_MODE_CHILD_OF_CURRENT", |
+ "SOURCE_DERIVATION_MODE_SIBLING_OF_CURRENT" |
], |
"enumDescriptions": [ |
- "The type of the job is unspecified, or unknown.", |
- "A batch job with a well-defined end point: data is read, data is\nprocessed, data is written, and the job is done.", |
- "A continuously streaming job with no end: data is read,\nprocessed, and written continuously." |
+ "The source derivation is unknown, or unspecified.", |
+ "Produce a completely independent Source with no base.", |
+ "Produce a Source based on the Source being split.", |
+ "Produce a Source based on the base of the Source being split." |
], |
"type": "string" |
}, |
- "pipelineDescription": { |
- "$ref": "PipelineDescription", |
- "description": "Preliminary field: The format of this data may change at any time.\nA description of the user pipeline and stages through which it is executed.\nCreated by Cloud Dataflow service. Only retrieved with\nJOB_VIEW_DESCRIPTION or JOB_VIEW_ALL." |
+ "source": { |
+ "$ref": "Source", |
+ "description": "Specification of the source." |
} |
}, |
"type": "object" |
@@ -1876,13 +1956,13 @@ |
"description": "The result of a SourceOperationRequest, specified in\nReportWorkItemStatusRequest.source_operation when the work item\nis completed.", |
"id": "SourceOperationResponse", |
"properties": { |
- "split": { |
- "$ref": "SourceSplitResponse", |
- "description": "A response to a request to split a source." |
- }, |
"getMetadata": { |
"$ref": "SourceGetMetadataResponse", |
"description": "A response to a request to get metadata about a source." |
+ }, |
+ "split": { |
+ "$ref": "SourceSplitResponse", |
+ "description": "A response to a request to split a source." |
} |
}, |
"type": "object" |
@@ -1919,17 +1999,17 @@ |
"properties": {}, |
"type": "object" |
}, |
- "WriteInstruction": { |
- "description": "An instruction that writes records.\nTakes one input, produces no outputs.", |
- "id": "WriteInstruction", |
+ "CounterStructuredNameAndMetadata": { |
+ "description": "A single message which encapsulates structured name and metadata for a given\ncounter.", |
+ "id": "CounterStructuredNameAndMetadata", |
"properties": { |
- "input": { |
- "$ref": "InstructionInput", |
- "description": "The input." |
+ "name": { |
+ "$ref": "CounterStructuredName", |
+ "description": "Structured name of the counter." |
}, |
- "sink": { |
- "$ref": "Sink", |
- "description": "The sink to write to." |
+ "metadata": { |
+ "$ref": "CounterMetadata", |
+ "description": "Metadata associated with a counter" |
} |
}, |
"type": "object" |
@@ -1950,17 +2030,17 @@ |
}, |
"type": "object" |
}, |
- "CounterStructuredNameAndMetadata": { |
- "description": "A single message which encapsulates structured name and metadata for a given\ncounter.", |
- "id": "CounterStructuredNameAndMetadata", |
+ "WriteInstruction": { |
+ "description": "An instruction that writes records.\nTakes one input, produces no outputs.", |
+ "id": "WriteInstruction", |
"properties": { |
- "name": { |
- "$ref": "CounterStructuredName", |
- "description": "Structured name of the counter." |
+ "sink": { |
+ "$ref": "Sink", |
+ "description": "The sink to write to." |
}, |
- "metadata": { |
- "$ref": "CounterMetadata", |
- "description": "Metadata associated with a counter" |
+ "input": { |
+ "$ref": "InstructionInput", |
+ "description": "The input." |
} |
}, |
"type": "object" |
@@ -1969,16 +2049,16 @@ |
"description": "Describes full or partial data disk assignment information of the computation\nranges.", |
"id": "StreamingComputationRanges", |
"properties": { |
+ "computationId": { |
+ "description": "The ID of the computation.", |
+ "type": "string" |
+ }, |
"rangeAssignments": { |
"description": "Data disk assignments for ranges from this computation.", |
"items": { |
"$ref": "KeyRangeDataDiskAssignment" |
}, |
"type": "array" |
- }, |
- "computationId": { |
- "description": "The ID of the computation.", |
- "type": "string" |
} |
}, |
"type": "object" |
@@ -2013,6 +2093,24 @@ |
"description": "Description of the composing transforms, names/ids, and input/outputs of a\nstage of execution. Some composing transforms and sources may have been\ngenerated by the Dataflow service during execution planning.", |
"id": "ExecutionStageSummary", |
"properties": { |
+ "inputSource": { |
+ "description": "Input sources for this stage.", |
+ "items": { |
+ "$ref": "StageSource" |
+ }, |
+ "type": "array" |
+ }, |
+ "id": { |
+ "description": "Dataflow service generated id for this stage.", |
+ "type": "string" |
+ }, |
+ "componentTransform": { |
+ "description": "Transforms that comprise this execution stage.", |
+ "items": { |
+ "$ref": "ComponentTransform" |
+ }, |
+ "type": "array" |
+ }, |
"componentSource": { |
"description": "Collections produced and consumed by component transforms of this stage.", |
"items": { |
@@ -2046,34 +2144,16 @@ |
], |
"type": "string" |
}, |
- "outputSource": { |
- "description": "Output sources for this stage.", |
- "items": { |
- "$ref": "StageSource" |
- }, |
- "type": "array" |
- }, |
- "name": { |
- "description": "Dataflow service generated name for this stage.", |
- "type": "string" |
- }, |
- "inputSource": { |
- "description": "Input sources for this stage.", |
- "items": { |
- "$ref": "StageSource" |
- }, |
- "type": "array" |
- }, |
- "id": { |
- "description": "Dataflow service generated id for this stage.", |
- "type": "string" |
- }, |
- "componentTransform": { |
- "description": "Transforms that comprise this execution stage.", |
+ "outputSource": { |
+ "description": "Output sources for this stage.", |
"items": { |
- "$ref": "ComponentTransform" |
+ "$ref": "StageSource" |
}, |
"type": "array" |
+ }, |
+ "name": { |
+ "description": "Dataflow service generated name for this stage.", |
+ "type": "string" |
} |
}, |
"type": "object" |
@@ -2100,15 +2180,15 @@ |
"description": "Bucket of values for Distribution's logarithmic histogram.", |
"id": "LogBucket", |
"properties": { |
- "count": { |
- "description": "Number of values in this bucket.", |
- "format": "int64", |
- "type": "string" |
- }, |
"log": { |
"description": "floor(log2(value)); defined to be zero for nonpositive values.\n log(-1) = 0\n log(0) = 0\n log(1) = 0\n log(2) = 1\n log(3) = 1\n log(4) = 2\n log(5) = 2", |
"format": "int32", |
"type": "integer" |
+ }, |
+ "count": { |
+ "description": "Number of values in this bucket.", |
+ "format": "int64", |
+ "type": "string" |
} |
}, |
"type": "object" |
@@ -2117,10 +2197,6 @@ |
"description": "DEPRECATED in favor of DerivedSource.", |
"id": "SourceSplitShard", |
"properties": { |
- "source": { |
- "$ref": "Source", |
- "description": "DEPRECATED" |
- }, |
"derivationMode": { |
"description": "DEPRECATED", |
"enum": [ |
@@ -2136,6 +2212,10 @@ |
"Produce a Source based on the base of the Source being split." |
], |
"type": "string" |
+ }, |
+ "source": { |
+ "$ref": "Source", |
+ "description": "DEPRECATED" |
} |
}, |
"type": "object" |
@@ -2144,11 +2224,6 @@ |
"description": "Modeled after information exposed by /proc/stat.", |
"id": "CPUTime", |
"properties": { |
- "timestamp": { |
- "description": "Timestamp of the measurement.", |
- "format": "google-datetime", |
- "type": "string" |
- }, |
"totalMs": { |
"description": "Total active CPU time across all cores (ie., non-idle) in milliseconds\nsince start-up.", |
"format": "uint64", |
@@ -2158,6 +2233,11 @@ |
"description": "Average CPU utilization rate (% non-idle cpu / second) since previous\nsample.", |
"format": "double", |
"type": "number" |
+ }, |
+ "timestamp": { |
+ "description": "Timestamp of the measurement.", |
+ "format": "google-datetime", |
+ "type": "string" |
} |
}, |
"type": "object" |
@@ -2166,46 +2246,20 @@ |
"description": "Describes the environment in which a Dataflow Job runs.", |
"id": "Environment", |
"properties": { |
- "clusterManagerApiService": { |
- "description": "The type of cluster manager API to use. If unknown or\nunspecified, the service will attempt to choose a reasonable\ndefault. This should be in the form of the API service name,\ne.g. \"compute.googleapis.com\".", |
- "type": "string" |
- }, |
- "tempStoragePrefix": { |
- "description": "The prefix of the resources the system should use for temporary\nstorage. The system will append the suffix \"/temp-{JOBNAME} to\nthis resource prefix, where {JOBNAME} is the value of the\njob_name field. The resulting bucket and object prefix is used\nas the prefix of the resources used to store temporary data\nneeded during the job execution. NOTE: This will override the\nvalue in taskrunner_settings.\nThe supported resource type is:\n\nGoogle Cloud Storage:\n\n storage.googleapis.com/{bucket}/{object}\n bucket.storage.googleapis.com/{object}", |
- "type": "string" |
- }, |
- "workerPools": { |
- "description": "The worker pools. At least one \"harness\" worker pool must be\nspecified in order for the job to have workers.", |
- "items": { |
- "$ref": "WorkerPool" |
- }, |
- "type": "array" |
- }, |
- "dataset": { |
- "description": "The dataset for the current project where various workflow\nrelated tables are stored.\n\nThe supported resource type is:\n\nGoogle BigQuery:\n bigquery.googleapis.com/{dataset}", |
- "type": "string" |
- }, |
- "experiments": { |
- "description": "The list of experiments to enable.", |
- "items": { |
- "type": "string" |
- }, |
- "type": "array" |
- }, |
- "internalExperiments": { |
+ "version": { |
"additionalProperties": { |
- "description": "Properties of the object. Contains field @type with type URL.", |
+ "description": "Properties of the object.", |
"type": "any" |
}, |
- "description": "Experimental settings.", |
+ "description": "A structure describing which components and their versions of the service\nare required in order to run the job.", |
"type": "object" |
}, |
- "version": { |
+ "internalExperiments": { |
"additionalProperties": { |
- "description": "Properties of the object.", |
+ "description": "Properties of the object. Contains field @type with type URL.", |
"type": "any" |
}, |
- "description": "A structure describing which components and their versions of the service\nare required in order to run the job.", |
+ "description": "Experimental settings.", |
"type": "object" |
}, |
"serviceAccountEmail": { |
@@ -2227,6 +2281,32 @@ |
}, |
"description": "A description of the process that generated the request.", |
"type": "object" |
+ }, |
+ "clusterManagerApiService": { |
+ "description": "The type of cluster manager API to use. If unknown or\nunspecified, the service will attempt to choose a reasonable\ndefault. This should be in the form of the API service name,\ne.g. \"compute.googleapis.com\".", |
+ "type": "string" |
+ }, |
+ "tempStoragePrefix": { |
+ "description": "The prefix of the resources the system should use for temporary\nstorage. The system will append the suffix \"/temp-{JOBNAME} to\nthis resource prefix, where {JOBNAME} is the value of the\njob_name field. The resulting bucket and object prefix is used\nas the prefix of the resources used to store temporary data\nneeded during the job execution. NOTE: This will override the\nvalue in taskrunner_settings.\nThe supported resource type is:\n\nGoogle Cloud Storage:\n\n storage.googleapis.com/{bucket}/{object}\n bucket.storage.googleapis.com/{object}", |
+ "type": "string" |
+ }, |
+ "workerPools": { |
+ "description": "The worker pools. At least one \"harness\" worker pool must be\nspecified in order for the job to have workers.", |
+ "items": { |
+ "$ref": "WorkerPool" |
+ }, |
+ "type": "array" |
+ }, |
+ "dataset": { |
+ "description": "The dataset for the current project where various workflow\nrelated tables are stored.\n\nThe supported resource type is:\n\nGoogle BigQuery:\n bigquery.googleapis.com/{dataset}", |
+ "type": "string" |
+ }, |
+ "experiments": { |
+ "description": "The list of experiments to enable.", |
+ "items": { |
+ "type": "string" |
+ }, |
+ "type": "array" |
} |
}, |
"type": "object" |
@@ -2235,13 +2315,6 @@ |
"description": "A task which describes what action should be performed for the specified\nstreaming computation ranges.", |
"id": "StreamingComputationTask", |
"properties": { |
- "dataDisks": { |
- "description": "Describes the set of data disks this task should apply to.", |
- "items": { |
- "$ref": "MountedDataDisk" |
- }, |
- "type": "array" |
- }, |
"taskType": { |
"description": "A type of streaming computation task.", |
"enum": [ |
@@ -2262,6 +2335,13 @@ |
"$ref": "StreamingComputationRanges" |
}, |
"type": "array" |
+ }, |
+ "dataDisks": { |
+ "description": "Describes the set of data disks this task should apply to.", |
+ "items": { |
+ "$ref": "MountedDataDisk" |
+ }, |
+ "type": "array" |
} |
}, |
"type": "object" |
@@ -2304,6 +2384,10 @@ |
"description": "Description of a transform executed as part of an execution stage.", |
"id": "ComponentTransform", |
"properties": { |
+ "userName": { |
+ "description": "Human-readable name for this transform; may be user or system generated.", |
+ "type": "string" |
+ }, |
"originalTransform": { |
"description": "User name for the original user transform with which this transform is\nmost closely associated.", |
"type": "string" |
@@ -2311,10 +2395,6 @@ |
"name": { |
"description": "Dataflow service generated name for this source.", |
"type": "string" |
- }, |
- "userName": { |
- "description": "Human-readable name for this transform; may be user or system generated.", |
- "type": "string" |
} |
}, |
"type": "object" |
@@ -2348,14 +2428,6 @@ |
"description": "Identifies a pubsub location to use for transferring data into or\nout of a streaming Dataflow job.", |
"id": "PubsubLocation", |
"properties": { |
- "topic": { |
- "description": "A pubsub topic, in the form of\n\"pubsub.googleapis.com/topics/<project-id>/<topic-name>\"", |
- "type": "string" |
- }, |
- "timestampLabel": { |
- "description": "If set, contains a pubsub label from which to extract record timestamps.\nIf left empty, record timestamps will be generated upon arrival.", |
- "type": "string" |
- }, |
"subscription": { |
"description": "A pubsub subscription, in the form of\n\"pubsub.googleapis.com/subscriptions/<project-id>/<subscription-name>\"", |
"type": "string" |
@@ -2375,6 +2447,14 @@ |
"idLabel": { |
"description": "If set, contains a pubsub label from which to extract record ids.\nIf left empty, record deduplication will be strictly best effort.", |
"type": "string" |
+ }, |
+ "topic": { |
+ "description": "A pubsub topic, in the form of\n\"pubsub.googleapis.com/topics/<project-id>/<topic-name>\"", |
+ "type": "string" |
+ }, |
+ "timestampLabel": { |
+ "description": "If set, contains a pubsub label from which to extract record timestamps.\nIf left empty, record timestamps will be generated upon arrival.", |
+ "type": "string" |
} |
}, |
"type": "object" |
@@ -2415,6 +2495,15 @@ |
"description": "A particular message pertaining to a Dataflow job.", |
"id": "JobMessage", |
"properties": { |
+ "time": { |
+ "description": "The timestamp of the message.", |
+ "format": "google-datetime", |
+ "type": "string" |
+ }, |
+ "id": { |
+ "description": "Deprecated.", |
+ "type": "string" |
+ }, |
"messageText": { |
"description": "The text of the message.", |
"type": "string" |
@@ -2438,15 +2527,6 @@ |
"The message is at the 'error' level: indicating a condition\npreventing a job from succeeding. Typically, Dataflow pipeline\nrunners display log messages at this level by default, and these\nmessages are displayed by default in the Dataflow monitoring UI." |
], |
"type": "string" |
- }, |
- "time": { |
- "description": "The timestamp of the message.", |
- "format": "google-datetime", |
- "type": "string" |
- }, |
- "id": { |
- "description": "Deprecated.", |
- "type": "string" |
} |
}, |
"type": "object" |
@@ -2455,14 +2535,6 @@ |
"description": "Metadata for a specific parameter.", |
"id": "ParameterMetadata", |
"properties": { |
- "helpText": { |
- "description": "Required. The help text to display for the parameter.", |
- "type": "string" |
- }, |
- "isOptional": { |
- "description": "Optional. Whether the parameter is optional. Defaults to false.", |
- "type": "boolean" |
- }, |
"name": { |
"description": "Required. The name of the parameter.", |
"type": "string" |
@@ -2477,6 +2549,14 @@ |
"label": { |
"description": "Required. The label to display for the parameter.", |
"type": "string" |
+ }, |
+ "helpText": { |
+ "description": "Required. The help text to display for the parameter.", |
+ "type": "string" |
+ }, |
+ "isOptional": { |
+ "description": "Optional. Whether the parameter is optional. Defaults to false.", |
+ "type": "boolean" |
} |
}, |
"type": "object" |
@@ -2518,27 +2598,19 @@ |
}, |
"type": "object" |
}, |
- "MetricShortId": { |
- "description": "The metric short id is returned to the user alongside an offset into\nReportWorkItemStatusRequest", |
- "id": "MetricShortId", |
- "properties": { |
- "shortId": { |
- "description": "The service-generated short identifier for the metric.", |
- "format": "int64", |
- "type": "string" |
- }, |
- "metricIndex": { |
- "description": "The index of the corresponding metric in\nthe ReportWorkItemStatusRequest. Required.", |
- "format": "int32", |
- "type": "integer" |
- } |
- }, |
- "type": "object" |
- }, |
"AutoscalingEvent": { |
"description": "A structured message reporting an autoscaling decision made by the Dataflow\nservice.", |
"id": "AutoscalingEvent", |
"properties": { |
+ "description": { |
+ "$ref": "StructuredMessage", |
+ "description": "A message describing why the system decided to adjust the current\nnumber of workers, why it failed, or why the system decided to\nnot make any changes to the number of workers." |
+ }, |
+ "time": { |
+ "description": "The time this event was emitted to indicate a new target or current\nnum_workers value.", |
+ "format": "google-datetime", |
+ "type": "string" |
+ }, |
"targetNumWorkers": { |
"description": "The target number of workers the worker pool wants to resize to use.", |
"format": "int64", |
@@ -2566,92 +2638,65 @@ |
"description": "The current number of workers the job has.", |
"format": "int64", |
"type": "string" |
- }, |
- "description": { |
- "$ref": "StructuredMessage", |
- "description": "A message describing why the system decided to adjust the current\nnumber of workers, why it failed, or why the system decided to\nnot make any changes to the number of workers." |
- }, |
- "time": { |
- "description": "The time this event was emitted to indicate a new target or current\nnum_workers value.", |
- "format": "google-datetime", |
- "type": "string" |
- } |
- }, |
- "type": "object" |
- }, |
- "ShellTask": { |
- "description": "A task which consists of a shell command for the worker to execute.", |
- "id": "ShellTask", |
- "properties": { |
- "exitCode": { |
- "description": "Exit code for the task.", |
- "format": "int32", |
- "type": "integer" |
- }, |
- "command": { |
- "description": "The shell command to run.", |
- "type": "string" |
} |
}, |
"type": "object" |
}, |
- "TaskRunnerSettings": { |
- "description": "Taskrunner configuration settings.", |
- "id": "TaskRunnerSettings", |
+ "MetricShortId": { |
+ "description": "The metric short id is returned to the user alongside an offset into\nReportWorkItemStatusRequest", |
+ "id": "MetricShortId", |
"properties": { |
- "alsologtostderr": { |
- "description": "Whether to also send taskrunner log info to stderr.", |
- "type": "boolean" |
- }, |
- "taskGroup": { |
- "description": "The UNIX group ID on the worker VM to use for tasks launched by\ntaskrunner; e.g. \"wheel\".", |
- "type": "string" |
- }, |
- "harnessCommand": { |
- "description": "The command to launch the worker harness.", |
- "type": "string" |
- }, |
- "logDir": { |
- "description": "The directory on the VM to store logs.", |
- "type": "string" |
- }, |
- "oauthScopes": { |
- "description": "The OAuth2 scopes to be requested by the taskrunner in order to\naccess the Cloud Dataflow API.", |
- "items": { |
- "type": "string" |
- }, |
- "type": "array" |
- }, |
- "dataflowApiVersion": { |
- "description": "The API version of endpoint, e.g. \"v1b3\"", |
- "type": "string" |
+ "metricIndex": { |
+ "description": "The index of the corresponding metric in\nthe ReportWorkItemStatusRequest. Required.", |
+ "format": "int32", |
+ "type": "integer" |
}, |
- "streamingWorkerMainClass": { |
- "description": "The streaming worker main class name.", |
+ "shortId": { |
+ "description": "The service-generated short identifier for the metric.", |
+ "format": "int64", |
"type": "string" |
+ } |
+ }, |
+ "type": "object" |
+ }, |
+ "ShellTask": { |
+ "description": "A task which consists of a shell command for the worker to execute.", |
+ "id": "ShellTask", |
+ "properties": { |
+ "exitCode": { |
+ "description": "Exit code for the task.", |
+ "format": "int32", |
+ "type": "integer" |
}, |
- "logUploadLocation": { |
- "description": "Indicates where to put logs. If this is not specified, the logs\nwill not be uploaded.\n\nThe supported resource type is:\n\nGoogle Cloud Storage:\n storage.googleapis.com/{bucket}/{object}\n bucket.storage.googleapis.com/{object}", |
+ "command": { |
+ "description": "The shell command to run.", |
"type": "string" |
- }, |
+ } |
+ }, |
+ "type": "object" |
+ }, |
+ "TaskRunnerSettings": { |
+ "description": "Taskrunner configuration settings.", |
+ "id": "TaskRunnerSettings", |
+ "properties": { |
"workflowFileName": { |
"description": "The file to store the workflow in.", |
"type": "string" |
}, |
- "commandlinesFileName": { |
- "description": "The file to store preprocessing commands in.", |
- "type": "string" |
- }, |
- "languageHint": { |
- "description": "The suggested backend language.", |
+ "baseTaskDir": { |
+ "description": "The location on the worker for task-specific subdirectories.", |
"type": "string" |
}, |
"tempStoragePrefix": { |
"description": "The prefix of the resources the taskrunner should use for\ntemporary storage.\n\nThe supported resource type is:\n\nGoogle Cloud Storage:\n storage.googleapis.com/{bucket}/{object}\n bucket.storage.googleapis.com/{object}", |
"type": "string" |
}, |
- "baseTaskDir": { |
- "description": "The location on the worker for task-specific subdirectories.", |
+ "languageHint": { |
+ "description": "The suggested backend language.", |
+ "type": "string" |
+ }, |
+ "commandlinesFileName": { |
+ "description": "The file to store preprocessing commands in.", |
"type": "string" |
}, |
"baseUrl": { |
@@ -2677,6 +2722,41 @@ |
"vmId": { |
"description": "The ID string of the VM.", |
"type": "string" |
+ }, |
+ "alsologtostderr": { |
+ "description": "Whether to also send taskrunner log info to stderr.", |
+ "type": "boolean" |
+ }, |
+ "taskGroup": { |
+ "description": "The UNIX group ID on the worker VM to use for tasks launched by\ntaskrunner; e.g. \"wheel\".", |
+ "type": "string" |
+ }, |
+ "harnessCommand": { |
+ "description": "The command to launch the worker harness.", |
+ "type": "string" |
+ }, |
+ "logDir": { |
+ "description": "The directory on the VM to store logs.", |
+ "type": "string" |
+ }, |
+ "dataflowApiVersion": { |
+ "description": "The API version of endpoint, e.g. \"v1b3\"", |
+ "type": "string" |
+ }, |
+ "oauthScopes": { |
+ "description": "The OAuth2 scopes to be requested by the taskrunner in order to\naccess the Cloud Dataflow API.", |
+ "items": { |
+ "type": "string" |
+ }, |
+ "type": "array" |
+ }, |
+ "logUploadLocation": { |
+ "description": "Indicates where to put logs. If this is not specified, the logs\nwill not be uploaded.\n\nThe supported resource type is:\n\nGoogle Cloud Storage:\n storage.googleapis.com/{bucket}/{object}\n bucket.storage.googleapis.com/{object}", |
+ "type": "string" |
+ }, |
+ "streamingWorkerMainClass": { |
+ "description": "The streaming worker main class name.", |
+ "type": "string" |
} |
}, |
"type": "object" |
@@ -2685,19 +2765,15 @@ |
"description": "Position defines a position within a collection of data. The value\ncan be either the end position, a key (used with ordered\ncollections), a byte offset, or a record index.", |
"id": "Position", |
"properties": { |
- "shufflePosition": { |
- "description": "CloudPosition is a base64 encoded BatchShufflePosition (with FIXED\nsharding).", |
- "type": "string" |
+ "concatPosition": { |
+ "$ref": "ConcatPosition", |
+ "description": "CloudPosition is a concat position." |
}, |
"byteOffset": { |
"description": "Position is a byte offset.", |
"format": "int64", |
"type": "string" |
}, |
- "concatPosition": { |
- "$ref": "ConcatPosition", |
- "description": "CloudPosition is a concat position." |
- }, |
"end": { |
"description": "Position is past all other positions. Also useful for the end\nposition of an unbounded range.", |
"type": "boolean" |
@@ -2710,6 +2786,27 @@ |
"description": "Position is a record index.", |
"format": "int64", |
"type": "string" |
+ }, |
+ "shufflePosition": { |
+ "description": "CloudPosition is a base64 encoded BatchShufflePosition (with FIXED\nsharding).", |
+ "type": "string" |
+ } |
+ }, |
+ "type": "object" |
+ }, |
+ "SplitInt64": { |
+ "description": "A representation of an int64, n, that is immune to precision loss when\nencoded in JSON.", |
+ "id": "SplitInt64", |
+ "properties": { |
+ "lowBits": { |
+ "description": "The low order bits: n & 0xffffffff.", |
+ "format": "uint32", |
+ "type": "integer" |
+ }, |
+ "highBits": { |
+ "description": "The high order bits, including the sign: n >> 32.", |
+ "format": "int32", |
+ "type": "integer" |
} |
}, |
"type": "object" |
@@ -2718,6 +2815,21 @@ |
"description": "A source that records can be read and decoded from.", |
"id": "Source", |
"properties": { |
+ "metadata": { |
+ "$ref": "SourceMetadata", |
+ "description": "Optionally, metadata for this source can be supplied right away,\navoiding a SourceGetMetadataOperation roundtrip\n(see SourceOperationRequest).\n\nThis field is meaningful only in the Source objects populated\nby the user (e.g. when filling in a DerivedSource).\nSource objects supplied by the framework to the user don't have\nthis field populated." |
+ }, |
+ "baseSpecs": { |
+ "description": "While splitting, sources may specify the produced bundles\nas differences against another source, in order to save backend-side\nmemory and allow bigger jobs. For details, see SourceSplitRequest.\nTo support this use case, the full set of parameters of the source\nis logically obtained by taking the latest explicitly specified value\nof each parameter in the order:\nbase_specs (later items win), spec (overrides anything in base_specs).", |
+ "items": { |
+ "additionalProperties": { |
+ "description": "Properties of the object.", |
+ "type": "any" |
+ }, |
+ "type": "object" |
+ }, |
+ "type": "array" |
+ }, |
"codec": { |
"additionalProperties": { |
"description": "Properties of the object.", |
@@ -2737,38 +2849,6 @@ |
}, |
"description": "The source to read from, plus its parameters.", |
"type": "object" |
- }, |
- "metadata": { |
- "$ref": "SourceMetadata", |
- "description": "Optionally, metadata for this source can be supplied right away,\navoiding a SourceGetMetadataOperation roundtrip\n(see SourceOperationRequest).\n\nThis field is meaningful only in the Source objects populated\nby the user (e.g. when filling in a DerivedSource).\nSource objects supplied by the framework to the user don't have\nthis field populated." |
- }, |
- "baseSpecs": { |
- "description": "While splitting, sources may specify the produced bundles\nas differences against another source, in order to save backend-side\nmemory and allow bigger jobs. For details, see SourceSplitRequest.\nTo support this use case, the full set of parameters of the source\nis logically obtained by taking the latest explicitly specified value\nof each parameter in the order:\nbase_specs (later items win), spec (overrides anything in base_specs).", |
- "items": { |
- "additionalProperties": { |
- "description": "Properties of the object.", |
- "type": "any" |
- }, |
- "type": "object" |
- }, |
- "type": "array" |
- } |
- }, |
- "type": "object" |
- }, |
- "SplitInt64": { |
- "description": "A representation of an int64, n, that is immune to precision loss when\nencoded in JSON.", |
- "id": "SplitInt64", |
- "properties": { |
- "lowBits": { |
- "description": "The low order bits: n & 0xffffffff.", |
- "format": "uint32", |
- "type": "integer" |
- }, |
- "highBits": { |
- "description": "The high order bits, including the sign: n >> 32.", |
- "format": "int32", |
- "type": "integer" |
} |
}, |
"type": "object" |
@@ -2777,14 +2857,6 @@ |
"description": "Describes one particular pool of Cloud Dataflow workers to be\ninstantiated by the Cloud Dataflow service in order to perform the\ncomputations required by a job. Note that a workflow job may use\nmultiple pools, in order to match the various computational\nrequirements of the various stages of the job.", |
"id": "WorkerPool", |
"properties": { |
- "poolArgs": { |
- "additionalProperties": { |
- "description": "Properties of the object. Contains field @type with type URL.", |
- "type": "any" |
- }, |
- "description": "Extra arguments for this worker pool.", |
- "type": "object" |
- }, |
"diskSizeGb": { |
"description": "Size of root disk for VMs, in GB. If zero or unspecified, the service will\nattempt to choose a reasonable default.", |
"format": "int32", |
@@ -2846,6 +2918,10 @@ |
"description": "Metadata to set on the Google Compute Engine VMs.", |
"type": "object" |
}, |
+ "network": { |
+ "description": "Network to which VMs will be assigned. If empty or unspecified,\nthe service will use the network \"default\".", |
+ "type": "string" |
+ }, |
"defaultPackageSet": { |
"description": "The default package set to install. This allows the service to\nselect a default set of packages which are useful to worker\nharnesses written in a particular language.", |
"enum": [ |
@@ -2862,23 +2938,19 @@ |
], |
"type": "string" |
}, |
- "network": { |
- "description": "Network to which VMs will be assigned. If empty or unspecified,\nthe service will use the network \"default\".", |
- "type": "string" |
- }, |
- "zone": { |
- "description": "Zone to run the worker pools in. If empty or unspecified, the service\nwill attempt to choose a reasonable default.", |
- "type": "string" |
+ "numThreadsPerWorker": { |
+ "description": "The number of threads per worker harness. If empty or unspecified, the\nservice will choose a number of threads (according to the number of cores\non the selected machine type for batch, or 1 by convention for streaming).", |
+ "format": "int32", |
+ "type": "integer" |
}, |
"numWorkers": { |
"description": "Number of Google Compute Engine workers in this pool needed to\nexecute the job. If zero or unspecified, the service will\nattempt to choose a reasonable default.", |
"format": "int32", |
"type": "integer" |
}, |
- "numThreadsPerWorker": { |
- "description": "The number of threads per worker harness. If empty or unspecified, the\nservice will choose a number of threads (according to the number of cores\non the selected machine type for batch, or 1 by convention for streaming).", |
- "format": "int32", |
- "type": "integer" |
+ "zone": { |
+ "description": "Zone to run the worker pools in. If empty or unspecified, the service\nwill attempt to choose a reasonable default.", |
+ "type": "string" |
}, |
"diskSourceImage": { |
"description": "Fully qualified source image for disks.", |
@@ -2910,6 +2982,14 @@ |
"onHostMaintenance": { |
"description": "The action to take on host maintenance, as defined by the Google\nCompute Engine API.", |
"type": "string" |
+ }, |
+ "poolArgs": { |
+ "additionalProperties": { |
+ "description": "Properties of the object. Contains field @type with type URL.", |
+ "type": "any" |
+ }, |
+ "description": "Extra arguments for this worker pool.", |
+ "type": "object" |
} |
}, |
"type": "object" |
@@ -2918,13 +2998,13 @@ |
"description": "A work item that represents the different operations that can be\nperformed on a user-defined Source specification.", |
"id": "SourceOperationRequest", |
"properties": { |
- "split": { |
- "$ref": "SourceSplitRequest", |
- "description": "Information about a request to split a source." |
- }, |
"getMetadata": { |
"$ref": "SourceGetMetadataRequest", |
"description": "Information about a request to get metadata about a source." |
+ }, |
+ "split": { |
+ "$ref": "SourceSplitRequest", |
+ "description": "Information about a request to split a source." |
} |
}, |
"type": "object" |
@@ -2933,6 +3013,13 @@ |
"description": "A rich message format, including a human readable string, a key for\nidentifying the message, and structured data associated with the message for\nprogrammatic consumption.", |
"id": "StructuredMessage", |
"properties": { |
+ "parameters": { |
+ "description": "The structured data associated with this message.", |
+ "items": { |
+ "$ref": "Parameter" |
+ }, |
+ "type": "array" |
+ }, |
"messageKey": { |
"description": "Idenfier for this message type. Used by external systems to\ninternationalize or personalize message.", |
"type": "string" |
@@ -2940,13 +3027,6 @@ |
"messageText": { |
"description": "Human-readable version of message.", |
"type": "string" |
- }, |
- "parameters": { |
- "description": "The structured data associated with this message.", |
- "items": { |
- "$ref": "Parameter" |
- }, |
- "type": "array" |
} |
}, |
"type": "object" |
@@ -2954,40 +3034,7 @@ |
"WorkItem": { |
"description": "WorkItem represents basic information about a WorkItem to be executed\nin the cloud.", |
"id": "WorkItem", |
- "properties": { |
- "packages": { |
- "description": "Any required packages that need to be fetched in order to execute\nthis WorkItem.", |
- "items": { |
- "$ref": "Package" |
- }, |
- "type": "array" |
- }, |
- "projectId": { |
- "description": "Identifies the cloud project this WorkItem belongs to.", |
- "type": "string" |
- }, |
- "sourceOperationTask": { |
- "$ref": "SourceOperationRequest", |
- "description": "Additional information for source operation WorkItems." |
- }, |
- "streamingSetupTask": { |
- "$ref": "StreamingSetupTask", |
- "description": "Additional information for StreamingSetupTask WorkItems." |
- }, |
- "reportStatusInterval": { |
- "description": "Recommended reporting interval.", |
- "format": "google-duration", |
- "type": "string" |
- }, |
- "leaseExpireTime": { |
- "description": "Time when the lease on this Work will expire.", |
- "format": "google-datetime", |
- "type": "string" |
- }, |
- "streamingConfigTask": { |
- "$ref": "StreamingConfigTask", |
- "description": "Additional information for StreamingConfigTask WorkItems." |
- }, |
+ "properties": { |
"initialReportIndex": { |
"description": "The initial index to use when reporting the status of the WorkItem.", |
"format": "int64", |
@@ -3021,6 +3068,39 @@ |
"seqMapTask": { |
"$ref": "SeqMapTask", |
"description": "Additional information for SeqMapTask WorkItems." |
+ }, |
+ "packages": { |
+ "description": "Any required packages that need to be fetched in order to execute\nthis WorkItem.", |
+ "items": { |
+ "$ref": "Package" |
+ }, |
+ "type": "array" |
+ }, |
+ "projectId": { |
+ "description": "Identifies the cloud project this WorkItem belongs to.", |
+ "type": "string" |
+ }, |
+ "sourceOperationTask": { |
+ "$ref": "SourceOperationRequest", |
+ "description": "Additional information for source operation WorkItems." |
+ }, |
+ "streamingSetupTask": { |
+ "$ref": "StreamingSetupTask", |
+ "description": "Additional information for StreamingSetupTask WorkItems." |
+ }, |
+ "reportStatusInterval": { |
+ "description": "Recommended reporting interval.", |
+ "format": "google-duration", |
+ "type": "string" |
+ }, |
+ "streamingConfigTask": { |
+ "$ref": "StreamingConfigTask", |
+ "description": "Additional information for StreamingConfigTask WorkItems." |
+ }, |
+ "leaseExpireTime": { |
+ "description": "Time when the lease on this Work will expire.", |
+ "format": "google-datetime", |
+ "type": "string" |
} |
}, |
"type": "object" |
@@ -3059,13 +3139,6 @@ |
"description": "Global topology of the streaming Dataflow job, including all\ncomputations and their sharded locations.", |
"id": "TopologyConfig", |
"properties": { |
- "computations": { |
- "description": "The computations associated with a streaming Dataflow job.", |
- "items": { |
- "$ref": "ComputationTopology" |
- }, |
- "type": "array" |
- }, |
"dataDiskAssignments": { |
"description": "The disks assigned to a streaming Dataflow job.", |
"items": { |
@@ -3089,6 +3162,13 @@ |
}, |
"description": "Maps user stage names to stable computation names.", |
"type": "object" |
+ }, |
+ "computations": { |
+ "description": "The computations associated with a streaming Dataflow job.", |
+ "items": { |
+ "$ref": "ComputationTopology" |
+ }, |
+ "type": "array" |
} |
}, |
"type": "object" |
@@ -3125,18 +3205,6 @@ |
"description": "Provides data to pass through to the worker harness.", |
"id": "WorkerSettings", |
"properties": { |
- "shuffleServicePath": { |
- "description": "The Shuffle service path relative to the root URL, for example,\n\"shuffle/v1beta1\".", |
- "type": "string" |
- }, |
- "workerId": { |
- "description": "The ID of the worker running this pipeline.", |
- "type": "string" |
- }, |
- "tempStoragePrefix": { |
- "description": "The prefix of the resources the system should use for temporary\nstorage.\n\nThe supported resource type is:\n\nGoogle Cloud Storage:\n\n storage.googleapis.com/{bucket}/{object}\n bucket.storage.googleapis.com/{object}", |
- "type": "string" |
- }, |
"reportingEnabled": { |
"description": "Whether to send work progress updates to the service.", |
"type": "boolean" |
@@ -3148,16 +3216,17 @@ |
"servicePath": { |
"description": "The Cloud Dataflow service path relative to the root URL, for example,\n\"dataflow/v1b3/projects\".", |
"type": "string" |
- } |
- }, |
- "type": "object" |
- }, |
- "StreamingStageLocation": { |
- "description": "Identifies the location of a streaming computation stage, for\nstage-to-stage communication.", |
- "id": "StreamingStageLocation", |
- "properties": { |
- "streamId": { |
- "description": "Identifies the particular stream within the streaming Dataflow\njob.", |
+ }, |
+ "shuffleServicePath": { |
+ "description": "The Shuffle service path relative to the root URL, for example,\n\"shuffle/v1beta1\".", |
+ "type": "string" |
+ }, |
+ "workerId": { |
+ "description": "The ID of the worker running this pipeline.", |
+ "type": "string" |
+ }, |
+ "tempStoragePrefix": { |
+ "description": "The prefix of the resources the system should use for temporary\nstorage.\n\nThe supported resource type is:\n\nGoogle Cloud Storage:\n\n storage.googleapis.com/{bucket}/{object}\n bucket.storage.googleapis.com/{object}", |
"type": "string" |
} |
}, |
@@ -3167,15 +3236,26 @@ |
"description": "Data disk assignment for a given VM instance.", |
"id": "DataDiskAssignment", |
"properties": { |
+ "vmInstance": { |
+ "description": "VM instance name the data disks mounted to, for example\n\"myproject-1014-104817-4c2-harness-0\".", |
+ "type": "string" |
+ }, |
"dataDisks": { |
"description": "Mounted data disks. The order is important a data disk's 0-based index in\nthis list defines which persistent directory the disk is mounted to, for\nexample the list of { \"myproject-1014-104817-4c2-harness-0-disk-0\" },\n{ \"myproject-1014-104817-4c2-harness-0-disk-1\" }.", |
"items": { |
"type": "string" |
}, |
"type": "array" |
- }, |
- "vmInstance": { |
- "description": "VM instance name the data disks mounted to, for example\n\"myproject-1014-104817-4c2-harness-0\".", |
+ } |
+ }, |
+ "type": "object" |
+ }, |
+ "StreamingStageLocation": { |
+ "description": "Identifies the location of a streaming computation stage, for\nstage-to-stage communication.", |
+ "id": "StreamingStageLocation", |
+ "properties": { |
+ "streamId": { |
+ "description": "Identifies the particular stream within the streaming Dataflow\njob.", |
"type": "string" |
} |
}, |
@@ -3185,14 +3265,14 @@ |
"description": "A suggestion by the service to the worker to dynamically split the WorkItem.", |
"id": "ApproximateSplitRequest", |
"properties": { |
- "position": { |
- "$ref": "Position", |
- "description": "A Position at which to split the work item." |
- }, |
"fractionConsumed": { |
"description": "A fraction at which to split the work item, from 0.0 (beginning of the\ninput) to 1.0 (end of the input).", |
"format": "double", |
"type": "number" |
+ }, |
+ "position": { |
+ "$ref": "Position", |
+ "description": "A Position at which to split the work item." |
} |
}, |
"type": "object" |
@@ -3228,11 +3308,6 @@ |
"description": "A message describing the state of a particular execution stage.", |
"id": "ExecutionStageState", |
"properties": { |
- "currentStateTime": { |
- "description": "The time at which the stage transitioned to this state.", |
- "format": "google-datetime", |
- "type": "string" |
- }, |
"executionStageState": { |
"description": "Executions stage states allow the same set of values as JobState.", |
"enum": [ |
@@ -3266,6 +3341,11 @@ |
"executionStageName": { |
"description": "The name of the execution stage.", |
"type": "string" |
+ }, |
+ "currentStateTime": { |
+ "description": "The time at which the stage transitioned to this state.", |
+ "format": "google-datetime", |
+ "type": "string" |
} |
}, |
"type": "object" |
@@ -3274,10 +3354,6 @@ |
"description": "Describes a stream of data, either as input to be processed or as\noutput of a streaming Dataflow job.", |
"id": "StreamLocation", |
"properties": { |
- "customSourceLocation": { |
- "$ref": "CustomSourceLocation", |
- "description": "The stream is a custom source." |
- }, |
"streamingStageLocation": { |
"$ref": "StreamingStageLocation", |
"description": "The stream is part of another computation within the current\nstreaming Dataflow job." |
@@ -3289,6 +3365,10 @@ |
"sideInputLocation": { |
"$ref": "StreamingSideInputLocation", |
"description": "The stream is a streaming side input." |
+ }, |
+ "customSourceLocation": { |
+ "$ref": "CustomSourceLocation", |
+ "description": "The stream is a custom source." |
} |
}, |
"type": "object" |
@@ -3311,6 +3391,10 @@ |
"description": "Configuration information for a single streaming computation.", |
"id": "StreamingComputationConfig", |
"properties": { |
+ "computationId": { |
+ "description": "Unique identifier for this computation.", |
+ "type": "string" |
+ }, |
"systemName": { |
"description": "System defined name for this computation.", |
"type": "string" |
@@ -3325,10 +3409,6 @@ |
"$ref": "ParallelInstruction" |
}, |
"type": "array" |
- }, |
- "computationId": { |
- "description": "Unique identifier for this computation.", |
- "type": "string" |
} |
}, |
"type": "object" |
@@ -3337,17 +3417,6 @@ |
"description": "Description of the type, names/ids, and input/outputs for a transform.", |
"id": "TransformSummary", |
"properties": { |
- "inputCollectionName": { |
- "description": "User names for all collection inputs to this transform.", |
- "items": { |
- "type": "string" |
- }, |
- "type": "array" |
- }, |
- "name": { |
- "description": "User provided name for this transform instance.", |
- "type": "string" |
- }, |
"id": { |
"description": "SDK generated id of this transform instance.", |
"type": "string" |
@@ -3391,6 +3460,17 @@ |
"Opening or closing a shuffle session, often as part of a GroupByKey." |
], |
"type": "string" |
+ }, |
+ "inputCollectionName": { |
+ "description": "User names for all collection inputs to this transform.", |
+ "items": { |
+ "type": "string" |
+ }, |
+ "type": "array" |
+ }, |
+ "name": { |
+ "description": "User provided name for this transform instance.", |
+ "type": "string" |
} |
}, |
"type": "object" |
@@ -3436,6 +3516,10 @@ |
"description": "Parameters to provide to the template being launched.", |
"id": "LaunchTemplateParameters", |
"properties": { |
+ "environment": { |
+ "$ref": "RuntimeEnvironment", |
+ "description": "The runtime environment for the job." |
+ }, |
"parameters": { |
"additionalProperties": { |
"type": "string" |
@@ -3446,10 +3530,6 @@ |
"jobName": { |
"description": "Required. The job name to use for the created job.", |
"type": "string" |
- }, |
- "environment": { |
- "$ref": "RuntimeEnvironment", |
- "description": "The runtime environment for the job." |
} |
}, |
"type": "object" |
@@ -3472,6 +3552,21 @@ |
"description": "An instruction that does a partial group-by-key.\nOne input and one output.", |
"id": "PartialGroupByKeyInstruction", |
"properties": { |
+ "originalCombineValuesStepName": { |
+ "description": "If this instruction includes a combining function, this is the name of the\nCombineValues instruction lifted into this instruction.", |
+ "type": "string" |
+ }, |
+ "sideInputs": { |
+ "description": "Zero or more side inputs.", |
+ "items": { |
+ "$ref": "SideInputInfo" |
+ }, |
+ "type": "array" |
+ }, |
+ "input": { |
+ "$ref": "InstructionInput", |
+ "description": "Describes the input to the partial group-by-key instruction." |
+ }, |
"inputElementCodec": { |
"additionalProperties": { |
"description": "Properties of the object.", |
@@ -3491,21 +3586,6 @@ |
"originalCombineValuesInputStoreName": { |
"description": "If this instruction includes a combining function this is the name of the\nintermediate store between the GBK and the CombineValues.", |
"type": "string" |
- }, |
- "sideInputs": { |
- "description": "Zero or more side inputs.", |
- "items": { |
- "$ref": "SideInputInfo" |
- }, |
- "type": "array" |
- }, |
- "originalCombineValuesStepName": { |
- "description": "If this instruction includes a combining function, this is the name of the\nCombineValues instruction lifted into this instruction.", |
- "type": "string" |
- }, |
- "input": { |
- "$ref": "InstructionInput", |
- "description": "Describes the input to the partial group-by-key instruction." |
} |
}, |
"type": "object" |
@@ -3514,13 +3594,13 @@ |
"description": "An input of an instruction, as a reference to an output of a\nproducer instruction.", |
"id": "InstructionInput", |
"properties": { |
- "producerInstructionIndex": { |
- "description": "The index (origin zero) of the parallel instruction that produces\nthe output to be consumed by this input. This index is relative\nto the list of instructions in this input's instruction's\ncontaining MapTask.", |
+ "outputNum": { |
+ "description": "The output index (origin zero) within the producer.", |
"format": "int32", |
"type": "integer" |
}, |
- "outputNum": { |
- "description": "The output index (origin zero) within the producer.", |
+ "producerInstructionIndex": { |
+ "description": "The index (origin zero) of the parallel instruction that produces\nthe output to be consumed by this input. This index is relative\nto the list of instructions in this input's instruction's\ncontaining MapTask.", |
"format": "int32", |
"type": "integer" |
} |
@@ -3577,14 +3657,14 @@ |
"description": "A possible additional shorter value to display.\nFor example a java_class_name_value of com.mypackage.MyDoFn\nwill be stored with MyDoFn as the short_str_value and\ncom.mypackage.MyDoFn as the java_class_name value.\nshort_str_value can be displayed and java_class_name_value\nwill be displayed as a tooltip.", |
"type": "string" |
}, |
- "url": { |
- "description": "An optional full URL.", |
- "type": "string" |
- }, |
"label": { |
"description": "An optional label to display in a dax UI for the element.", |
"type": "string" |
}, |
+ "url": { |
+ "description": "An optional full URL.", |
+ "type": "string" |
+ }, |
"timestampValue": { |
"description": "Contains value if the data is of timestamp type.", |
"format": "google-datetime", |
@@ -3602,16 +3682,16 @@ |
"description": "Contains value if the data is of string type.", |
"type": "string" |
}, |
- "int64Value": { |
- "description": "Contains value if the data is of int64 type.", |
- "format": "int64", |
- "type": "string" |
- }, |
"durationValue": { |
"description": "Contains value if the data is of duration type.", |
"format": "google-duration", |
"type": "string" |
}, |
+ "int64Value": { |
+ "description": "Contains value if the data is of int64 type.", |
+ "format": "int64", |
+ "type": "string" |
+ }, |
"namespace": { |
"description": "The namespace for the key. This is usually a class name or programming\nlanguage namespace (i.e. python module) which defines the display data.\nThis allows a dax monitoring system to specially handle the data\nand perform custom rendering.", |
"type": "string" |
@@ -3628,10 +3708,6 @@ |
"description": "Request to lease WorkItems.", |
"id": "LeaseWorkItemRequest", |
"properties": { |
- "workerId": { |
- "description": "Identifies the worker leasing work -- typically the ID of the\nvirtual machine running the worker.", |
- "type": "string" |
- }, |
"workerCapabilities": { |
"description": "Worker capabilities. WorkItems might be limited to workers with specific\ncapabilities.", |
"items": { |
@@ -3639,6 +3715,10 @@ |
}, |
"type": "array" |
}, |
+ "workerId": { |
+ "description": "Identifies the worker leasing work -- typically the ID of the\nvirtual machine running the worker.", |
+ "type": "string" |
+ }, |
"requestedLeaseDuration": { |
"description": "The initial lease period.", |
"format": "google-duration", |
@@ -3649,16 +3729,16 @@ |
"format": "google-datetime", |
"type": "string" |
}, |
+ "location": { |
+ "description": "The location which contains the WorkItem's job.", |
+ "type": "string" |
+ }, |
"workItemTypes": { |
"description": "Filter for WorkItem type.", |
"items": { |
"type": "string" |
}, |
"type": "array" |
- }, |
- "location": { |
- "description": "The location which contains the WorkItem's job.", |
- "type": "string" |
} |
}, |
"type": "object" |
@@ -3667,6 +3747,10 @@ |
"description": "Request to get updated debug configuration for component.", |
"id": "GetDebugConfigRequest", |
"properties": { |
+ "location": { |
+ "description": "The location which contains the job specified by job_id.", |
+ "type": "string" |
+ }, |
"componentId": { |
"description": "The internal component id for which debug configuration is\nrequested.", |
"type": "string" |
@@ -3674,10 +3758,6 @@ |
"workerId": { |
"description": "The worker id, i.e., VM hostname.", |
"type": "string" |
- }, |
- "location": { |
- "description": "The location which contains the job specified by job_id.", |
- "type": "string" |
} |
}, |
"type": "object" |
@@ -3701,13 +3781,13 @@ |
"description": "Structured data associated with this message.", |
"id": "Parameter", |
"properties": { |
- "value": { |
- "description": "Value for this parameter.", |
- "type": "any" |
- }, |
"key": { |
"description": "Key or name for this parameter.", |
"type": "string" |
+ }, |
+ "value": { |
+ "description": "Value for this parameter.", |
+ "type": "any" |
} |
}, |
"type": "object" |
@@ -3716,6 +3796,13 @@ |
"description": "Request to report the status of WorkItems.", |
"id": "ReportWorkItemStatusRequest", |
"properties": { |
+ "workItemStatuses": { |
+ "description": "The order is unimportant, except that the order of the\nWorkItemServiceState messages in the ReportWorkItemStatusResponse\ncorresponds to the order of WorkItemStatus messages here.", |
+ "items": { |
+ "$ref": "WorkItemStatus" |
+ }, |
+ "type": "array" |
+ }, |
"workerId": { |
"description": "The ID of the worker reporting the WorkItem status. If this\ndoes not match the ID of the worker which the Dataflow service\nbelieves currently has the lease on the WorkItem, the report\nwill be dropped (with an error response).", |
"type": "string" |
@@ -3728,11 +3815,32 @@ |
"location": { |
"description": "The location which contains the WorkItem's job.", |
"type": "string" |
+ } |
+ }, |
+ "type": "object" |
+ }, |
+ "PipelineDescription": { |
+ "description": "A descriptive representation of submitted pipeline as well as the executed\nform. This data is provided by the Dataflow service for ease of visualizing\nthe pipeline and interpretting Dataflow provided metrics.", |
+ "id": "PipelineDescription", |
+ "properties": { |
+ "originalPipelineTransform": { |
+ "description": "Description of each transform in the pipeline and collections between them.", |
+ "items": { |
+ "$ref": "TransformSummary" |
+ }, |
+ "type": "array" |
}, |
- "workItemStatuses": { |
- "description": "The order is unimportant, except that the order of the\nWorkItemServiceState messages in the ReportWorkItemStatusResponse\ncorresponds to the order of WorkItemStatus messages here.", |
+ "displayData": { |
+ "description": "Pipeline level display data.", |
"items": { |
- "$ref": "WorkItemStatus" |
+ "$ref": "DisplayData" |
+ }, |
+ "type": "array" |
+ }, |
+ "executionPipelineStage": { |
+ "description": "Description of each stage of execution of the pipeline.", |
+ "items": { |
+ "$ref": "ExecutionStageSummary" |
}, |
"type": "array" |
} |
@@ -3769,30 +3877,16 @@ |
}, |
"type": "object" |
}, |
- "PipelineDescription": { |
- "description": "A descriptive representation of submitted pipeline as well as the executed\nform. This data is provided by the Dataflow service for ease of visualizing\nthe pipeline and interpretting Dataflow provided metrics.", |
- "id": "PipelineDescription", |
+ "JobExecutionInfo": { |
+ "description": "Additional information about how a Cloud Dataflow job will be executed that\nisn't contained in the submitted job.", |
+ "id": "JobExecutionInfo", |
"properties": { |
- "displayData": { |
- "description": "Pipeline level display data.", |
- "items": { |
- "$ref": "DisplayData" |
- }, |
- "type": "array" |
- }, |
- "executionPipelineStage": { |
- "description": "Description of each stage of execution of the pipeline.", |
- "items": { |
- "$ref": "ExecutionStageSummary" |
- }, |
- "type": "array" |
- }, |
- "originalPipelineTransform": { |
- "description": "Description of each transform in the pipeline and collections between them.", |
- "items": { |
- "$ref": "TransformSummary" |
+ "stages": { |
+ "additionalProperties": { |
+ "$ref": "JobExecutionStageInfo" |
}, |
- "type": "array" |
+ "description": "A mapping from each stage to the information about that stage.", |
+ "type": "object" |
} |
}, |
"type": "object" |
@@ -3801,14 +3895,6 @@ |
"description": "Defines a particular step within a Cloud Dataflow job.\n\nA job consists of multiple steps, each of which performs some\nspecific operation as part of the overall job. Data is typically\npassed from one step to another as part of the job.\n\nHere's an example of a sequence of steps which together implement a\nMap-Reduce job:\n\n * Read a collection of data from some source, parsing the\n collection's elements.\n\n * Validate the elements.\n\n * Apply a user-defined function to map each element to some value\n and extract an element-specific key value.\n\n * Group elements with the same key into a single element with\n that key, transforming a multiply-keyed collection into a\n uniquely-keyed collection.\n\n * Write the elements out to some data sink.\n\nNote that the Cloud Dataflow service may be used to run many different\ntypes of jobs, not just Map-Reduce.", |
"id": "Step", |
"properties": { |
- "name": { |
- "description": "The name that identifies the step. This must be unique for each\nstep with respect to all other steps in the Cloud Dataflow job.", |
- "type": "string" |
- }, |
- "kind": { |
- "description": "The kind of step in the Cloud Dataflow job.", |
- "type": "string" |
- }, |
"properties": { |
"additionalProperties": { |
"description": "Properties of the object.", |
@@ -3816,20 +3902,14 @@ |
}, |
"description": "Named properties associated with the step. Each kind of\npredefined step has its own required set of properties.\nMust be provided on Create. Only retrieved with JOB_VIEW_ALL.", |
"type": "object" |
- } |
- }, |
- "type": "object" |
- }, |
- "JobExecutionInfo": { |
- "description": "Additional information about how a Cloud Dataflow job will be executed that\nisn't contained in the submitted job.", |
- "id": "JobExecutionInfo", |
- "properties": { |
- "stages": { |
- "additionalProperties": { |
- "$ref": "JobExecutionStageInfo" |
- }, |
- "description": "A mapping from each stage to the information about that stage.", |
- "type": "object" |
+ }, |
+ "name": { |
+ "description": "The name that identifies the step. This must be unique for each\nstep with respect to all other steps in the Cloud Dataflow job.", |
+ "type": "string" |
+ }, |
+ "kind": { |
+ "description": "The kind of step in the Cloud Dataflow job.", |
+ "type": "string" |
} |
}, |
"type": "object" |
@@ -3869,6 +3949,10 @@ |
"description": "CounterMetadata includes all static non-name non-value counter attributes.", |
"id": "CounterMetadata", |
"properties": { |
+ "otherUnits": { |
+ "description": "A string referring to the unit type.", |
+ "type": "string" |
+ }, |
"kind": { |
"description": "Counter aggregation kind.", |
"enum": [ |
@@ -3922,10 +4006,6 @@ |
"Counter returns a timestamp in nanoseconds." |
], |
"type": "string" |
- }, |
- "otherUnits": { |
- "description": "A string referring to the unit type.", |
- "type": "string" |
} |
}, |
"type": "object" |
@@ -3934,13 +4014,6 @@ |
"description": "Response to a request to list job messages.", |
"id": "ListJobMessagesResponse", |
"properties": { |
- "autoscalingEvents": { |
- "description": "Autoscaling events in ascending timestamp order.", |
- "items": { |
- "$ref": "AutoscalingEvent" |
- }, |
- "type": "array" |
- }, |
"jobMessages": { |
"description": "Messages in ascending timestamp order.", |
"items": { |
@@ -3951,6 +4024,13 @@ |
"nextPageToken": { |
"description": "The token to obtain the next page of results if there are more.", |
"type": "string" |
+ }, |
+ "autoscalingEvents": { |
+ "description": "Autoscaling events in ascending timestamp order.", |
+ "items": { |
+ "$ref": "AutoscalingEvent" |
+ }, |
+ "type": "array" |
} |
}, |
"type": "object" |
@@ -4053,43 +4133,43 @@ |
"description": "Describes a particular operation comprising a MapTask.", |
"id": "ParallelInstruction", |
"properties": { |
- "read": { |
- "$ref": "ReadInstruction", |
- "description": "Additional information for Read instructions." |
+ "partialGroupByKey": { |
+ "$ref": "PartialGroupByKeyInstruction", |
+ "description": "Additional information for PartialGroupByKey instructions." |
+ }, |
+ "outputs": { |
+ "description": "Describes the outputs of the instruction.", |
+ "items": { |
+ "$ref": "InstructionOutput" |
+ }, |
+ "type": "array" |
+ }, |
+ "name": { |
+ "description": "User-provided name of this operation.", |
+ "type": "string" |
}, |
"parDo": { |
"$ref": "ParDoInstruction", |
"description": "Additional information for ParDo instructions." |
}, |
- "flatten": { |
- "$ref": "FlattenInstruction", |
- "description": "Additional information for Flatten instructions." |
+ "read": { |
+ "$ref": "ReadInstruction", |
+ "description": "Additional information for Read instructions." |
}, |
"originalName": { |
"description": "System-defined name for the operation in the original workflow graph.", |
"type": "string" |
}, |
- "systemName": { |
- "description": "System-defined name of this operation.\nUnique across the workflow.", |
- "type": "string" |
+ "flatten": { |
+ "$ref": "FlattenInstruction", |
+ "description": "Additional information for Flatten instructions." |
}, |
"write": { |
"$ref": "WriteInstruction", |
"description": "Additional information for Write instructions." |
}, |
- "partialGroupByKey": { |
- "$ref": "PartialGroupByKeyInstruction", |
- "description": "Additional information for PartialGroupByKey instructions." |
- }, |
- "outputs": { |
- "description": "Describes the outputs of the instruction.", |
- "items": { |
- "$ref": "InstructionOutput" |
- }, |
- "type": "array" |
- }, |
- "name": { |
- "description": "User-provided name of this operation.", |
+ "systemName": { |
+ "description": "System-defined name of this operation.\nUnique across the workflow.", |
"type": "string" |
} |
}, |
@@ -4133,14 +4213,6 @@ |
"description": "An instruction that does a ParDo operation.\nTakes one main input and zero or more side inputs, and produces\nzero or more outputs.\nRuns user code.", |
"id": "ParDoInstruction", |
"properties": { |
- "userFn": { |
- "additionalProperties": { |
- "description": "Properties of the object.", |
- "type": "any" |
- }, |
- "description": "The user function to invoke.", |
- "type": "object" |
- }, |
"input": { |
"$ref": "InstructionInput", |
"description": "The input." |
@@ -4163,6 +4235,14 @@ |
"$ref": "MultiOutputInfo" |
}, |
"type": "array" |
+ }, |
+ "userFn": { |
+ "additionalProperties": { |
+ "description": "Properties of the object.", |
+ "type": "any" |
+ }, |
+ "description": "The user function to invoke.", |
+ "type": "object" |
} |
}, |
"type": "object" |
@@ -4171,30 +4251,6 @@ |
"description": "Identifies a counter within a per-job namespace. Counters whose structured\nnames are the same get merged into a single value for the job.", |
"id": "CounterStructuredName", |
"properties": { |
- "originNamespace": { |
- "description": "A string containing a more specific namespace of the counter's origin.", |
- "type": "string" |
- }, |
- "origin": { |
- "description": "One of the standard Origins defined above.", |
- "enum": [ |
- "SYSTEM", |
- "USER" |
- ], |
- "enumDescriptions": [ |
- "Counter was created by the Dataflow system.", |
- "Counter was created by the user." |
- ], |
- "type": "string" |
- }, |
- "name": { |
- "description": "Counter name. Not necessarily globally-unique, but unique within the\ncontext of the other fields.\nRequired.", |
- "type": "string" |
- }, |
- "executionStepName": { |
- "description": "Name of the stage. An execution step contains multiple component steps.", |
- "type": "string" |
- }, |
"componentStepName": { |
"description": "Name of the optimized step being executed by the workers.", |
"type": "string" |
@@ -4220,6 +4276,30 @@ |
"workerId": { |
"description": "ID of a particular worker.", |
"type": "string" |
+ }, |
+ "originNamespace": { |
+ "description": "A string containing a more specific namespace of the counter's origin.", |
+ "type": "string" |
+ }, |
+ "origin": { |
+ "description": "One of the standard Origins defined above.", |
+ "enum": [ |
+ "SYSTEM", |
+ "USER" |
+ ], |
+ "enumDescriptions": [ |
+ "Counter was created by the Dataflow system.", |
+ "Counter was created by the user." |
+ ], |
+ "type": "string" |
+ }, |
+ "name": { |
+ "description": "Counter name. Not necessarily globally-unique, but unique within the\ncontext of the other fields.\nRequired.", |
+ "type": "string" |
+ }, |
+ "executionStepName": { |
+ "description": "Name of the stage. An execution step contains multiple component steps.", |
+ "type": "string" |
} |
}, |
"type": "object" |
@@ -4228,6 +4308,22 @@ |
"description": "Describes the state of a metric.", |
"id": "MetricUpdate", |
"properties": { |
+ "set": { |
+ "description": "Worker-computed aggregate value for the \"Set\" aggregation kind. The only\npossible value type is a list of Values whose type can be Long, Double,\nor String, according to the metric's type. All Values in the list must\nbe of the same type.", |
+ "type": "any" |
+ }, |
+ "cumulative": { |
+ "description": "True if this metric is reported as the total cumulative aggregate\nvalue accumulated since the worker started working on this WorkItem.\nBy default this is false, indicating that this metric is reported\nas a delta that is not associated with any WorkItem.", |
+ "type": "boolean" |
+ }, |
+ "internal": { |
+ "description": "Worker-computed aggregate value for internal use by the Dataflow\nservice.", |
+ "type": "any" |
+ }, |
+ "kind": { |
+ "description": "Metric aggregation kind. The possible metric aggregation kinds are\n\"Sum\", \"Max\", \"Min\", \"Mean\", \"Set\", \"And\", \"Or\", and \"Distribution\".\nThe specified aggregation kind is case-insensitive.\n\nIf omitted, this is not an aggregated value but instead\na single metric sample value.", |
+ "type": "string" |
+ }, |
"scalar": { |
"description": "Worker-computed aggregate value for aggregation kinds \"Sum\", \"Max\", \"Min\",\n\"And\", and \"Or\". The possible value types are Long, Double, and Boolean.", |
"type": "any" |
@@ -4252,22 +4348,6 @@ |
"distribution": { |
"description": "A struct value describing properties of a distribution of numeric values.", |
"type": "any" |
- }, |
- "set": { |
- "description": "Worker-computed aggregate value for the \"Set\" aggregation kind. The only\npossible value type is a list of Values whose type can be Long, Double,\nor String, according to the metric's type. All Values in the list must\nbe of the same type.", |
- "type": "any" |
- }, |
- "cumulative": { |
- "description": "True if this metric is reported as the total cumulative aggregate\nvalue accumulated since the worker started working on this WorkItem.\nBy default this is false, indicating that this metric is reported\nas a delta that is not associated with any WorkItem.", |
- "type": "boolean" |
- }, |
- "internal": { |
- "description": "Worker-computed aggregate value for internal use by the Dataflow\nservice.", |
- "type": "any" |
- }, |
- "kind": { |
- "description": "Metric aggregation kind. The possible metric aggregation kinds are\n\"Sum\", \"Max\", \"Min\", \"Mean\", \"Set\", \"And\", \"Or\", and \"Distribution\".\nThe specified aggregation kind is case-insensitive.\n\nIf omitted, this is not an aggregated value but instead\na single metric sample value.", |
- "type": "string" |
} |
}, |
"type": "object" |
@@ -4276,10 +4356,6 @@ |
"description": "Obsolete in favor of ApproximateReportedProgress and ApproximateSplitRequest.", |
"id": "ApproximateProgress", |
"properties": { |
- "position": { |
- "$ref": "Position", |
- "description": "Obsolete." |
- }, |
"percentComplete": { |
"description": "Obsolete.", |
"format": "float", |
@@ -4289,6 +4365,10 @@ |
"description": "Obsolete.", |
"format": "google-duration", |
"type": "string" |
+ }, |
+ "position": { |
+ "$ref": "Position", |
+ "description": "Obsolete." |
} |
}, |
"type": "object" |
@@ -4297,13 +4377,13 @@ |
"description": "A worker_message response allows the server to pass information to the\nsender.", |
"id": "WorkerMessageResponse", |
"properties": { |
- "workerMetricsResponse": { |
- "$ref": "ResourceUtilizationReportResponse", |
- "description": "Service's response to reporting worker metrics (currently empty)." |
- }, |
"workerHealthReportResponse": { |
"$ref": "WorkerHealthReportResponse", |
"description": "The service's response to a worker's health report." |
+ }, |
+ "workerMetricsResponse": { |
+ "$ref": "ResourceUtilizationReportResponse", |
+ "description": "Service's response to reporting worker metrics (currently empty)." |
} |
}, |
"type": "object" |
@@ -4312,10 +4392,6 @@ |
"description": "Metadata describing a template.", |
"id": "TemplateMetadata", |
"properties": { |
- "bypassTempDirValidation": { |
- "description": "If true, will bypass the validation that the temp directory is\nwritable. This should only be used with templates for pipelines\nthat are guaranteed not to need to write to the temp directory,\nwhich is subject to change based on the optimizer.", |
- "type": "boolean" |
- }, |
"name": { |
"description": "Required. The name of the template.", |
"type": "string" |
@@ -4338,6 +4414,11 @@ |
"description": "WorkerMessage provides information to the backend about a worker.", |
"id": "WorkerMessage", |
"properties": { |
+ "time": { |
+ "description": "The timestamp of the worker_message.", |
+ "format": "google-datetime", |
+ "type": "string" |
+ }, |
"workerHealthReport": { |
"$ref": "WorkerHealthReport", |
"description": "The health of a worker." |
@@ -4356,11 +4437,6 @@ |
}, |
"description": "Labels are used to group WorkerMessages.\nFor example, a worker_message about a particular container\nmight have the labels:\n{ \"JOB_ID\": \"2015-04-22\",\n \"WORKER_ID\": \"wordcount-vm-2015…\"\n \"CONTAINER_TYPE\": \"worker\",\n \"CONTAINER_ID\": \"ac1234def\"}\nLabel tags typically correspond to Label enum values. However, for ease\nof development other strings can be used as tags. LABEL_UNSPECIFIED should\nnot be used here.", |
"type": "object" |
- }, |
- "time": { |
- "description": "The timestamp of the worker_message.", |
- "format": "google-datetime", |
- "type": "string" |
} |
}, |
"type": "object" |
@@ -4407,14 +4483,14 @@ |
"$ref": "SplitInt64", |
"description": "Integer value for Sum, Max, Min." |
}, |
- "integerList": { |
- "$ref": "IntegerList", |
- "description": "List of integers, for Set." |
- }, |
"structuredNameAndMetadata": { |
"$ref": "CounterStructuredNameAndMetadata", |
"description": "Counter structured name and metadata." |
}, |
+ "integerList": { |
+ "$ref": "IntegerList", |
+ "description": "List of integers, for Set." |
+ }, |
"floatingPoint": { |
"description": "Floating point value for Sum, Max, Min.", |
"format": "double", |
@@ -4424,14 +4500,14 @@ |
"$ref": "IntegerMean", |
"description": "Integer mean aggregation value for Mean." |
}, |
- "cumulative": { |
- "description": "True if this counter is reported as the total cumulative aggregate\nvalue accumulated since the worker started working on this WorkItem.\nBy default this is false, indicating that this counter is reported\nas a delta.", |
- "type": "boolean" |
- }, |
"internal": { |
"description": "Value for internally-defined counters used by the Dataflow service.", |
"type": "any" |
}, |
+ "cumulative": { |
+ "description": "True if this counter is reported as the total cumulative aggregate\nvalue accumulated since the worker started working on this WorkItem.\nBy default this is false, indicating that this counter is reported\nas a delta.", |
+ "type": "boolean" |
+ }, |
"floatingPointMean": { |
"$ref": "FloatingPointMean", |
"description": "Floating point mean aggregation value for Mean." |
@@ -4503,15 +4579,15 @@ |
"$ref": "SplitInt64", |
"description": "The count of the number of elements present in the distribution." |
}, |
- "min": { |
- "$ref": "SplitInt64", |
- "description": "The minimum value present in the distribution." |
- }, |
"sumOfSquares": { |
"description": "Use a double since the sum of squares is likely to overflow int64.", |
"format": "double", |
"type": "number" |
}, |
+ "min": { |
+ "$ref": "SplitInt64", |
+ "description": "The minimum value present in the distribution." |
+ }, |
"sum": { |
"$ref": "SplitInt64", |
"description": "Use an int64 since we'd prefer the added precision. If overflow is a common\nproblem we can detect it and use an additional int64 or a double." |
@@ -4558,44 +4634,21 @@ |
"description": "Conveys a worker's progress through the work described by a WorkItem.", |
"id": "WorkItemStatus", |
"properties": { |
- "stopPosition": { |
- "$ref": "Position", |
- "description": "A worker may split an active map task in two parts, \"primary\" and\n\"residual\", continuing to process the primary part and returning the\nresidual part into the pool of available work.\nThis event is called a \"dynamic split\" and is critical to the dynamic\nwork rebalancing feature. The two obtained sub-tasks are called\n\"parts\" of the split.\nThe parts, if concatenated, must represent the same input as would\nbe read by the current task if the split did not happen.\nThe exact way in which the original task is decomposed into the two\nparts is specified either as a position demarcating them\n(stop_position), or explicitly as two DerivedSources, if this\ntask consumes a user-defined source type (dynamic_source_split).\n\nThe \"current\" task is adjusted as a result of the split: after a task\nwith range [A, B) sends a stop_position update at C, its range is\nconsidered to be [A, C), e.g.:\n* Progress should be interpreted relative to the new range, e.g.\n \"75% completed\" means \"75% of [A, C) completed\"\n* The worker should interpret proposed_stop_position relative to the\n new range, e.g. \"split at 68%\" should be interpreted as\n \"split at 68% of [A, C)\".\n* If the worker chooses to split again using stop_position, only\n stop_positions in [A, C) will be accepted.\n* Etc.\ndynamic_source_split has similar semantics: e.g., if a task with\nsource S splits using dynamic_source_split into {P, R}\n(where P and R must be together equivalent to S), then subsequent\nprogress and proposed_stop_position should be interpreted relative\nto P, and in a potential subsequent dynamic_source_split into {P', R'},\nP' and R' must be together equivalent to P, etc." |
- }, |
- "completed": { |
- "description": "True if the WorkItem was completed (successfully or unsuccessfully).", |
- "type": "boolean" |
- }, |
- "reportedProgress": { |
- "$ref": "ApproximateReportedProgress", |
- "description": "The worker's progress through this WorkItem." |
- }, |
- "sourceFork": { |
- "$ref": "SourceFork", |
- "description": "DEPRECATED in favor of dynamic_source_split." |
- }, |
- "counterUpdates": { |
- "description": "Worker output counters for this WorkItem.", |
- "items": { |
- "$ref": "CounterUpdate" |
- }, |
- "type": "array" |
- }, |
"workItemId": { |
"description": "Identifies the WorkItem.", |
"type": "string" |
}, |
- "metricUpdates": { |
- "description": "DEPRECATED in favor of counter_updates.", |
+ "errors": { |
+ "description": "Specifies errors which occurred during processing. If errors are\nprovided, and completed = true, then the WorkItem is considered\nto have failed.", |
"items": { |
- "$ref": "MetricUpdate" |
+ "$ref": "Status" |
}, |
"type": "array" |
}, |
- "errors": { |
- "description": "Specifies errors which occurred during processing. If errors are\nprovided, and completed = true, then the WorkItem is considered\nto have failed.", |
+ "metricUpdates": { |
+ "description": "DEPRECATED in favor of counter_updates.", |
"items": { |
- "$ref": "Status" |
+ "$ref": "MetricUpdate" |
}, |
"type": "array" |
}, |
@@ -4620,6 +4673,29 @@ |
"description": "The report index. When a WorkItem is leased, the lease will\ncontain an initial report index. When a WorkItem's status is\nreported to the system, the report should be sent with\nthat report index, and the response will contain the index the\nworker should use for the next report. Reports received with\nunexpected index values will be rejected by the service.\n\nIn order to preserve idempotency, the worker should not alter the\ncontents of a report, even if the worker must submit the same\nreport multiple times before getting back a response. The worker\nshould not submit a subsequent report until the response for the\nprevious report had been received from the service.", |
"format": "int64", |
"type": "string" |
+ }, |
+ "stopPosition": { |
+ "$ref": "Position", |
+ "description": "A worker may split an active map task in two parts, \"primary\" and\n\"residual\", continuing to process the primary part and returning the\nresidual part into the pool of available work.\nThis event is called a \"dynamic split\" and is critical to the dynamic\nwork rebalancing feature. The two obtained sub-tasks are called\n\"parts\" of the split.\nThe parts, if concatenated, must represent the same input as would\nbe read by the current task if the split did not happen.\nThe exact way in which the original task is decomposed into the two\nparts is specified either as a position demarcating them\n(stop_position), or explicitly as two DerivedSources, if this\ntask consumes a user-defined source type (dynamic_source_split).\n\nThe \"current\" task is adjusted as a result of the split: after a task\nwith range [A, B) sends a stop_position update at C, its range is\nconsidered to be [A, C), e.g.:\n* Progress should be interpreted relative to the new range, e.g.\n \"75% completed\" means \"75% of [A, C) completed\"\n* The worker should interpret proposed_stop_position relative to the\n new range, e.g. \"split at 68%\" should be interpreted as\n \"split at 68% of [A, C)\".\n* If the worker chooses to split again using stop_position, only\n stop_positions in [A, C) will be accepted.\n* Etc.\ndynamic_source_split has similar semantics: e.g., if a task with\nsource S splits using dynamic_source_split into {P, R}\n(where P and R must be together equivalent to S), then subsequent\nprogress and proposed_stop_position should be interpreted relative\nto P, and in a potential subsequent dynamic_source_split into {P', R'},\nP' and R' must be together equivalent to P, etc." |
+ }, |
+ "completed": { |
+ "description": "True if the WorkItem was completed (successfully or unsuccessfully).", |
+ "type": "boolean" |
+ }, |
+ "reportedProgress": { |
+ "$ref": "ApproximateReportedProgress", |
+ "description": "The worker's progress through this WorkItem." |
+ }, |
+ "sourceFork": { |
+ "$ref": "SourceFork", |
+ "description": "DEPRECATED in favor of dynamic_source_split." |
+ }, |
+ "counterUpdates": { |
+ "description": "Worker output counters for this WorkItem.", |
+ "items": { |
+ "$ref": "CounterUpdate" |
+ }, |
+ "type": "array" |
} |
}, |
"type": "object" |
@@ -4647,27 +4723,6 @@ |
"description": "The Dataflow service's idea of the current state of a WorkItem\nbeing processed by a worker.", |
"id": "WorkItemServiceState", |
"properties": { |
- "splitRequest": { |
- "$ref": "ApproximateSplitRequest", |
- "description": "The progress point in the WorkItem where the Dataflow service\nsuggests that the worker truncate the task." |
- }, |
- "reportStatusInterval": { |
- "description": "New recommended reporting interval.", |
- "format": "google-duration", |
- "type": "string" |
- }, |
- "suggestedStopPosition": { |
- "$ref": "Position", |
- "description": "Obsolete, always empty." |
- }, |
- "harnessData": { |
- "additionalProperties": { |
- "description": "Properties of the object.", |
- "type": "any" |
- }, |
- "description": "Other data returned by the service, specific to the particular\nworker harness.", |
- "type": "object" |
- }, |
"leaseExpireTime": { |
"description": "Time at which the current lease will expire.", |
"format": "google-datetime", |
@@ -4688,6 +4743,27 @@ |
"suggestedStopPoint": { |
"$ref": "ApproximateProgress", |
"description": "DEPRECATED in favor of split_request." |
+ }, |
+ "splitRequest": { |
+ "$ref": "ApproximateSplitRequest", |
+ "description": "The progress point in the WorkItem where the Dataflow service\nsuggests that the worker truncate the task." |
+ }, |
+ "suggestedStopPosition": { |
+ "$ref": "Position", |
+ "description": "Obsolete, always empty." |
+ }, |
+ "reportStatusInterval": { |
+ "description": "New recommended reporting interval.", |
+ "format": "google-duration", |
+ "type": "string" |
+ }, |
+ "harnessData": { |
+ "additionalProperties": { |
+ "description": "Properties of the object.", |
+ "type": "any" |
+ }, |
+ "description": "Other data returned by the service, specific to the particular\nworker harness.", |
+ "type": "object" |
} |
}, |
"type": "object" |
@@ -4696,13 +4772,6 @@ |
"description": "Identifies a metric, by describing the source which generated the\nmetric.", |
"id": "MetricStructuredName", |
"properties": { |
- "context": { |
- "additionalProperties": { |
- "type": "string" |
- }, |
- "description": "Zero or more labeled fields which identify the part of the job this\nmetric is associated with, such as the name of a step or collection.\n\nFor example, built-in counters associated with steps will have\ncontext['step'] = <step-name>. Counters associated with PCollections\nin the SDK will have context['pcollection'] = <pcollection-name>.", |
- "type": "object" |
- }, |
"origin": { |
"description": "Origin (namespace) of metric name. May be blank for user-define metrics;\nwill be \"dataflow\" for metrics defined by the Dataflow service or SDK.", |
"type": "string" |
@@ -4710,6 +4779,13 @@ |
"name": { |
"description": "Worker-defined metric name.", |
"type": "string" |
+ }, |
+ "context": { |
+ "additionalProperties": { |
+ "type": "string" |
+ }, |
+ "description": "Zero or more labeled fields which identify the part of the job this\nmetric is associated with, such as the name of a step or collection.\n\nFor example, built-in counters associated with steps will have\ncontext['step'] = <step-name>. Counters associated with PCollections\nin the SDK will have context['pcollection'] = <pcollection-name>.", |
+ "type": "object" |
} |
}, |
"type": "object" |
@@ -4718,13 +4794,13 @@ |
"description": "Information about an output of a SeqMapTask.", |
"id": "SeqMapTaskOutputInfo", |
"properties": { |
- "sink": { |
- "$ref": "Sink", |
- "description": "The sink to write the output value to." |
- }, |
"tag": { |
"description": "The id of the TupleTag the user code will tag the output value by.", |
"type": "string" |
+ }, |
+ "sink": { |
+ "$ref": "Sink", |
+ "description": "The sink to write the output value to." |
} |
}, |
"type": "object" |
@@ -4747,6 +4823,14 @@ |
"description": "Location information for a specific key-range of a sharded computation.\nCurrently we only support UTF-8 character splits to simplify encoding into\nJSON.", |
"id": "KeyRangeLocation", |
"properties": { |
+ "deprecatedPersistentDirectory": { |
+ "description": "DEPRECATED. The location of the persistent state for this range, as a\npersistent directory in the worker local filesystem.", |
+ "type": "string" |
+ }, |
+ "deliveryEndpoint": { |
+ "description": "The physical location of this range assignment to be used for\nstreaming computation cross-worker message delivery.", |
+ "type": "string" |
+ }, |
"start": { |
"description": "The start (inclusive) of the key range.", |
"type": "string" |
@@ -4758,14 +4842,6 @@ |
"end": { |
"description": "The end (exclusive) of the key range.", |
"type": "string" |
- }, |
- "deprecatedPersistentDirectory": { |
- "description": "DEPRECATED. The location of the persistent state for this range, as a\npersistent directory in the worker local filesystem.", |
- "type": "string" |
- }, |
- "deliveryEndpoint": { |
- "description": "The physical location of this range assignment to be used for\nstreaming computation cross-worker message delivery.", |
- "type": "string" |
} |
}, |
"type": "object" |
@@ -4785,14 +4861,6 @@ |
"description": "Describes a particular function to invoke.", |
"id": "SeqMapTask", |
"properties": { |
- "userFn": { |
- "additionalProperties": { |
- "description": "Properties of the object.", |
- "type": "any" |
- }, |
- "description": "The user function to invoke.", |
- "type": "object" |
- }, |
"name": { |
"description": "The user-provided name of the SeqDo operation.", |
"type": "string" |
@@ -4811,13 +4879,21 @@ |
}, |
"type": "array" |
}, |
+ "systemName": { |
+ "description": "System-defined name of the SeqDo operation.\nUnique across the workflow.", |
+ "type": "string" |
+ }, |
"stageName": { |
"description": "System-defined name of the stage containing the SeqDo operation.\nUnique across the workflow.", |
"type": "string" |
}, |
- "systemName": { |
- "description": "System-defined name of the SeqDo operation.\nUnique across the workflow.", |
- "type": "string" |
+ "userFn": { |
+ "additionalProperties": { |
+ "description": "Properties of the object.", |
+ "type": "any" |
+ }, |
+ "description": "The user function to invoke.", |
+ "type": "object" |
} |
}, |
"type": "object" |
@@ -4877,55 +4953,6 @@ |
} |
}, |
"type": "object" |
- }, |
- "CustomSourceLocation": { |
- "description": "Identifies the location of a custom souce.", |
- "id": "CustomSourceLocation", |
- "properties": { |
- "stateful": { |
- "description": "Whether this source is stateful.", |
- "type": "boolean" |
- } |
- }, |
- "type": "object" |
- }, |
- "MapTask": { |
- "description": "MapTask consists of an ordered set of instructions, each of which\ndescribes one particular low-level operation for the worker to\nperform in order to accomplish the MapTask's WorkItem.\n\nEach instruction must appear in the list before any instructions which\ndepends on its output.", |
- "id": "MapTask", |
- "properties": { |
- "systemName": { |
- "description": "System-defined name of this MapTask.\nUnique across the workflow.", |
- "type": "string" |
- }, |
- "stageName": { |
- "description": "System-defined name of the stage containing this MapTask.\nUnique across the workflow.", |
- "type": "string" |
- }, |
- "instructions": { |
- "description": "The instructions in the MapTask.", |
- "items": { |
- "$ref": "ParallelInstruction" |
- }, |
- "type": "array" |
- } |
- }, |
- "type": "object" |
- }, |
- "FloatingPointMean": { |
- "description": "A representation of a floating point mean metric contribution.", |
- "id": "FloatingPointMean", |
- "properties": { |
- "sum": { |
- "description": "The sum of all values being aggregated.", |
- "format": "double", |
- "type": "number" |
- }, |
- "count": { |
- "$ref": "SplitInt64", |
- "description": "The number of values being aggregated." |
- } |
- }, |
- "type": "object" |
} |
}, |
"servicePath": "", |