| Index: discovery/googleapis_beta/dataflow__v1b3.json
|
| diff --git a/discovery/googleapis_beta/dataflow__v1b3.json b/discovery/googleapis_beta/dataflow__v1b3.json
|
| index bf7ba219867df865229fcbf24a21f6dc31cf7c85..7e8d2e5a29e0e254faba1f31129e504121760341 100644
|
| --- a/discovery/googleapis_beta/dataflow__v1b3.json
|
| +++ b/discovery/googleapis_beta/dataflow__v1b3.json
|
| @@ -33,16 +33,6 @@
|
| "ownerDomain": "google.com",
|
| "ownerName": "Google",
|
| "parameters": {
|
| - "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",
|
| @@ -54,13 +44,13 @@
|
| "location": "query",
|
| "type": "boolean"
|
| },
|
| - "oauth_token": {
|
| - "description": "OAuth 2.0 token for the current user.",
|
| + "bearer_token": {
|
| + "description": "OAuth bearer token.",
|
| "location": "query",
|
| "type": "string"
|
| },
|
| - "bearer_token": {
|
| - "description": "OAuth bearer token.",
|
| + "oauth_token": {
|
| + "description": "OAuth 2.0 token for the current user.",
|
| "location": "query",
|
| "type": "string"
|
| },
|
| @@ -118,6 +108,16 @@
|
| ],
|
| "location": "query",
|
| "type": "string"
|
| + },
|
| + "access_token": {
|
| + "description": "OAuth access token.",
|
| + "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"
|
| }
|
| },
|
| "protocol": "rest",
|
| @@ -155,127 +155,6 @@
|
| }
|
| },
|
| "resources": {
|
| - "templates": {
|
| - "methods": {
|
| - "get": {
|
| - "description": "Get the template associated with a template.",
|
| - "httpMethod": "GET",
|
| - "id": "dataflow.projects.templates.get",
|
| - "parameterOrder": [
|
| - "projectId"
|
| - ],
|
| - "parameters": {
|
| - "location": {
|
| - "description": "The location to which to direct the request.",
|
| - "location": "query",
|
| - "type": "string"
|
| - },
|
| - "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\ncreate the job.\nMust be a valid Cloud Storage URL, beginning with `gs://`.",
|
| - "location": "query",
|
| - "type": "string"
|
| - }
|
| - },
|
| - "path": "v1b3/projects/{projectId}/templates:get",
|
| - "response": {
|
| - "$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"
|
| - ]
|
| - },
|
| - "create": {
|
| - "description": "Creates a Cloud Dataflow job from a template.",
|
| - "httpMethod": "POST",
|
| - "id": "dataflow.projects.templates.create",
|
| - "parameterOrder": [
|
| - "projectId"
|
| - ],
|
| - "parameters": {
|
| - "projectId": {
|
| - "description": "Required. The ID of the Cloud Platform project that the job belongs to.",
|
| - "location": "path",
|
| - "required": true,
|
| - "type": "string"
|
| - }
|
| - },
|
| - "path": "v1b3/projects/{projectId}/templates",
|
| - "request": {
|
| - "$ref": "CreateJobFromTemplateRequest"
|
| - },
|
| - "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"
|
| - ]
|
| - },
|
| - "launch": {
|
| - "description": "Launch a template.",
|
| - "httpMethod": "POST",
|
| - "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:launch",
|
| - "request": {
|
| - "$ref": "LaunchTemplateParameters"
|
| - },
|
| - "response": {
|
| - "$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"
|
| - ]
|
| - }
|
| - }
|
| - },
|
| "locations": {
|
| "methods": {
|
| "workerMessages": {
|
| @@ -318,44 +197,44 @@
|
| "resources": {
|
| "templates": {
|
| "methods": {
|
| - "launch": {
|
| - "description": "Launch a template.",
|
| - "httpMethod": "POST",
|
| - "id": "dataflow.projects.locations.templates.launch",
|
| + "get": {
|
| + "description": "Get the template associated with a template.",
|
| + "httpMethod": "GET",
|
| + "id": "dataflow.projects.locations.templates.get",
|
| "parameterOrder": [
|
| "projectId",
|
| "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://'.",
|
| + "view": {
|
| + "description": "The view to retrieve. Defaults to METADATA_ONLY.",
|
| + "enum": [
|
| + "METADATA_ONLY"
|
| + ],
|
| "location": "query",
|
| "type": "string"
|
| },
|
| - "location": {
|
| - "description": "The location to which to direct the request.",
|
| + "projectId": {
|
| + "description": "Required. The ID of the Cloud Platform project that the job belongs to.",
|
| "location": "path",
|
| "required": true,
|
| "type": "string"
|
| },
|
| - "validateOnly": {
|
| - "description": "If true, the request is validated but not actually executed.\nDefaults to false.",
|
| + "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": "boolean"
|
| + "type": "string"
|
| },
|
| - "projectId": {
|
| - "description": "Required. The ID of the Cloud Platform project that the job belongs to.",
|
| + "location": {
|
| + "description": "The location to which to direct the request.",
|
| "location": "path",
|
| "required": true,
|
| "type": "string"
|
| }
|
| },
|
| - "path": "v1b3/projects/{projectId}/locations/{location}/templates:launch",
|
| - "request": {
|
| - "$ref": "LaunchTemplateParameters"
|
| - },
|
| + "path": "v1b3/projects/{projectId}/locations/{location}/templates:get",
|
| "response": {
|
| - "$ref": "LaunchTemplateResponse"
|
| + "$ref": "GetTemplateResponse"
|
| },
|
| "scopes": [
|
| "https://www.googleapis.com/auth/cloud-platform",
|
| @@ -364,10 +243,10 @@
|
| "https://www.googleapis.com/auth/userinfo.email"
|
| ]
|
| },
|
| - "get": {
|
| - "description": "Get the template associated with a template.",
|
| - "httpMethod": "GET",
|
| - "id": "dataflow.projects.locations.templates.get",
|
| + "create": {
|
| + "description": "Creates a Cloud Dataflow job from a template.",
|
| + "httpMethod": "POST",
|
| + "id": "dataflow.projects.locations.templates.create",
|
| "parameterOrder": [
|
| "projectId",
|
| "location"
|
| @@ -384,24 +263,14 @@
|
| "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"
|
| }
|
| },
|
| - "path": "v1b3/projects/{projectId}/locations/{location}/templates:get",
|
| + "path": "v1b3/projects/{projectId}/locations/{location}/templates",
|
| + "request": {
|
| + "$ref": "CreateJobFromTemplateRequest"
|
| + },
|
| "response": {
|
| - "$ref": "GetTemplateResponse"
|
| + "$ref": "Job"
|
| },
|
| "scopes": [
|
| "https://www.googleapis.com/auth/cloud-platform",
|
| @@ -410,19 +279,18 @@
|
| "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.locations.templates.create",
|
| + "id": "dataflow.projects.locations.templates.launch",
|
| "parameterOrder": [
|
| "projectId",
|
| "location"
|
| ],
|
| "parameters": {
|
| - "projectId": {
|
| - "description": "Required. The ID of the Cloud Platform project that the job belongs to.",
|
| - "location": "path",
|
| - "required": true,
|
| + "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": {
|
| @@ -430,14 +298,25 @@
|
| "location": "path",
|
| "required": true,
|
| "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"
|
| }
|
| },
|
| - "path": "v1b3/projects/{projectId}/locations/{location}/templates",
|
| + "path": "v1b3/projects/{projectId}/locations/{location}/templates:launch",
|
| "request": {
|
| - "$ref": "CreateJobFromTemplateRequest"
|
| + "$ref": "LaunchTemplateParameters"
|
| },
|
| "response": {
|
| - "$ref": "Job"
|
| + "$ref": "LaunchTemplateResponse"
|
| },
|
| "scopes": [
|
| "https://www.googleapis.com/auth/cloud-platform",
|
| @@ -450,49 +329,44 @@
|
| },
|
| "jobs": {
|
| "methods": {
|
| - "get": {
|
| - "description": "Gets the state of the specified Cloud Dataflow job.",
|
| + "getMetrics": {
|
| + "description": "Request the job status.",
|
| "httpMethod": "GET",
|
| - "id": "dataflow.projects.locations.jobs.get",
|
| + "id": "dataflow.projects.locations.jobs.getMetrics",
|
| "parameterOrder": [
|
| "projectId",
|
| "location",
|
| "jobId"
|
| ],
|
| "parameters": {
|
| - "projectId": {
|
| - "description": "The ID of the Cloud Platform project that the job belongs to.",
|
| + "location": {
|
| + "description": "The location which contains the job specified by job_id.",
|
| "location": "path",
|
| "required": true,
|
| "type": "string"
|
| },
|
| - "jobId": {
|
| - "description": "The job ID.",
|
| - "location": "path",
|
| - "required": true,
|
| + "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"
|
| },
|
| - "view": {
|
| - "description": "The level of information requested in response.",
|
| - "enum": [
|
| - "JOB_VIEW_UNKNOWN",
|
| - "JOB_VIEW_SUMMARY",
|
| - "JOB_VIEW_ALL",
|
| - "JOB_VIEW_DESCRIPTION"
|
| - ],
|
| - "location": "query",
|
| + "jobId": {
|
| + "description": "The job to get messages for.",
|
| + "location": "path",
|
| + "required": true,
|
| "type": "string"
|
| },
|
| - "location": {
|
| - "description": "The location that contains this job.",
|
| + "projectId": {
|
| + "description": "A project id.",
|
| "location": "path",
|
| "required": true,
|
| "type": "string"
|
| }
|
| },
|
| - "path": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}",
|
| + "path": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/metrics",
|
| "response": {
|
| - "$ref": "Job"
|
| + "$ref": "JobMetrics"
|
| },
|
| "scopes": [
|
| "https://www.googleapis.com/auth/cloud-platform",
|
| @@ -510,6 +384,29 @@
|
| "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",
|
| @@ -531,22 +428,50 @@
|
| ],
|
| "location": "query",
|
| "type": "string"
|
| + }
|
| + },
|
| + "path": "v1b3/projects/{projectId}/locations/{location}/jobs",
|
| + "response": {
|
| + "$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"
|
| + ]
|
| + },
|
| + "get": {
|
| + "description": "Gets the state of the specified Cloud Dataflow job.",
|
| + "httpMethod": "GET",
|
| + "id": "dataflow.projects.locations.jobs.get",
|
| + "parameterOrder": [
|
| + "projectId",
|
| + "location",
|
| + "jobId"
|
| + ],
|
| + "parameters": {
|
| + "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"
|
| },
|
| - "projectId": {
|
| - "description": "The project which owns the jobs.",
|
| + "jobId": {
|
| + "description": "The job ID.",
|
| "location": "path",
|
| "required": true,
|
| "type": "string"
|
| },
|
| - "filter": {
|
| - "description": "The kind of filter to use.",
|
| - "enum": [
|
| - "UNKNOWN",
|
| - "ALL",
|
| - "TERMINATED",
|
| - "ACTIVE"
|
| - ],
|
| - "location": "query",
|
| + "projectId": {
|
| + "description": "The ID of the Cloud Platform project that the job belongs to.",
|
| + "location": "path",
|
| + "required": true,
|
| "type": "string"
|
| },
|
| "location": {
|
| @@ -556,9 +481,9 @@
|
| "type": "string"
|
| }
|
| },
|
| - "path": "v1b3/projects/{projectId}/locations/{location}/jobs",
|
| + "path": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}",
|
| "response": {
|
| - "$ref": "ListJobsResponse"
|
| + "$ref": "Job"
|
| },
|
| "scopes": [
|
| "https://www.googleapis.com/auth/cloud-platform",
|
| @@ -577,14 +502,14 @@
|
| "jobId"
|
| ],
|
| "parameters": {
|
| - "projectId": {
|
| - "description": "The ID of the Cloud Platform project that the job belongs to.",
|
| + "jobId": {
|
| + "description": "The job ID.",
|
| "location": "path",
|
| "required": true,
|
| "type": "string"
|
| },
|
| - "jobId": {
|
| - "description": "The job ID.",
|
| + "projectId": {
|
| + "description": "The ID of the Cloud Platform project that the job belongs to.",
|
| "location": "path",
|
| "required": true,
|
| "type": "string"
|
| @@ -619,10 +544,9 @@
|
| "location"
|
| ],
|
| "parameters": {
|
| - "projectId": {
|
| - "description": "The ID of the Cloud Platform project that the job belongs to.",
|
| - "location": "path",
|
| - "required": true,
|
| + "replaceJobId": {
|
| + "description": "Deprecated. This field is now in the Job message.",
|
| + "location": "query",
|
| "type": "string"
|
| },
|
| "view": {
|
| @@ -636,15 +560,16 @@
|
| "location": "query",
|
| "type": "string"
|
| },
|
| - "location": {
|
| - "description": "The location that contains this job.",
|
| + "projectId": {
|
| + "description": "The ID of the Cloud Platform project that the job belongs to.",
|
| "location": "path",
|
| "required": true,
|
| "type": "string"
|
| },
|
| - "replaceJobId": {
|
| - "description": "Deprecated. This field is now in the Job message.",
|
| - "location": "query",
|
| + "location": {
|
| + "description": "The location that contains this job.",
|
| + "location": "path",
|
| + "required": true,
|
| "type": "string"
|
| }
|
| },
|
| @@ -661,61 +586,15 @@
|
| "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"
|
| - ]
|
| }
|
| },
|
| "resources": {
|
| - "debug": {
|
| + "messages": {
|
| "methods": {
|
| - "getConfig": {
|
| - "description": "Get encoded debug configuration for component. Not cacheable.",
|
| - "httpMethod": "POST",
|
| - "id": "dataflow.projects.locations.jobs.debug.getConfig",
|
| + "list": {
|
| + "description": "Request the job status.",
|
| + "httpMethod": "GET",
|
| + "id": "dataflow.projects.locations.jobs.messages.list",
|
| "parameterOrder": [
|
| "projectId",
|
| "location",
|
| @@ -723,30 +602,63 @@
|
| ],
|
| "parameters": {
|
| "projectId": {
|
| - "description": "The project id.",
|
| + "description": "A project id.",
|
| "location": "path",
|
| "required": true,
|
| "type": "string"
|
| },
|
| "jobId": {
|
| - "description": "The job id.",
|
| + "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",
|
| + "type": "string"
|
| + },
|
| "location": {
|
| "description": "The location which contains the job specified by job_id.",
|
| "location": "path",
|
| "required": true,
|
| "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",
|
| + "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.",
|
| + "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",
|
| + "location": "query",
|
| + "type": "integer"
|
| + },
|
| + "minimumImportance": {
|
| + "description": "Filter to only get messages with importance >= level",
|
| + "enum": [
|
| + "JOB_MESSAGE_IMPORTANCE_UNKNOWN",
|
| + "JOB_MESSAGE_DEBUG",
|
| + "JOB_MESSAGE_DETAILED",
|
| + "JOB_MESSAGE_BASIC",
|
| + "JOB_MESSAGE_WARNING",
|
| + "JOB_MESSAGE_ERROR"
|
| + ],
|
| + "location": "query",
|
| + "type": "string"
|
| }
|
| },
|
| - "path": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/debug/getConfig",
|
| - "request": {
|
| - "$ref": "GetDebugConfigRequest"
|
| - },
|
| + "path": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/messages",
|
| "response": {
|
| - "$ref": "GetDebugConfigResponse"
|
| + "$ref": "ListJobMessagesResponse"
|
| },
|
| "scopes": [
|
| "https://www.googleapis.com/auth/cloud-platform",
|
| @@ -754,42 +666,46 @@
|
| "https://www.googleapis.com/auth/compute.readonly",
|
| "https://www.googleapis.com/auth/userinfo.email"
|
| ]
|
| - },
|
| - "sendCapture": {
|
| - "description": "Send encoded debug capture data for component.",
|
| + }
|
| + }
|
| + },
|
| + "workItems": {
|
| + "methods": {
|
| + "lease": {
|
| + "description": "Leases a dataflow WorkItem to run.",
|
| "httpMethod": "POST",
|
| - "id": "dataflow.projects.locations.jobs.debug.sendCapture",
|
| + "id": "dataflow.projects.locations.jobs.workItems.lease",
|
| "parameterOrder": [
|
| "projectId",
|
| "location",
|
| "jobId"
|
| ],
|
| "parameters": {
|
| - "projectId": {
|
| - "description": "The project id.",
|
| + "jobId": {
|
| + "description": "Identifies the workflow job this worker belongs to.",
|
| "location": "path",
|
| "required": true,
|
| "type": "string"
|
| },
|
| - "jobId": {
|
| - "description": "The job id.",
|
| + "projectId": {
|
| + "description": "Identifies the project this worker belongs to.",
|
| "location": "path",
|
| "required": true,
|
| "type": "string"
|
| },
|
| "location": {
|
| - "description": "The location which contains the job specified by job_id.",
|
| + "description": "The location which contains the WorkItem's job.",
|
| "location": "path",
|
| "required": true,
|
| "type": "string"
|
| }
|
| },
|
| - "path": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/debug/sendCapture",
|
| + "path": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/workItems:lease",
|
| "request": {
|
| - "$ref": "SendDebugCaptureRequest"
|
| + "$ref": "LeaseWorkItemRequest"
|
| },
|
| "response": {
|
| - "$ref": "SendDebugCaptureResponse"
|
| + "$ref": "LeaseWorkItemResponse"
|
| },
|
| "scopes": [
|
| "https://www.googleapis.com/auth/cloud-platform",
|
| @@ -797,11 +713,7 @@
|
| "https://www.googleapis.com/auth/compute.readonly",
|
| "https://www.googleapis.com/auth/userinfo.email"
|
| ]
|
| - }
|
| - }
|
| - },
|
| - "workItems": {
|
| - "methods": {
|
| + },
|
| "reportStatus": {
|
| "description": "Reports the status of dataflow WorkItems leased by a worker.",
|
| "httpMethod": "POST",
|
| @@ -812,14 +724,14 @@
|
| "jobId"
|
| ],
|
| "parameters": {
|
| - "projectId": {
|
| - "description": "The project which owns the WorkItem's job.",
|
| + "jobId": {
|
| + "description": "The job which the WorkItem is part of.",
|
| "location": "path",
|
| "required": true,
|
| "type": "string"
|
| },
|
| - "jobId": {
|
| - "description": "The job which the WorkItem is part of.",
|
| + "projectId": {
|
| + "description": "The project which owns the WorkItem's job.",
|
| "location": "path",
|
| "required": true,
|
| "type": "string"
|
| @@ -844,11 +756,15 @@
|
| "https://www.googleapis.com/auth/compute.readonly",
|
| "https://www.googleapis.com/auth/userinfo.email"
|
| ]
|
| - },
|
| - "lease": {
|
| - "description": "Leases a dataflow WorkItem to run.",
|
| + }
|
| + }
|
| + },
|
| + "debug": {
|
| + "methods": {
|
| + "sendCapture": {
|
| + "description": "Send encoded debug capture data for component.",
|
| "httpMethod": "POST",
|
| - "id": "dataflow.projects.locations.jobs.workItems.lease",
|
| + "id": "dataflow.projects.locations.jobs.debug.sendCapture",
|
| "parameterOrder": [
|
| "projectId",
|
| "location",
|
| @@ -856,30 +772,30 @@
|
| ],
|
| "parameters": {
|
| "location": {
|
| - "description": "The location which contains the WorkItem's job.",
|
| + "description": "The location which contains the job specified by job_id.",
|
| "location": "path",
|
| "required": true,
|
| "type": "string"
|
| },
|
| - "projectId": {
|
| - "description": "Identifies the project this worker belongs to.",
|
| + "jobId": {
|
| + "description": "The job id.",
|
| "location": "path",
|
| "required": true,
|
| "type": "string"
|
| },
|
| - "jobId": {
|
| - "description": "Identifies the workflow job this worker belongs to.",
|
| + "projectId": {
|
| + "description": "The project id.",
|
| "location": "path",
|
| "required": true,
|
| "type": "string"
|
| }
|
| },
|
| - "path": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/workItems:lease",
|
| + "path": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/debug/sendCapture",
|
| "request": {
|
| - "$ref": "LeaseWorkItemRequest"
|
| + "$ref": "SendDebugCaptureRequest"
|
| },
|
| "response": {
|
| - "$ref": "LeaseWorkItemResponse"
|
| + "$ref": "SendDebugCaptureResponse"
|
| },
|
| "scopes": [
|
| "https://www.googleapis.com/auth/cloud-platform",
|
| @@ -887,79 +803,42 @@
|
| "https://www.googleapis.com/auth/compute.readonly",
|
| "https://www.googleapis.com/auth/userinfo.email"
|
| ]
|
| - }
|
| - }
|
| - },
|
| - "messages": {
|
| - "methods": {
|
| - "list": {
|
| - "description": "Request the job status.",
|
| - "httpMethod": "GET",
|
| - "id": "dataflow.projects.locations.jobs.messages.list",
|
| + },
|
| + "getConfig": {
|
| + "description": "Get encoded debug configuration for component. Not cacheable.",
|
| + "httpMethod": "POST",
|
| + "id": "dataflow.projects.locations.jobs.debug.getConfig",
|
| "parameterOrder": [
|
| "projectId",
|
| "location",
|
| "jobId"
|
| ],
|
| "parameters": {
|
| - "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",
|
| - "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.",
|
| - "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",
|
| - "location": "query",
|
| - "type": "integer"
|
| - },
|
| - "minimumImportance": {
|
| - "description": "Filter to only get messages with importance >= level",
|
| - "enum": [
|
| - "JOB_MESSAGE_IMPORTANCE_UNKNOWN",
|
| - "JOB_MESSAGE_DEBUG",
|
| - "JOB_MESSAGE_DETAILED",
|
| - "JOB_MESSAGE_BASIC",
|
| - "JOB_MESSAGE_WARNING",
|
| - "JOB_MESSAGE_ERROR"
|
| - ],
|
| - "location": "query",
|
| - "type": "string"
|
| - },
|
| - "jobId": {
|
| - "description": "The job to get messages about.",
|
| + "location": {
|
| + "description": "The location which contains the job specified by job_id.",
|
| "location": "path",
|
| "required": true,
|
| "type": "string"
|
| },
|
| - "projectId": {
|
| - "description": "A project id.",
|
| + "jobId": {
|
| + "description": "The 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"
|
| - },
|
| - "location": {
|
| - "description": "The location which contains the job specified by job_id.",
|
| + "projectId": {
|
| + "description": "The project id.",
|
| "location": "path",
|
| "required": true,
|
| "type": "string"
|
| }
|
| },
|
| - "path": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/messages",
|
| + "path": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/debug/getConfig",
|
| + "request": {
|
| + "$ref": "GetDebugConfigRequest"
|
| + },
|
| "response": {
|
| - "$ref": "ListJobMessagesResponse"
|
| + "$ref": "GetDebugConfigResponse"
|
| },
|
| "scopes": [
|
| "https://www.googleapis.com/auth/cloud-platform",
|
| @@ -974,41 +853,44 @@
|
| }
|
| }
|
| },
|
| - "jobs": {
|
| + "templates": {
|
| "methods": {
|
| - "update": {
|
| - "description": "Updates the state of an existing Cloud Dataflow job.",
|
| - "httpMethod": "PUT",
|
| - "id": "dataflow.projects.jobs.update",
|
| + "launch": {
|
| + "description": "Launch a template.",
|
| + "httpMethod": "POST",
|
| + "id": "dataflow.projects.templates.launch",
|
| "parameterOrder": [
|
| - "projectId",
|
| - "jobId"
|
| + "projectId"
|
| ],
|
| "parameters": {
|
| - "projectId": {
|
| - "description": "The ID of the Cloud Platform project that the job belongs to.",
|
| - "location": "path",
|
| - "required": true,
|
| + "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"
|
| },
|
| - "jobId": {
|
| - "description": "The job ID.",
|
| - "location": "path",
|
| - "required": true,
|
| + "location": {
|
| + "description": "The location to which to direct the request.",
|
| + "location": "query",
|
| "type": "string"
|
| },
|
| - "location": {
|
| - "description": "The location that contains this job.",
|
| + "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"
|
| }
|
| },
|
| - "path": "v1b3/projects/{projectId}/jobs/{jobId}",
|
| + "path": "v1b3/projects/{projectId}/templates:launch",
|
| "request": {
|
| - "$ref": "Job"
|
| + "$ref": "LaunchTemplateParameters"
|
| },
|
| "response": {
|
| - "$ref": "Job"
|
| + "$ref": "LaunchTemplateResponse"
|
| },
|
| "scopes": [
|
| "https://www.googleapis.com/auth/cloud-platform",
|
| @@ -1017,48 +899,42 @@
|
| "https://www.googleapis.com/auth/userinfo.email"
|
| ]
|
| },
|
| - "create": {
|
| - "description": "Creates a Cloud Dataflow job.",
|
| - "httpMethod": "POST",
|
| - "id": "dataflow.projects.jobs.create",
|
| + "get": {
|
| + "description": "Get the template associated with a template.",
|
| + "httpMethod": "GET",
|
| + "id": "dataflow.projects.templates.get",
|
| "parameterOrder": [
|
| "projectId"
|
| ],
|
| "parameters": {
|
| - "projectId": {
|
| - "description": "The ID of the Cloud Platform project that the job belongs to.",
|
| - "location": "path",
|
| - "required": true,
|
| - "type": "string"
|
| - },
|
| "view": {
|
| - "description": "The level of information requested in response.",
|
| + "description": "The view to retrieve. Defaults to METADATA_ONLY.",
|
| "enum": [
|
| - "JOB_VIEW_UNKNOWN",
|
| - "JOB_VIEW_SUMMARY",
|
| - "JOB_VIEW_ALL",
|
| - "JOB_VIEW_DESCRIPTION"
|
| + "METADATA_ONLY"
|
| ],
|
| "location": "query",
|
| "type": "string"
|
| },
|
| - "location": {
|
| - "description": "The location that contains this job.",
|
| + "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\ncreate the job.\nMust be a valid Cloud Storage URL, beginning with `gs://`.",
|
| "location": "query",
|
| "type": "string"
|
| },
|
| - "replaceJobId": {
|
| - "description": "Deprecated. This field is now in the Job message.",
|
| + "location": {
|
| + "description": "The location to which to direct the request.",
|
| "location": "query",
|
| "type": "string"
|
| }
|
| },
|
| - "path": "v1b3/projects/{projectId}/jobs",
|
| - "request": {
|
| - "$ref": "Job"
|
| - },
|
| + "path": "v1b3/projects/{projectId}/templates:get",
|
| "response": {
|
| - "$ref": "Job"
|
| + "$ref": "GetTemplateResponse"
|
| },
|
| "scopes": [
|
| "https://www.googleapis.com/auth/cloud-platform",
|
| @@ -1067,42 +943,27 @@
|
| "https://www.googleapis.com/auth/userinfo.email"
|
| ]
|
| },
|
| - "getMetrics": {
|
| - "description": "Request the job status.",
|
| - "httpMethod": "GET",
|
| - "id": "dataflow.projects.jobs.getMetrics",
|
| + "create": {
|
| + "description": "Creates a Cloud Dataflow job from a template.",
|
| + "httpMethod": "POST",
|
| + "id": "dataflow.projects.templates.create",
|
| "parameterOrder": [
|
| - "projectId",
|
| - "jobId"
|
| + "projectId"
|
| ],
|
| "parameters": {
|
| - "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.",
|
| + "description": "Required. The ID of the Cloud Platform project that the job belongs to.",
|
| "location": "path",
|
| "required": true,
|
| "type": "string"
|
| - },
|
| - "location": {
|
| - "description": "The location which contains the job specified by job_id.",
|
| - "location": "query",
|
| - "type": "string"
|
| }
|
| },
|
| - "path": "v1b3/projects/{projectId}/jobs/{jobId}/metrics",
|
| + "path": "v1b3/projects/{projectId}/templates",
|
| + "request": {
|
| + "$ref": "CreateJobFromTemplateRequest"
|
| + },
|
| "response": {
|
| - "$ref": "JobMetrics"
|
| + "$ref": "Job"
|
| },
|
| "scopes": [
|
| "https://www.googleapis.com/auth/cloud-platform",
|
| @@ -1110,28 +971,84 @@
|
| "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.",
|
| + }
|
| + }
|
| + },
|
| + "jobs": {
|
| + "methods": {
|
| + "list": {
|
| + "description": "List the jobs of a project.",
|
| "httpMethod": "GET",
|
| - "id": "dataflow.projects.jobs.get",
|
| + "id": "dataflow.projects.jobs.list",
|
| "parameterOrder": [
|
| - "projectId",
|
| - "jobId"
|
| + "projectId"
|
| ],
|
| "parameters": {
|
| - "projectId": {
|
| - "description": "The ID of the Cloud Platform project that the job belongs to.",
|
| - "location": "path",
|
| - "required": true,
|
| + "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": "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"
|
| },
|
| - "jobId": {
|
| - "description": "The job ID.",
|
| + "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": "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"
|
| + }
|
| + },
|
| + "path": "v1b3/projects/{projectId}/jobs",
|
| + "response": {
|
| + "$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"
|
| + ]
|
| + },
|
| + "get": {
|
| + "description": "Gets the state of the specified Cloud Dataflow job.",
|
| + "httpMethod": "GET",
|
| + "id": "dataflow.projects.jobs.get",
|
| + "parameterOrder": [
|
| + "projectId",
|
| + "jobId"
|
| + ],
|
| + "parameters": {
|
| "view": {
|
| "description": "The level of information requested in response.",
|
| "enum": [
|
| @@ -1143,6 +1060,18 @@
|
| "location": "query",
|
| "type": "string"
|
| },
|
| + "jobId": {
|
| + "description": "The job ID.",
|
| + "location": "path",
|
| + "required": true,
|
| + "type": "string"
|
| + },
|
| + "projectId": {
|
| + "description": "The ID of the Cloud Platform project that the job belongs to.",
|
| + "location": "path",
|
| + "required": true,
|
| + "type": "string"
|
| + },
|
| "location": {
|
| "description": "The location that contains this job.",
|
| "location": "query",
|
| @@ -1160,32 +1089,67 @@
|
| "https://www.googleapis.com/auth/userinfo.email"
|
| ]
|
| },
|
| - "list": {
|
| - "description": "List the jobs of a project.",
|
| - "httpMethod": "GET",
|
| - "id": "dataflow.projects.jobs.list",
|
| + "update": {
|
| + "description": "Updates the state of an existing Cloud Dataflow job.",
|
| + "httpMethod": "PUT",
|
| + "id": "dataflow.projects.jobs.update",
|
| "parameterOrder": [
|
| - "projectId"
|
| + "projectId",
|
| + "jobId"
|
| ],
|
| "parameters": {
|
| + "jobId": {
|
| + "description": "The job ID.",
|
| + "location": "path",
|
| + "required": true,
|
| + "type": "string"
|
| + },
|
| + "projectId": {
|
| + "description": "The ID of the Cloud Platform project that the job belongs to.",
|
| + "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.",
|
| + }
|
| + },
|
| + "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",
|
| + "parameterOrder": [
|
| + "projectId"
|
| + ],
|
| + "parameters": {
|
| + "location": {
|
| + "description": "The location that contains this job.",
|
| "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",
|
| + "replaceJobId": {
|
| + "description": "Deprecated. This field is now in the Job message.",
|
| "location": "query",
|
| - "type": "integer"
|
| + "type": "string"
|
| },
|
| "view": {
|
| - "description": "Level of information requested in response. Default is `JOB_VIEW_SUMMARY`.",
|
| + "description": "The level of information requested in response.",
|
| "enum": [
|
| "JOB_VIEW_UNKNOWN",
|
| "JOB_VIEW_SUMMARY",
|
| @@ -1196,26 +1160,62 @@
|
| "type": "string"
|
| },
|
| "projectId": {
|
| - "description": "The project which owns the jobs.",
|
| + "description": "The ID of the Cloud Platform project that the job belongs to.",
|
| "location": "path",
|
| "required": true,
|
| "type": "string"
|
| + }
|
| + },
|
| + "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"
|
| + ]
|
| + },
|
| + "getMetrics": {
|
| + "description": "Request the job status.",
|
| + "httpMethod": "GET",
|
| + "id": "dataflow.projects.jobs.getMetrics",
|
| + "parameterOrder": [
|
| + "projectId",
|
| + "jobId"
|
| + ],
|
| + "parameters": {
|
| + "location": {
|
| + "description": "The location which contains the job specified by job_id.",
|
| + "location": "query",
|
| + "type": "string"
|
| },
|
| - "filter": {
|
| - "description": "The kind of filter to use.",
|
| - "enum": [
|
| - "UNKNOWN",
|
| - "ALL",
|
| - "TERMINATED",
|
| - "ACTIVE"
|
| - ],
|
| + "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"
|
| + },
|
| + "jobId": {
|
| + "description": "The job to get messages for.",
|
| + "location": "path",
|
| + "required": true,
|
| + "type": "string"
|
| + },
|
| + "projectId": {
|
| + "description": "A project id.",
|
| + "location": "path",
|
| + "required": true,
|
| + "type": "string"
|
| }
|
| },
|
| - "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",
|
| @@ -1226,36 +1226,36 @@
|
| }
|
| },
|
| "resources": {
|
| - "debug": {
|
| + "workItems": {
|
| "methods": {
|
| - "getConfig": {
|
| - "description": "Get encoded debug configuration for component. Not cacheable.",
|
| + "lease": {
|
| + "description": "Leases a dataflow WorkItem to run.",
|
| "httpMethod": "POST",
|
| - "id": "dataflow.projects.jobs.debug.getConfig",
|
| + "id": "dataflow.projects.jobs.workItems.lease",
|
| "parameterOrder": [
|
| "projectId",
|
| "jobId"
|
| ],
|
| "parameters": {
|
| - "projectId": {
|
| - "description": "The project id.",
|
| + "jobId": {
|
| + "description": "Identifies the workflow job this worker belongs to.",
|
| "location": "path",
|
| "required": true,
|
| "type": "string"
|
| },
|
| - "jobId": {
|
| - "description": "The job id.",
|
| + "projectId": {
|
| + "description": "Identifies the project this worker belongs to.",
|
| "location": "path",
|
| "required": true,
|
| "type": "string"
|
| }
|
| },
|
| - "path": "v1b3/projects/{projectId}/jobs/{jobId}/debug/getConfig",
|
| + "path": "v1b3/projects/{projectId}/jobs/{jobId}/workItems:lease",
|
| "request": {
|
| - "$ref": "GetDebugConfigRequest"
|
| + "$ref": "LeaseWorkItemRequest"
|
| },
|
| "response": {
|
| - "$ref": "GetDebugConfigResponse"
|
| + "$ref": "LeaseWorkItemResponse"
|
| },
|
| "scopes": [
|
| "https://www.googleapis.com/auth/cloud-platform",
|
| @@ -1264,34 +1264,34 @@
|
| "https://www.googleapis.com/auth/userinfo.email"
|
| ]
|
| },
|
| - "sendCapture": {
|
| - "description": "Send encoded debug capture data for component.",
|
| + "reportStatus": {
|
| + "description": "Reports the status of dataflow WorkItems leased by a worker.",
|
| "httpMethod": "POST",
|
| - "id": "dataflow.projects.jobs.debug.sendCapture",
|
| + "id": "dataflow.projects.jobs.workItems.reportStatus",
|
| "parameterOrder": [
|
| "projectId",
|
| "jobId"
|
| ],
|
| "parameters": {
|
| - "projectId": {
|
| - "description": "The project id.",
|
| + "jobId": {
|
| + "description": "The job which the WorkItem is part of.",
|
| "location": "path",
|
| "required": true,
|
| "type": "string"
|
| },
|
| - "jobId": {
|
| - "description": "The job id.",
|
| + "projectId": {
|
| + "description": "The project which owns the WorkItem's job.",
|
| "location": "path",
|
| "required": true,
|
| "type": "string"
|
| }
|
| },
|
| - "path": "v1b3/projects/{projectId}/jobs/{jobId}/debug/sendCapture",
|
| + "path": "v1b3/projects/{projectId}/jobs/{jobId}/workItems:reportStatus",
|
| "request": {
|
| - "$ref": "SendDebugCaptureRequest"
|
| + "$ref": "ReportWorkItemStatusRequest"
|
| },
|
| "response": {
|
| - "$ref": "SendDebugCaptureResponse"
|
| + "$ref": "ReportWorkItemStatusResponse"
|
| },
|
| "scopes": [
|
| "https://www.googleapis.com/auth/cloud-platform",
|
| @@ -1302,36 +1302,36 @@
|
| }
|
| }
|
| },
|
| - "workItems": {
|
| + "debug": {
|
| "methods": {
|
| - "reportStatus": {
|
| - "description": "Reports the status of dataflow WorkItems leased by a worker.",
|
| + "sendCapture": {
|
| + "description": "Send encoded debug capture data for component.",
|
| "httpMethod": "POST",
|
| - "id": "dataflow.projects.jobs.workItems.reportStatus",
|
| + "id": "dataflow.projects.jobs.debug.sendCapture",
|
| "parameterOrder": [
|
| "projectId",
|
| "jobId"
|
| ],
|
| "parameters": {
|
| - "projectId": {
|
| - "description": "The project which owns the WorkItem's job.",
|
| + "jobId": {
|
| + "description": "The job id.",
|
| "location": "path",
|
| "required": true,
|
| "type": "string"
|
| },
|
| - "jobId": {
|
| - "description": "The job which the WorkItem is part of.",
|
| + "projectId": {
|
| + "description": "The project id.",
|
| "location": "path",
|
| "required": true,
|
| "type": "string"
|
| }
|
| },
|
| - "path": "v1b3/projects/{projectId}/jobs/{jobId}/workItems:reportStatus",
|
| + "path": "v1b3/projects/{projectId}/jobs/{jobId}/debug/sendCapture",
|
| "request": {
|
| - "$ref": "ReportWorkItemStatusRequest"
|
| + "$ref": "SendDebugCaptureRequest"
|
| },
|
| "response": {
|
| - "$ref": "ReportWorkItemStatusResponse"
|
| + "$ref": "SendDebugCaptureResponse"
|
| },
|
| "scopes": [
|
| "https://www.googleapis.com/auth/cloud-platform",
|
| @@ -1340,34 +1340,34 @@
|
| "https://www.googleapis.com/auth/userinfo.email"
|
| ]
|
| },
|
| - "lease": {
|
| - "description": "Leases a dataflow WorkItem to run.",
|
| + "getConfig": {
|
| + "description": "Get encoded debug configuration for component. Not cacheable.",
|
| "httpMethod": "POST",
|
| - "id": "dataflow.projects.jobs.workItems.lease",
|
| + "id": "dataflow.projects.jobs.debug.getConfig",
|
| "parameterOrder": [
|
| "projectId",
|
| "jobId"
|
| ],
|
| "parameters": {
|
| - "projectId": {
|
| - "description": "Identifies the project this worker belongs to.",
|
| + "jobId": {
|
| + "description": "The job id.",
|
| "location": "path",
|
| "required": true,
|
| "type": "string"
|
| },
|
| - "jobId": {
|
| - "description": "Identifies the workflow job this worker belongs to.",
|
| + "projectId": {
|
| + "description": "The project id.",
|
| "location": "path",
|
| "required": true,
|
| "type": "string"
|
| }
|
| },
|
| - "path": "v1b3/projects/{projectId}/jobs/{jobId}/workItems:lease",
|
| + "path": "v1b3/projects/{projectId}/jobs/{jobId}/debug/getConfig",
|
| "request": {
|
| - "$ref": "LeaseWorkItemRequest"
|
| + "$ref": "GetDebugConfigRequest"
|
| },
|
| "response": {
|
| - "$ref": "LeaseWorkItemResponse"
|
| + "$ref": "GetDebugConfigResponse"
|
| },
|
| "scopes": [
|
| "https://www.googleapis.com/auth/cloud-platform",
|
| @@ -1389,33 +1389,14 @@
|
| "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": [
|
| - "JOB_MESSAGE_IMPORTANCE_UNKNOWN",
|
| - "JOB_MESSAGE_DEBUG",
|
| - "JOB_MESSAGE_DETAILED",
|
| - "JOB_MESSAGE_BASIC",
|
| - "JOB_MESSAGE_WARNING",
|
| - "JOB_MESSAGE_ERROR"
|
| - ],
|
| - "location": "query",
|
| - "type": "string"
|
| - },
|
| - "jobId": {
|
| - "description": "The job to get messages about.",
|
| + "projectId": {
|
| + "description": "A project id.",
|
| "location": "path",
|
| "required": true,
|
| "type": "string"
|
| },
|
| - "projectId": {
|
| - "description": "A project id.",
|
| + "jobId": {
|
| + "description": "The job to get messages about.",
|
| "location": "path",
|
| "required": true,
|
| "type": "string"
|
| @@ -1441,6 +1422,25 @@
|
| "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": "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",
|
| + "location": "query",
|
| + "type": "integer"
|
| + },
|
| + "minimumImportance": {
|
| + "description": "Filter to only get messages with importance >= level",
|
| + "enum": [
|
| + "JOB_MESSAGE_IMPORTANCE_UNKNOWN",
|
| + "JOB_MESSAGE_DEBUG",
|
| + "JOB_MESSAGE_DETAILED",
|
| + "JOB_MESSAGE_BASIC",
|
| + "JOB_MESSAGE_WARNING",
|
| + "JOB_MESSAGE_ERROR"
|
| + ],
|
| + "location": "query",
|
| + "type": "string"
|
| }
|
| },
|
| "path": "v1b3/projects/{projectId}/jobs/{jobId}/messages",
|
| @@ -1461,332 +1461,582 @@
|
| }
|
| }
|
| },
|
| - "revision": "20170606",
|
| + "revision": "20170701",
|
| "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",
|
| + "ComponentSource": {
|
| + "description": "Description of an interstitial value between transforms in an execution\nstage.",
|
| + "id": "ComponentSource",
|
| "properties": {
|
| - "systemName": {
|
| - "description": "System-defined name of this MapTask.\nUnique across the workflow.",
|
| + "userName": {
|
| + "description": "Human-readable name for this transform; may be user or system generated.",
|
| "type": "string"
|
| },
|
| - "stageName": {
|
| - "description": "System-defined name of the stage containing this MapTask.\nUnique across the workflow.",
|
| + "originalTransformOrCollection": {
|
| + "description": "User name for the original user transform or collection with which this\nsource is most closely associated.",
|
| "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"
|
| + "name": {
|
| + "description": "Dataflow service generated name for this source.",
|
| + "type": "string"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "ReportWorkItemStatusResponse": {
|
| - "description": "Response from a request to report the status of WorkItems.",
|
| - "id": "ReportWorkItemStatusResponse",
|
| + "WorkItemServiceState": {
|
| + "description": "The Dataflow service's idea of the current state of a WorkItem\nbeing processed by a worker.",
|
| + "id": "WorkItemServiceState",
|
| "properties": {
|
| - "workItemServiceStates": {
|
| - "description": "A set of messages indicating the service-side state for each\nWorkItem whose status was reported, in the same order as the\nWorkItemStatus messages in the ReportWorkItemStatusRequest which\nresulting in this response.",
|
| + "metricShortId": {
|
| + "description": "The short ids that workers should use in subsequent metric updates.\nWorkers should strive to use short ids whenever possible, but it is ok\nto request the short_id again if a worker lost track of it\n(e.g. if the worker is recovering from a crash).\nNOTE: it is possible that the response may have short ids for a subset\nof the metrics.",
|
| "items": {
|
| - "$ref": "WorkItemServiceState"
|
| + "$ref": "MetricShortId"
|
| },
|
| "type": "array"
|
| - }
|
| - },
|
| - "type": "object"
|
| - },
|
| - "InstructionOutput": {
|
| - "description": "An output of an instruction.",
|
| - "id": "InstructionOutput",
|
| - "properties": {
|
| - "systemName": {
|
| - "description": "System-defined name of this output.\nUnique across the workflow.",
|
| + },
|
| + "nextReportIndex": {
|
| + "description": "The index value to use for the next report sent by the worker.\nNote: If the report call fails for whatever reason, the worker should\nreuse this index for subsequent report attempts.",
|
| + "format": "int64",
|
| "type": "string"
|
| },
|
| - "onlyCountKeyBytes": {
|
| - "description": "For system-generated byte and mean byte metrics, certain instructions\nshould only report the key size.",
|
| - "type": "boolean"
|
| + "suggestedStopPoint": {
|
| + "$ref": "ApproximateProgress",
|
| + "description": "DEPRECATED in favor of split_request."
|
| },
|
| - "onlyCountValueBytes": {
|
| - "description": "For system-generated byte and mean byte metrics, certain instructions\nshould only report the value size.",
|
| - "type": "boolean"
|
| + "splitRequest": {
|
| + "$ref": "ApproximateSplitRequest",
|
| + "description": "The progress point in the WorkItem where the Dataflow service\nsuggests that the worker truncate the task."
|
| },
|
| - "codec": {
|
| + "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": "The codec to use to encode data being written via this output.",
|
| + "description": "Other data returned by the service, specific to the particular\nworker harness.",
|
| "type": "object"
|
| },
|
| - "name": {
|
| - "description": "The user-provided name of this output.",
|
| - "type": "string"
|
| - },
|
| - "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.",
|
| + "leaseExpireTime": {
|
| + "description": "Time at which the current lease will expire.",
|
| + "format": "google-datetime",
|
| "type": "string"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "CreateJobFromTemplateRequest": {
|
| - "description": "A request to create a Cloud Dataflow job from a template.",
|
| - "id": "CreateJobFromTemplateRequest",
|
| + "MetricStructuredName": {
|
| + "description": "Identifies a metric, by describing the source which generated the\nmetric.",
|
| + "id": "MetricStructuredName",
|
| "properties": {
|
| - "environment": {
|
| - "$ref": "RuntimeEnvironment",
|
| - "description": "The runtime environment for the job."
|
| - },
|
| - "location": {
|
| - "description": "The location to which to direct the request.",
|
| - "type": "string"
|
| - },
|
| - "parameters": {
|
| + "context": {
|
| "additionalProperties": {
|
| "type": "string"
|
| },
|
| - "description": "The runtime parameters to pass to the job.",
|
| + "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"
|
| },
|
| - "jobName": {
|
| - "description": "Required. The job name to use for the created job.",
|
| + "name": {
|
| + "description": "Worker-defined metric name.",
|
| "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://`.",
|
| + "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"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "IntegerMean": {
|
| - "description": "A representation of an integer mean metric contribution.",
|
| - "id": "IntegerMean",
|
| + "SeqMapTaskOutputInfo": {
|
| + "description": "Information about an output of a SeqMapTask.",
|
| + "id": "SeqMapTaskOutputInfo",
|
| "properties": {
|
| - "sum": {
|
| - "$ref": "SplitInt64",
|
| - "description": "The sum of all values being aggregated."
|
| + "tag": {
|
| + "description": "The id of the TupleTag the user code will tag the output value by.",
|
| + "type": "string"
|
| },
|
| - "count": {
|
| - "$ref": "SplitInt64",
|
| - "description": "The number of values being aggregated."
|
| + "sink": {
|
| + "$ref": "Sink",
|
| + "description": "The sink to write the output value to."
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "ListJobsResponse": {
|
| - "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",
|
| + "JobExecutionStageInfo": {
|
| + "description": "Contains information about how a particular\ngoogle.dataflow.v1beta3.Step will be executed.",
|
| + "id": "JobExecutionStageInfo",
|
| "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"
|
| - },
|
| - "failedLocation": {
|
| - "description": "Zero or more messages describing locations that failed to respond.",
|
| + "stepName": {
|
| + "description": "The steps associated with the execution stage.\nNote that stages may have several steps, and that a given step\nmight be run by more than one stage.",
|
| "items": {
|
| - "$ref": "FailedLocation"
|
| + "type": "string"
|
| },
|
| "type": "array"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "ComputationTopology": {
|
| - "description": "All configuration data for a particular Computation.",
|
| - "id": "ComputationTopology",
|
| + "KeyRangeLocation": {
|
| + "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": {
|
| - "computationId": {
|
| - "description": "The ID of the computation.",
|
| + "end": {
|
| + "description": "The end (exclusive) of the key range.",
|
| "type": "string"
|
| },
|
| - "inputs": {
|
| - "description": "The inputs to the computation.",
|
| - "items": {
|
| - "$ref": "StreamLocation"
|
| - },
|
| - "type": "array"
|
| - },
|
| - "keyRanges": {
|
| - "description": "The key ranges processed by the computation.",
|
| - "items": {
|
| - "$ref": "KeyRangeLocation"
|
| - },
|
| - "type": "array"
|
| + "deprecatedPersistentDirectory": {
|
| + "description": "DEPRECATED. The location of the persistent state for this range, as a\npersistent directory in the worker local filesystem.",
|
| + "type": "string"
|
| },
|
| - "stateFamilies": {
|
| - "description": "The state family values.",
|
| - "items": {
|
| - "$ref": "StateFamilyConfig"
|
| - },
|
| - "type": "array"
|
| + "deliveryEndpoint": {
|
| + "description": "The physical location of this range assignment to be used for\nstreaming computation cross-worker message delivery.",
|
| + "type": "string"
|
| },
|
| - "outputs": {
|
| - "description": "The outputs from the computation.",
|
| - "items": {
|
| - "$ref": "StreamLocation"
|
| - },
|
| - "type": "array"
|
| + "dataDisk": {
|
| + "description": "The name of the data disk where data for this range is stored.\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"
|
| },
|
| - "systemStageName": {
|
| - "description": "The system stage name.",
|
| + "start": {
|
| + "description": "The start (inclusive) of the key range.",
|
| "type": "string"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "RuntimeEnvironment": {
|
| - "description": "The environment values to set at runtime.",
|
| - "id": "RuntimeEnvironment",
|
| + "SourceGetMetadataRequest": {
|
| + "description": "A request to compute the SourceMetadata of a Source.",
|
| + "id": "SourceGetMetadataRequest",
|
| "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.",
|
| + "source": {
|
| + "$ref": "Source",
|
| + "description": "Specification of the source whose metadata should be computed."
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "NameAndKind": {
|
| + "description": "Basic metadata about a counter.",
|
| + "id": "NameAndKind",
|
| + "properties": {
|
| + "name": {
|
| + "description": "Name of the counter.",
|
| "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"
|
| - },
|
| - "serviceAccountEmail": {
|
| - "description": "The email address of the service account to run the job as.",
|
| + "kind": {
|
| + "description": "Counter aggregation kind.",
|
| + "enum": [
|
| + "INVALID",
|
| + "SUM",
|
| + "MAX",
|
| + "MIN",
|
| + "MEAN",
|
| + "OR",
|
| + "AND",
|
| + "SET",
|
| + "DISTRIBUTION"
|
| + ],
|
| + "enumDescriptions": [
|
| + "Counter aggregation kind was not set.",
|
| + "Aggregated value is the sum of all contributed values.",
|
| + "Aggregated value is the max of all contributed values.",
|
| + "Aggregated value is the min of all contributed values.",
|
| + "Aggregated value is the mean of all contributed values.",
|
| + "Aggregated value represents the logical 'or' of all contributed values.",
|
| + "Aggregated value represents the logical 'and' of all contributed values.",
|
| + "Aggregated value is a set of unique contributed values.",
|
| + "Aggregated value captures statistics about a distribution."
|
| + ],
|
| + "type": "string"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "SeqMapTask": {
|
| + "description": "Describes a particular function to invoke.",
|
| + "id": "SeqMapTask",
|
| + "properties": {
|
| + "systemName": {
|
| + "description": "System-defined name of the SeqDo operation.\nUnique across the workflow.",
|
| "type": "string"
|
| },
|
| - "tempLocation": {
|
| - "description": "The Cloud Storage path to use for temporary files.\nMust be a valid Cloud Storage URL, beginning with `gs://`.",
|
| + "stageName": {
|
| + "description": "System-defined name of the stage containing the SeqDo operation.\nUnique across the workflow.",
|
| "type": "string"
|
| },
|
| - "bypassTempDirValidation": {
|
| - "description": "Whether to bypass the safety checks for the job's temporary directory.\nUse with caution.",
|
| - "type": "boolean"
|
| + "userFn": {
|
| + "additionalProperties": {
|
| + "description": "Properties of the object.",
|
| + "type": "any"
|
| + },
|
| + "description": "The user function to invoke.",
|
| + "type": "object"
|
| },
|
| - "machineType": {
|
| - "description": "The machine type to use for the job. Defaults to the value from the\ntemplate if not specified.",
|
| + "name": {
|
| + "description": "The user-provided name of the SeqDo operation.",
|
| "type": "string"
|
| + },
|
| + "outputInfos": {
|
| + "description": "Information about each of the outputs.",
|
| + "items": {
|
| + "$ref": "SeqMapTaskOutputInfo"
|
| + },
|
| + "type": "array"
|
| + },
|
| + "inputs": {
|
| + "description": "Information about each of the inputs.",
|
| + "items": {
|
| + "$ref": "SideInputInfo"
|
| + },
|
| + "type": "array"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "MountedDataDisk": {
|
| - "description": "Describes mounted data disk.",
|
| - "id": "MountedDataDisk",
|
| + "WorkerMessageCode": {
|
| + "description": "A message code is used to report status and error messages to the service.\nThe message codes are intended to be machine readable. The service will\ntake care of translating these into user understandable messages if\nnecessary.\n\nExample use cases:\n 1. Worker processes reporting successful startup.\n 2. Worker processes reporting specific errors (e.g. package staging\n failure).",
|
| + "id": "WorkerMessageCode",
|
| "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\".",
|
| + "parameters": {
|
| + "additionalProperties": {
|
| + "description": "Properties of the object.",
|
| + "type": "any"
|
| + },
|
| + "description": "Parameters contains specific information about the code.\n\nThis is a struct to allow parameters of different types.\n\nExamples:\n 1. For a \"HARNESS_STARTED\" message parameters might provide the name\n of the worker and additional data like timing information.\n 2. For a \"GCS_DOWNLOAD_ERROR\" parameters might contain fields listing\n the GCS objects being downloaded and fields containing errors.\n\nIn general complex data structures should be avoided. If a worker\nneeds to send a specific and complicated data structure then please\nconsider defining a new proto and adding it to the data oneof in\nWorkerMessageResponse.\n\nConventions:\n Parameters should only be used for information that isn't typically passed\n as a label.\n hostname and other worker identifiers should almost always be passed\n as labels since they will be included on most messages.",
|
| + "type": "object"
|
| + },
|
| + "code": {
|
| + "description": "The code is a string intended for consumption by a machine that identifies\nthe type of message being sent.\nExamples:\n 1. \"HARNESS_STARTED\" might be used to indicate the worker harness has\n started.\n 2. \"GCS_DOWNLOAD_ERROR\" might be used to indicate an error downloading\n a GCS file as part of the boot process of one of the worker containers.\n\nThis is a string and not an enum to make it easy to add new codes without\nwaiting for an API change.",
|
| "type": "string"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "StreamingSideInputLocation": {
|
| - "description": "Identifies the location of a streaming side input.",
|
| - "id": "StreamingSideInputLocation",
|
| + "CustomSourceLocation": {
|
| + "description": "Identifies the location of a custom souce.",
|
| + "id": "CustomSourceLocation",
|
| "properties": {
|
| - "tag": {
|
| - "description": "Identifies the particular side input within the streaming Dataflow job.",
|
| + "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": {
|
| + "instructions": {
|
| + "description": "The instructions in the MapTask.",
|
| + "items": {
|
| + "$ref": "ParallelInstruction"
|
| + },
|
| + "type": "array"
|
| + },
|
| + "stageName": {
|
| + "description": "System-defined name of the stage containing this MapTask.\nUnique across the workflow.",
|
| "type": "string"
|
| },
|
| - "stateFamily": {
|
| - "description": "Identifies the state family where this side input is stored.",
|
| + "systemName": {
|
| + "description": "System-defined name of this MapTask.\nUnique across the workflow.",
|
| "type": "string"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "LaunchTemplateResponse": {
|
| - "description": "Response to the request to launch a template.",
|
| - "id": "LaunchTemplateResponse",
|
| + "FloatingPointMean": {
|
| + "description": "A representation of a floating point mean metric contribution.",
|
| + "id": "FloatingPointMean",
|
| "properties": {
|
| - "job": {
|
| - "$ref": "Job",
|
| - "description": "The job that was launched, if the request was not a dry run and\nthe job was successfully launched."
|
| + "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"
|
| },
|
| - "Job": {
|
| - "description": "Defines a job to be run by the Cloud Dataflow service.",
|
| - "id": "Job",
|
| + "ReportWorkItemStatusResponse": {
|
| + "description": "Response from a request to report the status of WorkItems.",
|
| + "id": "ReportWorkItemStatusResponse",
|
| "properties": {
|
| - "currentStateTime": {
|
| - "description": "The timestamp associated with the current state.",
|
| - "format": "google-datetime",
|
| - "type": "string"
|
| + "workItemServiceStates": {
|
| + "description": "A set of messages indicating the service-side state for each\nWorkItem whose status was reported, in the same order as the\nWorkItemStatus messages in the ReportWorkItemStatusRequest which\nresulting in this response.",
|
| + "items": {
|
| + "$ref": "WorkItemServiceState"
|
| + },
|
| + "type": "array"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "InstructionOutput": {
|
| + "description": "An output of an instruction.",
|
| + "id": "InstructionOutput",
|
| + "properties": {
|
| + "onlyCountValueBytes": {
|
| + "description": "For system-generated byte and mean byte metrics, certain instructions\nshould only report the value size.",
|
| + "type": "boolean"
|
| },
|
| - "transformNameMapping": {
|
| + "codec": {
|
| "additionalProperties": {
|
| - "type": "string"
|
| + "description": "Properties of the object.",
|
| + "type": "any"
|
| },
|
| - "description": "The map of transform name prefixes of the job to be replaced to the\ncorresponding name prefixes of the new job.",
|
| + "description": "The codec to use to encode data being written via this output.",
|
| "type": "object"
|
| },
|
| - "createTime": {
|
| - "description": "The timestamp when the job was initially created. Immutable and set by the\nCloud Dataflow service.",
|
| - "format": "google-datetime",
|
| + "name": {
|
| + "description": "The user-provided name of this output.",
|
| "type": "string"
|
| },
|
| - "environment": {
|
| - "$ref": "Environment",
|
| - "description": "The environment for the job."
|
| + "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"
|
| },
|
| - "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"
|
| + "systemName": {
|
| + "description": "System-defined name of this output.\nUnique across the workflow.",
|
| + "type": "string"
|
| },
|
| - "stageStates": {
|
| - "description": "This field may be mutated by the Cloud Dataflow service;\ncallers cannot mutate it.",
|
| - "items": {
|
| - "$ref": "ExecutionStageState"
|
| - },
|
| + "onlyCountKeyBytes": {
|
| + "description": "For system-generated byte and mean byte metrics, certain instructions\nshould only report the key size.",
|
| + "type": "boolean"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "CreateJobFromTemplateRequest": {
|
| + "description": "A request to create a Cloud Dataflow job from a template.",
|
| + "id": "CreateJobFromTemplateRequest",
|
| + "properties": {
|
| + "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."
|
| + },
|
| + "location": {
|
| + "description": "The location to which to direct the request.",
|
| + "type": "string"
|
| + },
|
| + "parameters": {
|
| + "additionalProperties": {
|
| + "type": "string"
|
| + },
|
| + "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"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "IntegerMean": {
|
| + "description": "A representation of an integer mean metric contribution.",
|
| + "id": "IntegerMean",
|
| + "properties": {
|
| + "count": {
|
| + "$ref": "SplitInt64",
|
| + "description": "The number of values being aggregated."
|
| + },
|
| + "sum": {
|
| + "$ref": "SplitInt64",
|
| + "description": "The sum of all values being aggregated."
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "ListJobsResponse": {
|
| + "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"
|
| },
|
| - "projectId": {
|
| - "description": "The ID of the Cloud Platform project that the job belongs to.",
|
| + "failedLocation": {
|
| + "description": "Zero or more messages describing locations that failed to respond.",
|
| + "items": {
|
| + "$ref": "FailedLocation"
|
| + },
|
| + "type": "array"
|
| + },
|
| + "nextPageToken": {
|
| + "description": "Set if there may be more results than fit in this response.",
|
| + "type": "string"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "ComputationTopology": {
|
| + "description": "All configuration data for a particular Computation.",
|
| + "id": "ComputationTopology",
|
| + "properties": {
|
| + "systemStageName": {
|
| + "description": "The system stage name.",
|
| + "type": "string"
|
| + },
|
| + "computationId": {
|
| + "description": "The ID of the computation.",
|
| + "type": "string"
|
| + },
|
| + "inputs": {
|
| + "description": "The inputs to the computation.",
|
| + "items": {
|
| + "$ref": "StreamLocation"
|
| + },
|
| + "type": "array"
|
| + },
|
| + "keyRanges": {
|
| + "description": "The key ranges processed by the computation.",
|
| + "items": {
|
| + "$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"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "RuntimeEnvironment": {
|
| + "description": "The environment values to set at runtime.",
|
| + "id": "RuntimeEnvironment",
|
| + "properties": {
|
| + "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"
|
| + },
|
| + "tempLocation": {
|
| + "description": "The Cloud Storage path to use for temporary files.\nMust be a valid Cloud Storage URL, beginning with `gs://`.",
|
| + "type": "string"
|
| + },
|
| + "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": "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\".",
|
| + "type": "string"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "StreamingSideInputLocation": {
|
| + "description": "Identifies the location of a streaming side input.",
|
| + "id": "StreamingSideInputLocation",
|
| + "properties": {
|
| + "tag": {
|
| + "description": "Identifies the particular side input within the streaming Dataflow job.",
|
| + "type": "string"
|
| + },
|
| + "stateFamily": {
|
| + "description": "Identifies the state family where this side input is stored.",
|
| + "type": "string"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "LaunchTemplateResponse": {
|
| + "description": "Response to the request to launch a template.",
|
| + "id": "LaunchTemplateResponse",
|
| + "properties": {
|
| + "job": {
|
| + "$ref": "Job",
|
| + "description": "The job that was launched, if the request was not a dry run and\nthe job was successfully launched."
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "Job": {
|
| + "description": "Defines a job to be run by the Cloud Dataflow service.",
|
| + "id": "Job",
|
| + "properties": {
|
| + "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"
|
| + },
|
| + "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"
|
| + },
|
| + "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"
|
| },
|
| + "stageStates": {
|
| + "description": "This field may be mutated by the Cloud Dataflow service;\ncallers cannot mutate it.",
|
| + "items": {
|
| + "$ref": "ExecutionStageState"
|
| + },
|
| + "type": "array"
|
| + },
|
| "type": {
|
| "description": "The type of Cloud Dataflow job.",
|
| "enum": [
|
| @@ -1801,6 +2051,10 @@
|
| ],
|
| "type": "string"
|
| },
|
| + "projectId": {
|
| + "description": "The ID of the Cloud Platform project that the job belongs to.",
|
| + "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."
|
| @@ -1914,13 +2168,13 @@
|
| "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."
|
| + },
|
| + "primary": {
|
| + "$ref": "DerivedSource",
|
| + "description": "Primary part (continued to be processed by worker).\nSpecified relative to the previously-current source.\nBecomes current."
|
| }
|
| },
|
| "type": "object"
|
| @@ -1967,16 +2221,19 @@
|
| },
|
| "type": "object"
|
| },
|
| + "SendDebugCaptureResponse": {
|
| + "description": "Response to a send capture request.\nnothing",
|
| + "id": "SendDebugCaptureResponse",
|
| + "properties": {},
|
| + "type": "object"
|
| + },
|
| "SideInputInfo": {
|
| "description": "Information about a side input of a DoFn or an input of a SeqDoFn.",
|
| "id": "SideInputInfo",
|
| "properties": {
|
| - "sources": {
|
| - "description": "The source(s) to read element(s) from to get the value of this side input.\nIf more than one source, then the elements are taken from the\nsources, in the specified order if order matters.\nAt least one source is required.",
|
| - "items": {
|
| - "$ref": "Source"
|
| - },
|
| - "type": "array"
|
| + "tag": {
|
| + "description": "The id of the tag the user code will access this side input by;\nthis should correspond to the tag of some MultiOutputInfo.",
|
| + "type": "string"
|
| },
|
| "kind": {
|
| "additionalProperties": {
|
| @@ -1986,19 +2243,16 @@
|
| "description": "How to interpret the source element(s) as a side input value.",
|
| "type": "object"
|
| },
|
| - "tag": {
|
| - "description": "The id of the tag the user code will access this side input by;\nthis should correspond to the tag of some MultiOutputInfo.",
|
| - "type": "string"
|
| + "sources": {
|
| + "description": "The source(s) to read element(s) from to get the value of this side input.\nIf more than one source, then the elements are taken from the\nsources, in the specified order if order matters.\nAt least one source is required.",
|
| + "items": {
|
| + "$ref": "Source"
|
| + },
|
| + "type": "array"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "SendDebugCaptureResponse": {
|
| - "description": "Response to a send capture request.\nnothing",
|
| - "id": "SendDebugCaptureResponse",
|
| - "properties": {},
|
| - "type": "object"
|
| - },
|
| "CounterStructuredNameAndMetadata": {
|
| "description": "A single message which encapsulates structured name and metadata for a given\ncounter.",
|
| "id": "CounterStructuredNameAndMetadata",
|
| @@ -2018,14 +2272,14 @@
|
| "description": "A position that encapsulates an inner position and an index for the inner\nposition. A ConcatPosition can be used by a reader of a source that\nencapsulates a set of other sources.",
|
| "id": "ConcatPosition",
|
| "properties": {
|
| - "position": {
|
| - "$ref": "Position",
|
| - "description": "Position within the inner source."
|
| - },
|
| "index": {
|
| "description": "Index of the inner source.",
|
| "format": "int32",
|
| "type": "integer"
|
| + },
|
| + "position": {
|
| + "$ref": "Position",
|
| + "description": "Position within the inner source."
|
| }
|
| },
|
| "type": "object"
|
| @@ -2034,13 +2288,13 @@
|
| "description": "An instruction that writes records.\nTakes one input, produces no outputs.",
|
| "id": "WriteInstruction",
|
| "properties": {
|
| - "sink": {
|
| - "$ref": "Sink",
|
| - "description": "The sink to write to."
|
| - },
|
| "input": {
|
| "$ref": "InstructionInput",
|
| "description": "The input."
|
| + },
|
| + "sink": {
|
| + "$ref": "Sink",
|
| + "description": "The sink to write to."
|
| }
|
| },
|
| "type": "object"
|
| @@ -2049,16 +2303,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"
|
| @@ -2093,6 +2347,17 @@
|
| "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": {
|
| + "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": {
|
| @@ -2143,17 +2408,6 @@
|
| "Opening or closing a shuffle session, often as part of a GroupByKey."
|
| ],
|
| "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"
|
| }
|
| },
|
| "type": "object"
|
| @@ -2224,11 +2478,6 @@
|
| "description": "Modeled after information exposed by /proc/stat.",
|
| "id": "CPUTime",
|
| "properties": {
|
| - "totalMs": {
|
| - "description": "Total active CPU time across all cores (ie., non-idle) in milliseconds\nsince start-up.",
|
| - "format": "uint64",
|
| - "type": "string"
|
| - },
|
| "rate": {
|
| "description": "Average CPU utilization rate (% non-idle cpu / second) since previous\nsample.",
|
| "format": "double",
|
| @@ -2238,6 +2487,11 @@
|
| "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",
|
| + "type": "string"
|
| }
|
| },
|
| "type": "object"
|
| @@ -2246,26 +2500,6 @@
|
| "description": "Describes the environment in which a Dataflow Job runs.",
|
| "id": "Environment",
|
| "properties": {
|
| - "version": {
|
| - "additionalProperties": {
|
| - "description": "Properties of the object.",
|
| - "type": "any"
|
| - },
|
| - "description": "A structure describing which components and their versions of the service\nare required in order to run the job.",
|
| - "type": "object"
|
| - },
|
| - "internalExperiments": {
|
| - "additionalProperties": {
|
| - "description": "Properties of the object. Contains field @type with type URL.",
|
| - "type": "any"
|
| - },
|
| - "description": "Experimental settings.",
|
| - "type": "object"
|
| - },
|
| - "serviceAccountEmail": {
|
| - "description": "Identity to run virtual machines as. Defaults to the default account.",
|
| - "type": "string"
|
| - },
|
| "sdkPipelineOptions": {
|
| "additionalProperties": {
|
| "description": "Properties of the object.",
|
| @@ -2307,6 +2541,26 @@
|
| "type": "string"
|
| },
|
| "type": "array"
|
| + },
|
| + "internalExperiments": {
|
| + "additionalProperties": {
|
| + "description": "Properties of the object. Contains field @type with type URL.",
|
| + "type": "any"
|
| + },
|
| + "description": "Experimental settings.",
|
| + "type": "object"
|
| + },
|
| + "version": {
|
| + "additionalProperties": {
|
| + "description": "Properties of the object.",
|
| + "type": "any"
|
| + },
|
| + "description": "A structure describing which components and their versions of the service\nare required in order to run the job.",
|
| + "type": "object"
|
| + },
|
| + "serviceAccountEmail": {
|
| + "description": "Identity to run virtual machines as. Defaults to the default account.",
|
| + "type": "string"
|
| }
|
| },
|
| "type": "object"
|
| @@ -2315,6 +2569,13 @@
|
| "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": [
|
| @@ -2335,13 +2596,6 @@
|
| "$ref": "StreamingComputationRanges"
|
| },
|
| "type": "array"
|
| - },
|
| - "dataDisks": {
|
| - "description": "Describes the set of data disks this task should apply to.",
|
| - "items": {
|
| - "$ref": "MountedDataDisk"
|
| - },
|
| - "type": "array"
|
| }
|
| },
|
| "type": "object"
|
| @@ -2350,10 +2604,6 @@
|
| "description": "Request to send encoded debug information.",
|
| "id": "SendDebugCaptureRequest",
|
| "properties": {
|
| - "componentId": {
|
| - "description": "The internal component id for which debug information is sent.",
|
| - "type": "string"
|
| - },
|
| "workerId": {
|
| "description": "The worker id, i.e., VM hostname.",
|
| "type": "string"
|
| @@ -2365,6 +2615,10 @@
|
| "data": {
|
| "description": "The encoded debug information.",
|
| "type": "string"
|
| + },
|
| + "componentId": {
|
| + "description": "The internal component id for which debug information is sent.",
|
| + "type": "string"
|
| }
|
| },
|
| "type": "object"
|
| @@ -2384,10 +2638,6 @@
|
| "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"
|
| @@ -2395,6 +2645,10 @@
|
| "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"
|
| @@ -2412,14 +2666,14 @@
|
| "$ref": "TopologyConfig",
|
| "description": "The global topology of the streaming Dataflow job."
|
| },
|
| + "drain": {
|
| + "description": "The user has requested drain.",
|
| + "type": "boolean"
|
| + },
|
| "workerHarnessPort": {
|
| "description": "The TCP port used by the worker to communicate with the Dataflow\nworker harness.",
|
| "format": "int32",
|
| "type": "integer"
|
| - },
|
| - "drain": {
|
| - "description": "The user has requested drain.",
|
| - "type": "boolean"
|
| }
|
| },
|
| "type": "object"
|
| @@ -2428,10 +2682,6 @@
|
| "description": "Identifies a pubsub location to use for transferring data into or\nout of a streaming Dataflow job.",
|
| "id": "PubsubLocation",
|
| "properties": {
|
| - "subscription": {
|
| - "description": "A pubsub subscription, in the form of\n\"pubsub.googleapis.com/subscriptions/<project-id>/<subscription-name>\"",
|
| - "type": "string"
|
| - },
|
| "dropLateData": {
|
| "description": "Indicates whether the pipeline allows late-arriving data.",
|
| "type": "boolean"
|
| @@ -2455,6 +2705,10 @@
|
| "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"
|
| }
|
| },
|
| "type": "object"
|
| @@ -2463,6 +2717,20 @@
|
| "description": "WorkerHealthReport contains information about the health of a worker.\n\nThe VM should be identified by the labels attached to the WorkerMessage that\nthis health ping belongs to.",
|
| "id": "WorkerHealthReport",
|
| "properties": {
|
| + "vmStartupTime": {
|
| + "description": "The time the VM was booted.",
|
| + "format": "google-datetime",
|
| + "type": "string"
|
| + },
|
| + "reportInterval": {
|
| + "description": "The interval at which the worker is sending health reports.\nThe default value of 0 should be interpreted as the field is not being\nexplicitly set by the worker.",
|
| + "format": "google-duration",
|
| + "type": "string"
|
| + },
|
| + "vmIsHealthy": {
|
| + "description": "Whether the VM is healthy.",
|
| + "type": "boolean"
|
| + },
|
| "pods": {
|
| "description": "The pods running on the worker. See:\nhttp://kubernetes.io/v1.1/docs/api-reference/v1/definitions.html#_v1_pod\n\nThis field is used by the worker to send the status of the indvidual\ncontainers running on each worker.",
|
| "items": {
|
| @@ -2473,20 +2741,6 @@
|
| "type": "object"
|
| },
|
| "type": "array"
|
| - },
|
| - "vmStartupTime": {
|
| - "description": "The time the VM was booted.",
|
| - "format": "google-datetime",
|
| - "type": "string"
|
| - },
|
| - "vmIsHealthy": {
|
| - "description": "Whether the VM is healthy.",
|
| - "type": "boolean"
|
| - },
|
| - "reportInterval": {
|
| - "description": "The interval at which the worker is sending health reports.\nThe default value of 0 should be interpreted as the field is not being\nexplicitly set by the worker.",
|
| - "format": "google-duration",
|
| - "type": "string"
|
| }
|
| },
|
| "type": "object"
|
| @@ -2504,10 +2758,6 @@
|
| "description": "Deprecated.",
|
| "type": "string"
|
| },
|
| - "messageText": {
|
| - "description": "The text of the message.",
|
| - "type": "string"
|
| - },
|
| "messageImportance": {
|
| "description": "Importance level of the message.",
|
| "enum": [
|
| @@ -2527,6 +2777,10 @@
|
| "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"
|
| + },
|
| + "messageText": {
|
| + "description": "The text of the message.",
|
| + "type": "string"
|
| }
|
| },
|
| "type": "object"
|
| @@ -2535,10 +2789,6 @@
|
| "description": "Metadata for a specific parameter.",
|
| "id": "ParameterMetadata",
|
| "properties": {
|
| - "name": {
|
| - "description": "Required. The name of the parameter.",
|
| - "type": "string"
|
| - },
|
| "regexes": {
|
| "description": "Optional. Regexes that the parameter must match.",
|
| "items": {
|
| @@ -2557,6 +2807,10 @@
|
| "isOptional": {
|
| "description": "Optional. Whether the parameter is optional. Defaults to false.",
|
| "type": "boolean"
|
| + },
|
| + "name": {
|
| + "description": "Required. The name of the parameter.",
|
| + "type": "string"
|
| }
|
| },
|
| "type": "object"
|
| @@ -2576,13 +2830,13 @@
|
| "description": "Represents the operation to split a high-level Source specification\ninto bundles (parts for parallel processing).\n\nAt a high level, splitting of a source into bundles happens as follows:\nSourceSplitRequest is applied to the source. If it returns\nSOURCE_SPLIT_OUTCOME_USE_CURRENT, no further splitting happens and the source\nis used \"as is\". Otherwise, splitting is applied recursively to each\nproduced DerivedSource.\n\nAs an optimization, for any Source, if its does_not_need_splitting is\ntrue, the framework assumes that splitting this source would return\nSOURCE_SPLIT_OUTCOME_USE_CURRENT, and doesn't initiate a SourceSplitRequest.\nThis applies both to the initial source being split and to bundles\nproduced from it.",
|
| "id": "SourceSplitRequest",
|
| "properties": {
|
| - "source": {
|
| - "$ref": "Source",
|
| - "description": "Specification of the source to be split."
|
| - },
|
| "options": {
|
| "$ref": "SourceSplitOptions",
|
| "description": "Hints for tuning the splitting process."
|
| + },
|
| + "source": {
|
| + "$ref": "Source",
|
| + "description": "Specification of the source to be split."
|
| }
|
| },
|
| "type": "object"
|
| @@ -2602,20 +2856,6 @@
|
| "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",
|
| - "type": "string"
|
| - },
|
| "eventType": {
|
| "description": "The type of autoscaling event to report.",
|
| "enum": [
|
| @@ -2634,10 +2874,24 @@
|
| ],
|
| "type": "string"
|
| },
|
| + "targetNumWorkers": {
|
| + "description": "The target number of workers the worker pool wants to resize to use.",
|
| + "format": "int64",
|
| + "type": "string"
|
| + },
|
| "currentNumWorkers": {
|
| "description": "The current number of workers the job has.",
|
| "format": "int64",
|
| "type": "string"
|
| + },
|
| + "time": {
|
| + "description": "The time this event was emitted to indicate a new target or current\nnum_workers value.",
|
| + "format": "google-datetime",
|
| + "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."
|
| }
|
| },
|
| "type": "object"
|
| @@ -2679,26 +2933,6 @@
|
| "description": "Taskrunner configuration settings.",
|
| "id": "TaskRunnerSettings",
|
| "properties": {
|
| - "workflowFileName": {
|
| - "description": "The file to store the workflow in.",
|
| - "type": "string"
|
| - },
|
| - "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"
|
| - },
|
| - "languageHint": {
|
| - "description": "The suggested backend language.",
|
| - "type": "string"
|
| - },
|
| - "commandlinesFileName": {
|
| - "description": "The file to store preprocessing commands in.",
|
| - "type": "string"
|
| - },
|
| "baseUrl": {
|
| "description": "The base URL for the taskrunner to use when accessing Google Cloud APIs.\n\nWhen workers access Google Cloud APIs, they logically do so via\nrelative URLs. If this field is specified, it supplies the base\nURL to use for resolving these relative URLs. The normative\nalgorithm used is defined by RFC 1808, \"Relative Uniform Resource\nLocators\".\n\nIf not specified, the default value is \"http://www.googleapis.com/\"",
|
| "type": "string"
|
| @@ -2739,10 +2973,6 @@
|
| "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": {
|
| @@ -2750,6 +2980,10 @@
|
| },
|
| "type": "array"
|
| },
|
| + "dataflowApiVersion": {
|
| + "description": "The API version of endpoint, e.g. \"v1b3\"",
|
| + "type": "string"
|
| + },
|
| "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"
|
| @@ -2757,6 +2991,26 @@
|
| "streamingWorkerMainClass": {
|
| "description": "The streaming worker main class name.",
|
| "type": "string"
|
| + },
|
| + "workflowFileName": {
|
| + "description": "The file to store the workflow in.",
|
| + "type": "string"
|
| + },
|
| + "languageHint": {
|
| + "description": "The suggested backend language.",
|
| + "type": "string"
|
| + },
|
| + "commandlinesFileName": {
|
| + "description": "The file to store preprocessing commands in.",
|
| + "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.",
|
| + "type": "string"
|
| }
|
| },
|
| "type": "object"
|
| @@ -2765,6 +3019,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": {
|
| + "recordIndex": {
|
| + "description": "Position is a record index.",
|
| + "format": "int64",
|
| + "type": "string"
|
| + },
|
| + "shufflePosition": {
|
| + "description": "CloudPosition is a base64 encoded BatchShufflePosition (with FIXED\nsharding).",
|
| + "type": "string"
|
| + },
|
| "concatPosition": {
|
| "$ref": "ConcatPosition",
|
| "description": "CloudPosition is a concat position."
|
| @@ -2781,15 +3044,6 @@
|
| "key": {
|
| "description": "Position is a string key, ordered lexicographically.",
|
| "type": "string"
|
| - },
|
| - "recordIndex": {
|
| - "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"
|
| @@ -2815,20 +3069,9 @@
|
| "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"
|
| + "doesNotNeedSplitting": {
|
| + "description": "Setting this value to true hints to the framework that the source\ndoesn't need splitting, and using SourceSplitRequest on it would\nyield SOURCE_SPLIT_OUTCOME_USE_CURRENT.\n\nE.g. a file splitter may set this to true when splitting a single file\ninto a set of byte ranges of appropriate size, and set this\nto false when splitting a filepattern into individual files.\nHowever, for efficiency, a file splitter may decide to produce\nfile subranges directly from the filepattern to avoid a splitting\nround-trip.\n\nSee SourceSplitRequest for an overview of the splitting process.\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.",
|
| + "type": "boolean"
|
| },
|
| "codec": {
|
| "additionalProperties": {
|
| @@ -2838,10 +3081,6 @@
|
| "description": "The codec to use to decode data read from the source.",
|
| "type": "object"
|
| },
|
| - "doesNotNeedSplitting": {
|
| - "description": "Setting this value to true hints to the framework that the source\ndoesn't need splitting, and using SourceSplitRequest on it would\nyield SOURCE_SPLIT_OUTCOME_USE_CURRENT.\n\nE.g. a file splitter may set this to true when splitting a single file\ninto a set of byte ranges of appropriate size, and set this\nto false when splitting a filepattern into individual files.\nHowever, for efficiency, a file splitter may decide to produce\nfile subranges directly from the filepattern to avoid a splitting\nround-trip.\n\nSee SourceSplitRequest for an overview of the splitting process.\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.",
|
| - "type": "boolean"
|
| - },
|
| "spec": {
|
| "additionalProperties": {
|
| "description": "Properties of the object.",
|
| @@ -2849,6 +3088,21 @@
|
| },
|
| "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"
|
| @@ -2857,23 +3111,18 @@
|
| "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": {
|
| - "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",
|
| - "type": "integer"
|
| - },
|
| "workerHarnessContainerImage": {
|
| "description": "Required. Docker container image that executes the Cloud Dataflow worker\nharness, residing in Google Container Registry.",
|
| "type": "string"
|
| },
|
| - "machineType": {
|
| - "description": "Machine type (e.g. \"n1-standard-1\"). If empty or unspecified, the\nservice will attempt to choose a reasonable default.",
|
| - "type": "string"
|
| - },
|
| "diskType": {
|
| "description": "Type of root disk for VMs. If empty or unspecified, the service will\nattempt to choose a reasonable default.",
|
| "type": "string"
|
| },
|
| + "machineType": {
|
| + "description": "Machine type (e.g. \"n1-standard-1\"). If empty or unspecified, the\nservice will attempt to choose a reasonable default.",
|
| + "type": "string"
|
| + },
|
| "kind": {
|
| "description": "The kind of the worker pool; currently only `harness` and `shuffle`\nare supported.",
|
| "type": "string"
|
| @@ -2990,6 +3239,11 @@
|
| },
|
| "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",
|
| + "type": "integer"
|
| }
|
| },
|
| "type": "object"
|
| @@ -3013,6 +3267,10 @@
|
| "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": {
|
| + "messageText": {
|
| + "description": "Human-readable version of message.",
|
| + "type": "string"
|
| + },
|
| "parameters": {
|
| "description": "The structured data associated with this message.",
|
| "items": {
|
| @@ -3023,10 +3281,6 @@
|
| "messageKey": {
|
| "description": "Idenfier for this message type. Used by external systems to\ninternationalize or personalize message.",
|
| "type": "string"
|
| - },
|
| - "messageText": {
|
| - "description": "Human-readable version of message.",
|
| - "type": "string"
|
| }
|
| },
|
| "type": "object"
|
| @@ -3035,19 +3289,14 @@
|
| "description": "WorkItem represents basic information about a WorkItem to be executed\nin the cloud.",
|
| "id": "WorkItem",
|
| "properties": {
|
| - "initialReportIndex": {
|
| - "description": "The initial index to use when reporting the status of the WorkItem.",
|
| - "format": "int64",
|
| - "type": "string"
|
| + "streamingComputationTask": {
|
| + "$ref": "StreamingComputationTask",
|
| + "description": "Additional information for StreamingComputationTask WorkItems."
|
| },
|
| "shellTask": {
|
| "$ref": "ShellTask",
|
| "description": "Additional information for ShellTask WorkItems."
|
| },
|
| - "streamingComputationTask": {
|
| - "$ref": "StreamingComputationTask",
|
| - "description": "Additional information for StreamingComputationTask WorkItems."
|
| - },
|
| "jobId": {
|
| "description": "Identifies the workflow job this WorkItem belongs to.",
|
| "type": "string"
|
| @@ -3080,18 +3329,18 @@
|
| "description": "Identifies the cloud project this WorkItem belongs to.",
|
| "type": "string"
|
| },
|
| - "sourceOperationTask": {
|
| - "$ref": "SourceOperationRequest",
|
| - "description": "Additional information for source operation WorkItems."
|
| + "reportStatusInterval": {
|
| + "description": "Recommended reporting interval.",
|
| + "format": "google-duration",
|
| + "type": "string"
|
| },
|
| "streamingSetupTask": {
|
| "$ref": "StreamingSetupTask",
|
| "description": "Additional information for StreamingSetupTask WorkItems."
|
| },
|
| - "reportStatusInterval": {
|
| - "description": "Recommended reporting interval.",
|
| - "format": "google-duration",
|
| - "type": "string"
|
| + "sourceOperationTask": {
|
| + "$ref": "SourceOperationRequest",
|
| + "description": "Additional information for source operation WorkItems."
|
| },
|
| "streamingConfigTask": {
|
| "$ref": "StreamingConfigTask",
|
| @@ -3101,20 +3350,11 @@
|
| "description": "Time when the lease on this Work will expire.",
|
| "format": "google-datetime",
|
| "type": "string"
|
| - }
|
| - },
|
| - "type": "object"
|
| - },
|
| - "ResourceUtilizationReport": {
|
| - "description": "Worker metrics exported from workers. This contains resource utilization\nmetrics accumulated from a variety of sources. For more information, see\ngo/df-resource-signals.",
|
| - "id": "ResourceUtilizationReport",
|
| - "properties": {
|
| - "cpuTime": {
|
| - "description": "CPU utilization samples.",
|
| - "items": {
|
| - "$ref": "CPUTime"
|
| - },
|
| - "type": "array"
|
| + },
|
| + "initialReportIndex": {
|
| + "description": "The initial index to use when reporting the status of the WorkItem.",
|
| + "format": "int64",
|
| + "type": "string"
|
| }
|
| },
|
| "type": "object"
|
| @@ -3135,22 +3375,24 @@
|
| },
|
| "type": "object"
|
| },
|
| - "TopologyConfig": {
|
| - "description": "Global topology of the streaming Dataflow job, including all\ncomputations and their sharded locations.",
|
| - "id": "TopologyConfig",
|
| + "ResourceUtilizationReport": {
|
| + "description": "Worker metrics exported from workers. This contains resource utilization\nmetrics accumulated from a variety of sources. For more information, see\ngo/df-resource-signals.",
|
| + "id": "ResourceUtilizationReport",
|
| "properties": {
|
| - "dataDiskAssignments": {
|
| - "description": "The disks assigned to a streaming Dataflow job.",
|
| + "cpuTime": {
|
| + "description": "CPU utilization samples.",
|
| "items": {
|
| - "$ref": "DataDiskAssignment"
|
| + "$ref": "CPUTime"
|
| },
|
| "type": "array"
|
| - },
|
| - "persistentStateVersion": {
|
| - "description": "Version number for persistent state.",
|
| - "format": "int32",
|
| - "type": "integer"
|
| - },
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "TopologyConfig": {
|
| + "description": "Global topology of the streaming Dataflow job, including all\ncomputations and their sharded locations.",
|
| + "id": "TopologyConfig",
|
| + "properties": {
|
| "forwardingKeyBits": {
|
| "description": "The size (in bits) of keys that will be assigned to source messages.",
|
| "format": "int32",
|
| @@ -3169,6 +3411,18 @@
|
| "$ref": "ComputationTopology"
|
| },
|
| "type": "array"
|
| + },
|
| + "persistentStateVersion": {
|
| + "description": "Version number for persistent state.",
|
| + "format": "int32",
|
| + "type": "integer"
|
| + },
|
| + "dataDiskAssignments": {
|
| + "description": "The disks assigned to a streaming Dataflow job.",
|
| + "items": {
|
| + "$ref": "DataDiskAssignment"
|
| + },
|
| + "type": "array"
|
| }
|
| },
|
| "type": "object"
|
| @@ -3205,14 +3459,18 @@
|
| "description": "Provides data to pass through to the worker harness.",
|
| "id": "WorkerSettings",
|
| "properties": {
|
| - "reportingEnabled": {
|
| - "description": "Whether to send work progress updates to the service.",
|
| - "type": "boolean"
|
| + "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"
|
| },
|
| "baseUrl": {
|
| "description": "The base URL for accessing Google Cloud APIs.\n\nWhen workers access Google Cloud APIs, they logically do so via\nrelative URLs. If this field is specified, it supplies the base\nURL to use for resolving these relative URLs. The normative\nalgorithm used is defined by RFC 1808, \"Relative Uniform Resource\nLocators\".\n\nIf not specified, the default value is \"http://www.googleapis.com/\"",
|
| "type": "string"
|
| },
|
| + "reportingEnabled": {
|
| + "description": "Whether to send work progress updates to the service.",
|
| + "type": "boolean"
|
| + },
|
| "servicePath": {
|
| "description": "The Cloud Dataflow service path relative to the root URL, for example,\n\"dataflow/v1b3/projects\".",
|
| "type": "string"
|
| @@ -3224,9 +3482,16 @@
|
| "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": "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"
|
| }
|
| },
|
| @@ -3250,17 +3515,6 @@
|
| },
|
| "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"
|
| - }
|
| - },
|
| - "type": "object"
|
| - },
|
| "ApproximateSplitRequest": {
|
| "description": "A suggestion by the service to the worker to dynamically split the WorkItem.",
|
| "id": "ApproximateSplitRequest",
|
| @@ -3308,6 +3562,11 @@
|
| "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": [
|
| @@ -3341,11 +3600,6 @@
|
| "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"
|
| @@ -3354,17 +3608,17 @@
|
| "description": "Describes a stream of data, either as input to be processed or as\noutput of a streaming Dataflow job.",
|
| "id": "StreamLocation",
|
| "properties": {
|
| - "streamingStageLocation": {
|
| - "$ref": "StreamingStageLocation",
|
| - "description": "The stream is part of another computation within the current\nstreaming Dataflow job."
|
| + "sideInputLocation": {
|
| + "$ref": "StreamingSideInputLocation",
|
| + "description": "The stream is a streaming side input."
|
| },
|
| "pubsubLocation": {
|
| "$ref": "PubsubLocation",
|
| "description": "The stream is a pubsub stream."
|
| },
|
| - "sideInputLocation": {
|
| - "$ref": "StreamingSideInputLocation",
|
| - "description": "The stream is a streaming side input."
|
| + "streamingStageLocation": {
|
| + "$ref": "StreamingStageLocation",
|
| + "description": "The stream is part of another computation within the current\nstreaming Dataflow job."
|
| },
|
| "customSourceLocation": {
|
| "$ref": "CustomSourceLocation",
|
| @@ -3387,26 +3641,14 @@
|
| },
|
| "type": "object"
|
| },
|
| - "StreamingComputationConfig": {
|
| - "description": "Configuration information for a single streaming computation.",
|
| - "id": "StreamingComputationConfig",
|
| + "LeaseWorkItemResponse": {
|
| + "description": "Response to a request to lease WorkItems.",
|
| + "id": "LeaseWorkItemResponse",
|
| "properties": {
|
| - "computationId": {
|
| - "description": "Unique identifier for this computation.",
|
| - "type": "string"
|
| - },
|
| - "systemName": {
|
| - "description": "System defined name for this computation.",
|
| - "type": "string"
|
| - },
|
| - "stageName": {
|
| - "description": "Stage name of this computation.",
|
| - "type": "string"
|
| - },
|
| - "instructions": {
|
| - "description": "Instructions that comprise the computation.",
|
| + "workItems": {
|
| + "description": "A list of the leased WorkItems.",
|
| "items": {
|
| - "$ref": "ParallelInstruction"
|
| + "$ref": "WorkItem"
|
| },
|
| "type": "array"
|
| }
|
| @@ -3475,14 +3717,26 @@
|
| },
|
| "type": "object"
|
| },
|
| - "LeaseWorkItemResponse": {
|
| - "description": "Response to a request to lease WorkItems.",
|
| - "id": "LeaseWorkItemResponse",
|
| + "StreamingComputationConfig": {
|
| + "description": "Configuration information for a single streaming computation.",
|
| + "id": "StreamingComputationConfig",
|
| "properties": {
|
| - "workItems": {
|
| - "description": "A list of the leased WorkItems.",
|
| + "computationId": {
|
| + "description": "Unique identifier for this computation.",
|
| + "type": "string"
|
| + },
|
| + "stageName": {
|
| + "description": "Stage name of this computation.",
|
| + "type": "string"
|
| + },
|
| + "systemName": {
|
| + "description": "System defined name for this computation.",
|
| + "type": "string"
|
| + },
|
| + "instructions": {
|
| + "description": "Instructions that comprise the computation.",
|
| "items": {
|
| - "$ref": "WorkItem"
|
| + "$ref": "ParallelInstruction"
|
| },
|
| "type": "array"
|
| }
|
| @@ -3552,8 +3806,8 @@
|
| "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.",
|
| + "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": {
|
| @@ -3563,6 +3817,10 @@
|
| },
|
| "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."
|
| @@ -3582,10 +3840,6 @@
|
| },
|
| "description": "The value combining function to invoke.",
|
| "type": "object"
|
| - },
|
| - "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"
|
| }
|
| },
|
| "type": "object"
|
| @@ -3594,13 +3848,13 @@
|
| "description": "An input of an instruction, as a reference to an output of a\nproducer instruction.",
|
| "id": "InstructionInput",
|
| "properties": {
|
| - "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"
|
| },
|
| - "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"
|
| }
|
| @@ -3611,15 +3865,15 @@
|
| "description": "Description of an input or output of an execution stage.",
|
| "id": "StageSource",
|
| "properties": {
|
| - "name": {
|
| - "description": "Dataflow service generated name for this source.",
|
| - "type": "string"
|
| - },
|
| "sizeBytes": {
|
| "description": "Size of the source, if measurable.",
|
| "format": "int64",
|
| "type": "string"
|
| },
|
| + "name": {
|
| + "description": "Dataflow service generated name for this source.",
|
| + "type": "string"
|
| + },
|
| "userName": {
|
| "description": "Human-readable name for this source; may be user or system generated.",
|
| "type": "string"
|
| @@ -3649,35 +3903,19 @@
|
| "description": "Data provided with a pipeline or transform to provide descriptive info.",
|
| "id": "DisplayData",
|
| "properties": {
|
| - "key": {
|
| - "description": "The key identifying the display data.\nThis is intended to be used as a label for the display data\nwhen viewed in a dax monitoring system.",
|
| - "type": "string"
|
| - },
|
| - "shortStrValue": {
|
| - "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"
|
| - },
|
| - "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",
|
| "type": "string"
|
| },
|
| - "javaClassValue": {
|
| - "description": "Contains value if the data is of java class type.",
|
| - "type": "string"
|
| - },
|
| "boolValue": {
|
| "description": "Contains value if the data is of a boolean type.",
|
| "type": "boolean"
|
| },
|
| + "javaClassValue": {
|
| + "description": "Contains value if the data is of java class type.",
|
| + "type": "string"
|
| + },
|
| "strValue": {
|
| "description": "Contains value if the data is of string type.",
|
| "type": "string"
|
| @@ -3700,63 +3938,79 @@
|
| "description": "Contains value if the data is of float type.",
|
| "format": "float",
|
| "type": "number"
|
| + },
|
| + "key": {
|
| + "description": "The key identifying the display data.\nThis is intended to be used as a label for the display data\nwhen viewed in a dax monitoring system.",
|
| + "type": "string"
|
| + },
|
| + "shortStrValue": {
|
| + "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"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "LeaseWorkItemRequest": {
|
| - "description": "Request to lease WorkItems.",
|
| - "id": "LeaseWorkItemRequest",
|
| + "GetDebugConfigRequest": {
|
| + "description": "Request to get updated debug configuration for component.",
|
| + "id": "GetDebugConfigRequest",
|
| "properties": {
|
| - "workerCapabilities": {
|
| - "description": "Worker capabilities. WorkItems might be limited to workers with specific\ncapabilities.",
|
| - "items": {
|
| - "type": "string"
|
| - },
|
| - "type": "array"
|
| + "componentId": {
|
| + "description": "The internal component id for which debug configuration is\nrequested.",
|
| + "type": "string"
|
| },
|
| "workerId": {
|
| - "description": "Identifies the worker leasing work -- typically the ID of the\nvirtual machine running the worker.",
|
| + "description": "The worker id, i.e., VM hostname.",
|
| "type": "string"
|
| },
|
| - "requestedLeaseDuration": {
|
| - "description": "The initial lease period.",
|
| - "format": "google-duration",
|
| + "location": {
|
| + "description": "The location which contains the job specified by job_id.",
|
| "type": "string"
|
| - },
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "LeaseWorkItemRequest": {
|
| + "description": "Request to lease WorkItems.",
|
| + "id": "LeaseWorkItemRequest",
|
| + "properties": {
|
| "currentWorkerTime": {
|
| "description": "The current timestamp at the worker.",
|
| "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"
|
| - }
|
| - },
|
| - "type": "object"
|
| - },
|
| - "GetDebugConfigRequest": {
|
| - "description": "Request to get updated debug configuration for component.",
|
| - "id": "GetDebugConfigRequest",
|
| - "properties": {
|
| + },
|
| "location": {
|
| - "description": "The location which contains the job specified by job_id.",
|
| + "description": "The location which contains the WorkItem's job.",
|
| "type": "string"
|
| },
|
| - "componentId": {
|
| - "description": "The internal component id for which debug configuration is\nrequested.",
|
| - "type": "string"
|
| + "workerCapabilities": {
|
| + "description": "Worker capabilities. WorkItems might be limited to workers with specific\ncapabilities.",
|
| + "items": {
|
| + "type": "string"
|
| + },
|
| + "type": "array"
|
| },
|
| "workerId": {
|
| - "description": "The worker id, i.e., VM hostname.",
|
| + "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",
|
| "type": "string"
|
| }
|
| },
|
| @@ -3781,13 +4035,13 @@
|
| "description": "Structured data associated with this message.",
|
| "id": "Parameter",
|
| "properties": {
|
| - "key": {
|
| - "description": "Key or name for this parameter.",
|
| - "type": "string"
|
| - },
|
| "value": {
|
| "description": "Value for this parameter.",
|
| "type": "any"
|
| + },
|
| + "key": {
|
| + "description": "Key or name for this parameter.",
|
| + "type": "string"
|
| }
|
| },
|
| "type": "object"
|
| @@ -3803,15 +4057,15 @@
|
| },
|
| "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"
|
| - },
|
| "currentWorkerTime": {
|
| "description": "The current timestamp at the worker.",
|
| "format": "google-datetime",
|
| "type": "string"
|
| },
|
| + "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"
|
| + },
|
| "location": {
|
| "description": "The location which contains the WorkItem's job.",
|
| "type": "string"
|
| @@ -3823,13 +4077,6 @@
|
| "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"
|
| - },
|
| "displayData": {
|
| "description": "Pipeline level display data.",
|
| "items": {
|
| @@ -3843,6 +4090,13 @@
|
| "$ref": "ExecutionStageSummary"
|
| },
|
| "type": "array"
|
| + },
|
| + "originalPipelineTransform": {
|
| + "description": "Description of each transform in the pipeline and collections between them.",
|
| + "items": {
|
| + "$ref": "TransformSummary"
|
| + },
|
| + "type": "array"
|
| }
|
| },
|
| "type": "object"
|
| @@ -3851,6 +4105,11 @@
|
| "description": "A task that carries configuration information for streaming computations.",
|
| "id": "StreamingConfigTask",
|
| "properties": {
|
| + "windmillServicePort": {
|
| + "description": "If present, the worker must use this port to communicate with Windmill\nService dispatchers. Only applicable when windmill_service_endpoint is\nspecified.",
|
| + "format": "int64",
|
| + "type": "string"
|
| + },
|
| "streamingComputationConfigs": {
|
| "description": "Set of computation configuration information.",
|
| "items": {
|
| @@ -3868,11 +4127,6 @@
|
| },
|
| "description": "Map from user step names to state families.",
|
| "type": "object"
|
| - },
|
| - "windmillServicePort": {
|
| - "description": "If present, the worker must use this port to communicate with Windmill\nService dispatchers. Only applicable when windmill_service_endpoint is\nspecified.",
|
| - "format": "int64",
|
| - "type": "string"
|
| }
|
| },
|
| "type": "object"
|
| @@ -3895,14 +4149,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": {
|
| - "properties": {
|
| - "additionalProperties": {
|
| - "description": "Properties of the object.",
|
| - "type": "any"
|
| - },
|
| - "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"
|
| - },
|
| "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"
|
| @@ -3910,6 +4156,14 @@
|
| "kind": {
|
| "description": "The kind of step in the Cloud Dataflow job.",
|
| "type": "string"
|
| + },
|
| + "properties": {
|
| + "additionalProperties": {
|
| + "description": "Properties of the object.",
|
| + "type": "any"
|
| + },
|
| + "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"
|
| @@ -3929,15 +4183,15 @@
|
| "description": "Describes the data disk used by a workflow job.",
|
| "id": "Disk",
|
| "properties": {
|
| + "diskType": {
|
| + "description": "Disk storage type, as defined by Google Compute Engine. This\nmust be a disk type appropriate to the project and zone in which\nthe workers will run. If unknown or unspecified, the service\nwill attempt to choose a reasonable default.\n\nFor example, the standard persistent disk type is a resource name\ntypically ending in \"pd-standard\". If SSD persistent disks are\navailable, the resource name typically ends with \"pd-ssd\". The\nactual valid values are defined the Google Compute Engine API,\nnot by the Cloud Dataflow API; consult the Google Compute Engine\ndocumentation for more information about determining the set of\navailable disk types for a particular project and zone.\n\nGoogle Compute Engine Disk types are local to a particular\nproject in a particular zone, and so the resource name will\ntypically look something like this:\n\ncompute.googleapis.com/projects/project-id/zones/zone/diskTypes/pd-standard",
|
| + "type": "string"
|
| + },
|
| "sizeGb": {
|
| "description": "Size of disk in GB. If zero or unspecified, the service will\nattempt to choose a reasonable default.",
|
| "format": "int32",
|
| "type": "integer"
|
| },
|
| - "diskType": {
|
| - "description": "Disk storage type, as defined by Google Compute Engine. This\nmust be a disk type appropriate to the project and zone in which\nthe workers will run. If unknown or unspecified, the service\nwill attempt to choose a reasonable default.\n\nFor example, the standard persistent disk type is a resource name\ntypically ending in \"pd-standard\". If SSD persistent disks are\navailable, the resource name typically ends with \"pd-ssd\". The\nactual valid values are defined the Google Compute Engine API,\nnot by the Cloud Dataflow API; consult the Google Compute Engine\ndocumentation for more information about determining the set of\navailable disk types for a particular project and zone.\n\nGoogle Compute Engine Disk types are local to a particular\nproject in a particular zone, and so the resource name will\ntypically look something like this:\n\ncompute.googleapis.com/projects/project-id/zones/zone/diskTypes/pd-standard",
|
| - "type": "string"
|
| - },
|
| "mountPoint": {
|
| "description": "Directory in a VM where disk is mounted.",
|
| "type": "string"
|
| @@ -3949,8 +4203,8 @@
|
| "description": "CounterMetadata includes all static non-name non-value counter attributes.",
|
| "id": "CounterMetadata",
|
| "properties": {
|
| - "otherUnits": {
|
| - "description": "A string referring to the unit type.",
|
| + "description": {
|
| + "description": "Human-readable description of the counter semantics.",
|
| "type": "string"
|
| },
|
| "kind": {
|
| @@ -3979,10 +4233,6 @@
|
| ],
|
| "type": "string"
|
| },
|
| - "description": {
|
| - "description": "Human-readable description of the counter semantics.",
|
| - "type": "string"
|
| - },
|
| "standardUnits": {
|
| "description": "System defined Units, see above enum.",
|
| "enum": [
|
| @@ -4006,6 +4256,10 @@
|
| "Counter returns a timestamp in nanoseconds."
|
| ],
|
| "type": "string"
|
| + },
|
| + "otherUnits": {
|
| + "description": "A string referring to the unit type.",
|
| + "type": "string"
|
| }
|
| },
|
| "type": "object"
|
| @@ -4014,6 +4268,13 @@
|
| "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": {
|
| @@ -4024,13 +4285,6 @@
|
| "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"
|
| @@ -4077,13 +4331,13 @@
|
| "description": "State family configuration.",
|
| "id": "StateFamilyConfig",
|
| "properties": {
|
| - "stateFamily": {
|
| - "description": "The state family value.",
|
| - "type": "string"
|
| - },
|
| "isRead": {
|
| "description": "If true, this family corresponds to a read operation.",
|
| "type": "boolean"
|
| + },
|
| + "stateFamily": {
|
| + "description": "The state family value.",
|
| + "type": "string"
|
| }
|
| },
|
| "type": "object"
|
| @@ -4098,6 +4352,13 @@
|
| "description": "The response to a SourceSplitRequest.",
|
| "id": "SourceSplitResponse",
|
| "properties": {
|
| + "shards": {
|
| + "description": "DEPRECATED in favor of bundles.",
|
| + "items": {
|
| + "$ref": "SourceSplitShard"
|
| + },
|
| + "type": "array"
|
| + },
|
| "outcome": {
|
| "description": "Indicates whether splitting happened and produced a list of bundles.\nIf this is USE_CURRENT_SOURCE_AS_IS, the current source should\nbe processed \"as is\" without splitting. \"bundles\" is ignored in this case.\nIf this is SPLITTING_HAPPENED, then \"bundles\" contains a list of\nbundles into which the source was split.",
|
| "enum": [
|
| @@ -4118,13 +4379,6 @@
|
| "$ref": "DerivedSource"
|
| },
|
| "type": "array"
|
| - },
|
| - "shards": {
|
| - "description": "DEPRECATED in favor of bundles.",
|
| - "items": {
|
| - "$ref": "SourceSplitShard"
|
| - },
|
| - "type": "array"
|
| }
|
| },
|
| "type": "object"
|
| @@ -4133,21 +4387,6 @@
|
| "description": "Describes a particular operation comprising a MapTask.",
|
| "id": "ParallelInstruction",
|
| "properties": {
|
| - "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."
|
| @@ -4164,12 +4403,27 @@
|
| "$ref": "FlattenInstruction",
|
| "description": "Additional information for Flatten instructions."
|
| },
|
| + "systemName": {
|
| + "description": "System-defined name of this operation.\nUnique across the workflow.",
|
| + "type": "string"
|
| + },
|
| "write": {
|
| "$ref": "WriteInstruction",
|
| "description": "Additional information for Write instructions."
|
| },
|
| - "systemName": {
|
| - "description": "System-defined name of this operation.\nUnique across the workflow.",
|
| + "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"
|
| }
|
| },
|
| @@ -4194,14 +4448,14 @@
|
| "description": "Data disk assignment information for a specific key-range of a sharded\ncomputation.\nCurrently we only support UTF-8 character splits to simplify encoding into\nJSON.",
|
| "id": "KeyRangeDataDiskAssignment",
|
| "properties": {
|
| - "start": {
|
| - "description": "The start (inclusive) of the key range.",
|
| - "type": "string"
|
| - },
|
| "dataDisk": {
|
| "description": "The name of the data disk where data for this range is stored.\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"
|
| },
|
| + "start": {
|
| + "description": "The start (inclusive) of the key range.",
|
| + "type": "string"
|
| + },
|
| "end": {
|
| "description": "The end (exclusive) of the key range.",
|
| "type": "string"
|
| @@ -4213,6 +4467,21 @@
|
| "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": {
|
| + "multiOutputInfos": {
|
| + "description": "Information about each of the outputs, if user_fn is a MultiDoFn.",
|
| + "items": {
|
| + "$ref": "MultiOutputInfo"
|
| + },
|
| + "type": "array"
|
| + },
|
| + "userFn": {
|
| + "additionalProperties": {
|
| + "description": "Properties of the object.",
|
| + "type": "any"
|
| + },
|
| + "description": "The user function to invoke.",
|
| + "type": "object"
|
| + },
|
| "input": {
|
| "$ref": "InstructionInput",
|
| "description": "The input."
|
| @@ -4228,21 +4497,54 @@
|
| "$ref": "SideInputInfo"
|
| },
|
| "type": "array"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "MetricUpdate": {
|
| + "description": "Describes the state of a metric.",
|
| + "id": "MetricUpdate",
|
| + "properties": {
|
| + "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"
|
| },
|
| - "multiOutputInfos": {
|
| - "description": "Information about each of the outputs, if user_fn is a MultiDoFn.",
|
| - "items": {
|
| - "$ref": "MultiOutputInfo"
|
| - },
|
| - "type": "array"
|
| + "meanCount": {
|
| + "description": "Worker-computed aggregate value for the \"Mean\" aggregation kind.\nThis holds the count of the aggregated values and is used in combination\nwith mean_sum above to obtain the actual mean aggregate value.\nThe only possible value type is Long.",
|
| + "type": "any"
|
| },
|
| - "userFn": {
|
| - "additionalProperties": {
|
| - "description": "Properties of the object.",
|
| - "type": "any"
|
| - },
|
| - "description": "The user function to invoke.",
|
| - "type": "object"
|
| + "meanSum": {
|
| + "description": "Worker-computed aggregate value for the \"Mean\" aggregation kind.\nThis holds the sum of the aggregated values and is used in combination\nwith mean_count below to obtain the actual mean aggregate value.\nThe only possible value types are Long and Double.",
|
| + "type": "any"
|
| + },
|
| + "updateTime": {
|
| + "description": "Timestamp associated with the metric value. Optional when workers are\nreporting work progress; it will be filled in responses from the\nmetrics API.",
|
| + "format": "google-datetime",
|
| + "type": "string"
|
| + },
|
| + "name": {
|
| + "$ref": "MetricStructuredName",
|
| + "description": "Name of the metric."
|
| + },
|
| + "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"
|
| @@ -4281,6 +4583,14 @@
|
| "description": "A string containing a more specific namespace of the counter's origin.",
|
| "type": "string"
|
| },
|
| + "executionStepName": {
|
| + "description": "Name of the stage. An execution step contains multiple component steps.",
|
| + "type": "string"
|
| + },
|
| + "name": {
|
| + "description": "Counter name. Not necessarily globally-unique, but unique within the\ncontext of the other fields.\nRequired.",
|
| + "type": "string"
|
| + },
|
| "origin": {
|
| "description": "One of the standard Origins defined above.",
|
| "enum": [
|
| @@ -4292,62 +4602,6 @@
|
| "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"
|
| - },
|
| - "MetricUpdate": {
|
| - "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"
|
| - },
|
| - "meanCount": {
|
| - "description": "Worker-computed aggregate value for the \"Mean\" aggregation kind.\nThis holds the count of the aggregated values and is used in combination\nwith mean_sum above to obtain the actual mean aggregate value.\nThe only possible value type is Long.",
|
| - "type": "any"
|
| - },
|
| - "meanSum": {
|
| - "description": "Worker-computed aggregate value for the \"Mean\" aggregation kind.\nThis holds the sum of the aggregated values and is used in combination\nwith mean_count below to obtain the actual mean aggregate value.\nThe only possible value types are Long and Double.",
|
| - "type": "any"
|
| - },
|
| - "updateTime": {
|
| - "description": "Timestamp associated with the metric value. Optional when workers are\nreporting work progress; it will be filled in responses from the\nmetrics API.",
|
| - "format": "google-datetime",
|
| - "type": "string"
|
| - },
|
| - "name": {
|
| - "$ref": "MetricStructuredName",
|
| - "description": "Name of the metric."
|
| - },
|
| - "distribution": {
|
| - "description": "A struct value describing properties of a distribution of numeric values.",
|
| - "type": "any"
|
| }
|
| },
|
| "type": "object"
|
| @@ -4377,13 +4631,13 @@
|
| "description": "A worker_message response allows the server to pass information to the\nsender.",
|
| "id": "WorkerMessageResponse",
|
| "properties": {
|
| - "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)."
|
| + },
|
| + "workerHealthReportResponse": {
|
| + "$ref": "WorkerHealthReportResponse",
|
| + "description": "The service's response to a worker's health report."
|
| }
|
| },
|
| "type": "object"
|
| @@ -4392,10 +4646,6 @@
|
| "description": "Metadata describing a template.",
|
| "id": "TemplateMetadata",
|
| "properties": {
|
| - "name": {
|
| - "description": "Required. The name of the template.",
|
| - "type": "string"
|
| - },
|
| "parameters": {
|
| "description": "The parameters for the template.",
|
| "items": {
|
| @@ -4403,6 +4653,10 @@
|
| },
|
| "type": "array"
|
| },
|
| + "name": {
|
| + "description": "Required. The name of the template.",
|
| + "type": "string"
|
| + },
|
| "description": {
|
| "description": "Optional. A description of the template.",
|
| "type": "string"
|
| @@ -4423,14 +4677,14 @@
|
| "$ref": "WorkerHealthReport",
|
| "description": "The health of a worker."
|
| },
|
| - "workerMessageCode": {
|
| - "$ref": "WorkerMessageCode",
|
| - "description": "A worker message code."
|
| - },
|
| "workerMetrics": {
|
| "$ref": "ResourceUtilizationReport",
|
| "description": "Resource metrics reported by workers."
|
| },
|
| + "workerMessageCode": {
|
| + "$ref": "WorkerMessageCode",
|
| + "description": "A worker message code."
|
| + },
|
| "labels": {
|
| "additionalProperties": {
|
| "type": "string"
|
| @@ -4445,17 +4699,17 @@
|
| "description": "JobMetrics contains a collection of metrics descibing the detailed progress\nof a Dataflow job. Metrics correspond to user-defined and system-defined\nmetrics in the job.\n\nThis resource captures only the most recent values of each metric;\ntime-series data can be queried for them (under the same metric names)\nfrom Cloud Monitoring.",
|
| "id": "JobMetrics",
|
| "properties": {
|
| - "metricTime": {
|
| - "description": "Timestamp as of which metric values are current.",
|
| - "format": "google-datetime",
|
| - "type": "string"
|
| - },
|
| "metrics": {
|
| "description": "All metrics for this job.",
|
| "items": {
|
| "$ref": "MetricUpdate"
|
| },
|
| "type": "array"
|
| + },
|
| + "metricTime": {
|
| + "description": "Timestamp as of which metric values are current.",
|
| + "format": "google-datetime",
|
| + "type": "string"
|
| }
|
| },
|
| "type": "object"
|
| @@ -4479,27 +4733,48 @@
|
| "description": "An update to a Counter sent from a worker.",
|
| "id": "CounterUpdate",
|
| "properties": {
|
| - "integer": {
|
| - "$ref": "SplitInt64",
|
| - "description": "Integer value for Sum, Max, Min."
|
| + "nameAndKind": {
|
| + "$ref": "NameAndKind",
|
| + "description": "Counter name and aggregation type."
|
| },
|
| - "structuredNameAndMetadata": {
|
| - "$ref": "CounterStructuredNameAndMetadata",
|
| - "description": "Counter structured name and metadata."
|
| + "distribution": {
|
| + "$ref": "DistributionUpdate",
|
| + "description": "Distribution data"
|
| },
|
| - "integerList": {
|
| - "$ref": "IntegerList",
|
| - "description": "List of integers, for Set."
|
| + "stringList": {
|
| + "$ref": "StringList",
|
| + "description": "List of strings, for Set."
|
| },
|
| - "floatingPoint": {
|
| - "description": "Floating point value for Sum, Max, Min.",
|
| - "format": "double",
|
| - "type": "number"
|
| + "shortId": {
|
| + "description": "The service-generated short identifier for this counter.\nThe short_id -> (name, metadata) mapping is constant for the lifetime of\na job.",
|
| + "format": "int64",
|
| + "type": "string"
|
| + },
|
| + "floatingPointList": {
|
| + "$ref": "FloatingPointList",
|
| + "description": "List of floating point numbers, for Set."
|
| + },
|
| + "integer": {
|
| + "$ref": "SplitInt64",
|
| + "description": "Integer value for Sum, Max, Min."
|
| + },
|
| + "structuredNameAndMetadata": {
|
| + "$ref": "CounterStructuredNameAndMetadata",
|
| + "description": "Counter structured name and metadata."
|
| + },
|
| + "integerList": {
|
| + "$ref": "IntegerList",
|
| + "description": "List of integers, for Set."
|
| },
|
| "integerMean": {
|
| "$ref": "IntegerMean",
|
| "description": "Integer mean aggregation value for Mean."
|
| },
|
| + "floatingPoint": {
|
| + "description": "Floating point value for Sum, Max, Min.",
|
| + "format": "double",
|
| + "type": "number"
|
| + },
|
| "internal": {
|
| "description": "Value for internally-defined counters used by the Dataflow service.",
|
| "type": "any"
|
| @@ -4515,27 +4790,6 @@
|
| "boolean": {
|
| "description": "Boolean value for And, Or.",
|
| "type": "boolean"
|
| - },
|
| - "nameAndKind": {
|
| - "$ref": "NameAndKind",
|
| - "description": "Counter name and aggregation type."
|
| - },
|
| - "distribution": {
|
| - "$ref": "DistributionUpdate",
|
| - "description": "Distribution data"
|
| - },
|
| - "stringList": {
|
| - "$ref": "StringList",
|
| - "description": "List of strings, for Set."
|
| - },
|
| - "shortId": {
|
| - "description": "The service-generated short identifier for this counter.\nThe short_id -> (name, metadata) mapping is constant for the lifetime of\na job.",
|
| - "format": "int64",
|
| - "type": "string"
|
| - },
|
| - "floatingPointList": {
|
| - "$ref": "FloatingPointList",
|
| - "description": "List of floating point numbers, for Set."
|
| }
|
| },
|
| "type": "object"
|
| @@ -4544,18 +4798,18 @@
|
| "description": "Metadata about a Source useful for automatically optimizing\nand tuning the pipeline, etc.",
|
| "id": "SourceMetadata",
|
| "properties": {
|
| - "producesSortedKeys": {
|
| - "description": "Whether this source is known to produce key/value pairs with\nthe (encoded) keys in lexicographically sorted order.",
|
| - "type": "boolean"
|
| + "estimatedSizeBytes": {
|
| + "description": "An estimate of the total size (in bytes) of the data that would be\nread from this source. This estimate is in terms of external storage\nsize, before any decompression or other processing done by the reader.",
|
| + "format": "int64",
|
| + "type": "string"
|
| },
|
| "infinite": {
|
| "description": "Specifies that the size of this source is known to be infinite\n(this is a streaming source).",
|
| "type": "boolean"
|
| },
|
| - "estimatedSizeBytes": {
|
| - "description": "An estimate of the total size (in bytes) of the data that would be\nread from this source. This estimate is in terms of external storage\nsize, before any decompression or other processing done by the reader.",
|
| - "format": "int64",
|
| - "type": "string"
|
| + "producesSortedKeys": {
|
| + "description": "Whether this source is known to produce key/value pairs with\nthe (encoded) keys in lexicographically sorted order.",
|
| + "type": "boolean"
|
| }
|
| },
|
| "type": "object"
|
| @@ -4579,15 +4833,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."
|
| @@ -4611,10 +4865,6 @@
|
| "description": "DEPRECATED in favor of DynamicSourceSplit.",
|
| "id": "SourceFork",
|
| "properties": {
|
| - "residualSource": {
|
| - "$ref": "DerivedSource",
|
| - "description": "DEPRECATED"
|
| - },
|
| "primary": {
|
| "$ref": "SourceSplitShard",
|
| "description": "DEPRECATED"
|
| @@ -4626,6 +4876,10 @@
|
| "residual": {
|
| "$ref": "SourceSplitShard",
|
| "description": "DEPRECATED"
|
| + },
|
| + "residualSource": {
|
| + "$ref": "DerivedSource",
|
| + "description": "DEPRECATED"
|
| }
|
| },
|
| "type": "object"
|
| @@ -4634,41 +4888,6 @@
|
| "description": "Conveys a worker's progress through the work described by a WorkItem.",
|
| "id": "WorkItemStatus",
|
| "properties": {
|
| - "workItemId": {
|
| - "description": "Identifies the WorkItem.",
|
| - "type": "string"
|
| - },
|
| - "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": "Status"
|
| - },
|
| - "type": "array"
|
| - },
|
| - "metricUpdates": {
|
| - "description": "DEPRECATED in favor of counter_updates.",
|
| - "items": {
|
| - "$ref": "MetricUpdate"
|
| - },
|
| - "type": "array"
|
| - },
|
| - "dynamicSourceSplit": {
|
| - "$ref": "DynamicSourceSplit",
|
| - "description": "See documentation of stop_position."
|
| - },
|
| - "sourceOperationResponse": {
|
| - "$ref": "SourceOperationResponse",
|
| - "description": "If the work item represented a SourceOperationRequest, and the work\nis completed, contains the result of the operation."
|
| - },
|
| - "progress": {
|
| - "$ref": "ApproximateProgress",
|
| - "description": "DEPRECATED in favor of reported_progress."
|
| - },
|
| - "requestedLeaseDuration": {
|
| - "description": "Amount of time the worker requests for its lease.",
|
| - "format": "google-duration",
|
| - "type": "string"
|
| - },
|
| "reportIndex": {
|
| "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",
|
| @@ -4696,259 +4915,40 @@
|
| "$ref": "CounterUpdate"
|
| },
|
| "type": "array"
|
| - }
|
| - },
|
| - "type": "object"
|
| - },
|
| - "ComponentSource": {
|
| - "description": "Description of an interstitial value between transforms in an execution\nstage.",
|
| - "id": "ComponentSource",
|
| - "properties": {
|
| - "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"
|
| - },
|
| - "originalTransformOrCollection": {
|
| - "description": "User name for the original user transform or collection with which this\nsource is most closely associated.",
|
| - "type": "string"
|
| - }
|
| - },
|
| - "type": "object"
|
| - },
|
| - "WorkItemServiceState": {
|
| - "description": "The Dataflow service's idea of the current state of a WorkItem\nbeing processed by a worker.",
|
| - "id": "WorkItemServiceState",
|
| - "properties": {
|
| - "leaseExpireTime": {
|
| - "description": "Time at which the current lease will expire.",
|
| - "format": "google-datetime",
|
| - "type": "string"
|
| - },
|
| - "metricShortId": {
|
| - "description": "The short ids that workers should use in subsequent metric updates.\nWorkers should strive to use short ids whenever possible, but it is ok\nto request the short_id again if a worker lost track of it\n(e.g. if the worker is recovering from a crash).\nNOTE: it is possible that the response may have short ids for a subset\nof the metrics.",
|
| - "items": {
|
| - "$ref": "MetricShortId"
|
| - },
|
| - "type": "array"
|
| - },
|
| - "nextReportIndex": {
|
| - "description": "The index value to use for the next report sent by the worker.\nNote: If the report call fails for whatever reason, the worker should\nreuse this index for subsequent report attempts.",
|
| - "format": "int64",
|
| - "type": "string"
|
| - },
|
| - "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"
|
| - },
|
| - "MetricStructuredName": {
|
| - "description": "Identifies a metric, by describing the source which generated the\nmetric.",
|
| - "id": "MetricStructuredName",
|
| - "properties": {
|
| - "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"
|
| - },
|
| - "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"
|
| - },
|
| - "SeqMapTaskOutputInfo": {
|
| - "description": "Information about an output of a SeqMapTask.",
|
| - "id": "SeqMapTaskOutputInfo",
|
| - "properties": {
|
| - "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"
|
| - },
|
| - "JobExecutionStageInfo": {
|
| - "description": "Contains information about how a particular\ngoogle.dataflow.v1beta3.Step will be executed.",
|
| - "id": "JobExecutionStageInfo",
|
| - "properties": {
|
| - "stepName": {
|
| - "description": "The steps associated with the execution stage.\nNote that stages may have several steps, and that a given step\nmight be run by more than one stage.",
|
| - "items": {
|
| - "type": "string"
|
| - },
|
| - "type": "array"
|
| - }
|
| - },
|
| - "type": "object"
|
| - },
|
| - "KeyRangeLocation": {
|
| - "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"
|
| - },
|
| - "dataDisk": {
|
| - "description": "The name of the data disk where data for this range is stored.\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"
|
| - },
|
| - "end": {
|
| - "description": "The end (exclusive) of the key range.",
|
| - "type": "string"
|
| - }
|
| - },
|
| - "type": "object"
|
| - },
|
| - "SourceGetMetadataRequest": {
|
| - "description": "A request to compute the SourceMetadata of a Source.",
|
| - "id": "SourceGetMetadataRequest",
|
| - "properties": {
|
| - "source": {
|
| - "$ref": "Source",
|
| - "description": "Specification of the source whose metadata should be computed."
|
| - }
|
| - },
|
| - "type": "object"
|
| - },
|
| - "SeqMapTask": {
|
| - "description": "Describes a particular function to invoke.",
|
| - "id": "SeqMapTask",
|
| - "properties": {
|
| - "name": {
|
| - "description": "The user-provided name of the SeqDo operation.",
|
| + "workItemId": {
|
| + "description": "Identifies the WorkItem.",
|
| "type": "string"
|
| },
|
| - "outputInfos": {
|
| - "description": "Information about each of the outputs.",
|
| + "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": "SeqMapTaskOutputInfo"
|
| + "$ref": "Status"
|
| },
|
| "type": "array"
|
| },
|
| - "inputs": {
|
| - "description": "Information about each of the inputs.",
|
| + "metricUpdates": {
|
| + "description": "DEPRECATED in favor of counter_updates.",
|
| "items": {
|
| - "$ref": "SideInputInfo"
|
| + "$ref": "MetricUpdate"
|
| },
|
| "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"
|
| + "dynamicSourceSplit": {
|
| + "$ref": "DynamicSourceSplit",
|
| + "description": "See documentation of stop_position."
|
| },
|
| - "userFn": {
|
| - "additionalProperties": {
|
| - "description": "Properties of the object.",
|
| - "type": "any"
|
| - },
|
| - "description": "The user function to invoke.",
|
| - "type": "object"
|
| - }
|
| - },
|
| - "type": "object"
|
| - },
|
| - "NameAndKind": {
|
| - "description": "Basic metadata about a counter.",
|
| - "id": "NameAndKind",
|
| - "properties": {
|
| - "name": {
|
| - "description": "Name of the counter.",
|
| - "type": "string"
|
| + "sourceOperationResponse": {
|
| + "$ref": "SourceOperationResponse",
|
| + "description": "If the work item represented a SourceOperationRequest, and the work\nis completed, contains the result of the operation."
|
| },
|
| - "kind": {
|
| - "description": "Counter aggregation kind.",
|
| - "enum": [
|
| - "INVALID",
|
| - "SUM",
|
| - "MAX",
|
| - "MIN",
|
| - "MEAN",
|
| - "OR",
|
| - "AND",
|
| - "SET",
|
| - "DISTRIBUTION"
|
| - ],
|
| - "enumDescriptions": [
|
| - "Counter aggregation kind was not set.",
|
| - "Aggregated value is the sum of all contributed values.",
|
| - "Aggregated value is the max of all contributed values.",
|
| - "Aggregated value is the min of all contributed values.",
|
| - "Aggregated value is the mean of all contributed values.",
|
| - "Aggregated value represents the logical 'or' of all contributed values.",
|
| - "Aggregated value represents the logical 'and' of all contributed values.",
|
| - "Aggregated value is a set of unique contributed values.",
|
| - "Aggregated value captures statistics about a distribution."
|
| - ],
|
| - "type": "string"
|
| - }
|
| - },
|
| - "type": "object"
|
| - },
|
| - "WorkerMessageCode": {
|
| - "description": "A message code is used to report status and error messages to the service.\nThe message codes are intended to be machine readable. The service will\ntake care of translating these into user understandable messages if\nnecessary.\n\nExample use cases:\n 1. Worker processes reporting successful startup.\n 2. Worker processes reporting specific errors (e.g. package staging\n failure).",
|
| - "id": "WorkerMessageCode",
|
| - "properties": {
|
| - "parameters": {
|
| - "additionalProperties": {
|
| - "description": "Properties of the object.",
|
| - "type": "any"
|
| - },
|
| - "description": "Parameters contains specific information about the code.\n\nThis is a struct to allow parameters of different types.\n\nExamples:\n 1. For a \"HARNESS_STARTED\" message parameters might provide the name\n of the worker and additional data like timing information.\n 2. For a \"GCS_DOWNLOAD_ERROR\" parameters might contain fields listing\n the GCS objects being downloaded and fields containing errors.\n\nIn general complex data structures should be avoided. If a worker\nneeds to send a specific and complicated data structure then please\nconsider defining a new proto and adding it to the data oneof in\nWorkerMessageResponse.\n\nConventions:\n Parameters should only be used for information that isn't typically passed\n as a label.\n hostname and other worker identifiers should almost always be passed\n as labels since they will be included on most messages.",
|
| - "type": "object"
|
| + "progress": {
|
| + "$ref": "ApproximateProgress",
|
| + "description": "DEPRECATED in favor of reported_progress."
|
| },
|
| - "code": {
|
| - "description": "The code is a string intended for consumption by a machine that identifies\nthe type of message being sent.\nExamples:\n 1. \"HARNESS_STARTED\" might be used to indicate the worker harness has\n started.\n 2. \"GCS_DOWNLOAD_ERROR\" might be used to indicate an error downloading\n a GCS file as part of the boot process of one of the worker containers.\n\nThis is a string and not an enum to make it easy to add new codes without\nwaiting for an API change.",
|
| + "requestedLeaseDuration": {
|
| + "description": "Amount of time the worker requests for its lease.",
|
| + "format": "google-duration",
|
| "type": "string"
|
| }
|
| },
|
|
|
Chromium Code Reviews
Issue 2973303002:
Api-Roll 51: 2017-07-10 (Closed)
