Sign in

v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-1381935.0 KB
projects

Updates a pipeline. If successful, the updated Pipeline is returned. Returns NOT_FOUND if the pipeline doesn't exist. If UpdatePipeline does not return successfully, you can retry the UpdatePipeline request until you receive a successful response.

patch/v1/{+name}

Path parameters

namestring required

The pipeline name. For example: projects/PROJECT_ID/locations/LOCATION_ID/pipelines/PIPELINE_ID. * PROJECT_ID can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), and periods (.). For more information, see Identifying projects. * LOCATION_ID is the canonical ID for the pipeline's location. The list of available locations can be obtained by calling google.cloud.location.Locations.ListLocations. Note that the Data Pipelines service is not available in all regions. It depends on Cloud Scheduler, an App Engine application, so it's only available in App Engine regions. * PIPELINE_ID is the ID of the pipeline. Must be unique for the selected project and location.

Query parameters

updateMaskstring

The list of fields to be updated.

Request body

type'PIPELINE_TYPE_UNSPECIFIED' | 'PIPELINE_TYPE_BATCH' | 'PIPELINE_TYPE_STREAMING'

Required. The type of the pipeline. This field affects the scheduling of the pipeline and the type of metrics to show for the pipeline.

createTimestring google-datetime

Output only. Immutable. The timestamp when the pipeline was initially created. Set by the Data Pipelines service.

namestring

The pipeline name. For example: projects/PROJECT_ID/locations/LOCATION_ID/pipelines/PIPELINE_ID. * PROJECT_ID can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), and periods (.). For more information, see Identifying projects. * LOCATION_ID is the canonical ID for the pipeline's location. The list of available locations can be obtained by calling google.cloud.location.Locations.ListLocations. Note that the Data Pipelines service is not available in all regions. It depends on Cloud Scheduler, an App Engine application, so it's only available in App Engine regions. * PIPELINE_ID is the ID of the pipeline. Must be unique for the selected project and location.

displayNamestring

Required. The display name of the pipeline. It can contain only letters ([A-Za-z]), numbers ([0-9]), hyphens (-), and underscores (_).

pipelineSourcesobject

Immutable. The sources of the pipeline (for example, Knowledge Catalog). The keys and values are set by the corresponding sources during pipeline creation.

schedulerServiceAccountEmailstring

Optional. A service account email to be used with the Cloud Scheduler job. If not specified, the default compute engine service account will be used.

state'STATE_UNSPECIFIED' | 'STATE_RESUMING' | 'STATE_ACTIVE' | 'STATE_STOPPING' | 'STATE_ARCHIVED' | 'STATE_PAUSED'

Required. The state of the pipeline. When the pipeline is created, the state is set to 'PIPELINE_STATE_ACTIVE' by default. State changes can be requested by setting the state to stopping, paused, or resuming. State cannot be changed through UpdatePipeline requests.

jobCountinteger

Output only. Number of jobs.

lastUpdateTimestring google-datetime

Output only. Immutable. The timestamp when the pipeline was last modified. Set by the Data Pipelines service.

Response

Successful response