View Source GoogleApi.DataPipelines.V1.Model.GoogleCloudDatapipelinesV1Pipeline (google_api_data_pipelines v0.4.0)
The main pipeline entity and all the necessary metadata for launching and managing linked jobs.
Attributes
-
createTime
(type:DateTime.t
, default:nil
) - Output only. Immutable. The timestamp when the pipeline was initially created. Set by the Data Pipelines service. -
displayName
(type:String.t
, default:nil
) - Required. The display name of the pipeline. It can contain only letters ([A-Za-z]), numbers ([0-9]), hyphens (-), and underscores (_). -
jobCount
(type:integer()
, default:nil
) - Output only. Number of jobs. -
lastUpdateTime
(type:DateTime.t
, default:nil
) - Output only. Immutable. The timestamp when the pipeline was last modified. Set by the Data Pipelines service. -
name
(type:String.t
, default:nil
) - 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 callinggoogle.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. -
pipelineSources
(type:map()
, default:nil
) - Immutable. The sources of the pipeline (for example, Dataplex). The keys and values are set by the corresponding sources during pipeline creation. -
scheduleInfo
(type:GoogleApi.DataPipelines.V1.Model.GoogleCloudDatapipelinesV1ScheduleSpec.t
, default:nil
) - Internal scheduling information for a pipeline. If this information is provided, periodic jobs will be created per the schedule. If not, users are responsible for creating jobs externally. -
schedulerServiceAccountEmail
(type:String.t
, default:nil
) - 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
(type:String.t
, default:nil
) - 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. -
type
(type:String.t
, default:nil
) - Required. The type of the pipeline. This field affects the scheduling of the pipeline and the type of metrics to show for the pipeline. -
workload
(type:GoogleApi.DataPipelines.V1.Model.GoogleCloudDatapipelinesV1Workload.t
, default:nil
) - Workload information for creating new jobs.
Summary
Functions
Unwrap a decoded JSON object into its complex fields.
Types
@type t() :: %GoogleApi.DataPipelines.V1.Model.GoogleCloudDatapipelinesV1Pipeline{ createTime: DateTime.t() | nil, displayName: String.t() | nil, jobCount: integer() | nil, lastUpdateTime: DateTime.t() | nil, name: String.t() | nil, pipelineSources: map() | nil, scheduleInfo: GoogleApi.DataPipelines.V1.Model.GoogleCloudDatapipelinesV1ScheduleSpec.t() | nil, schedulerServiceAccountEmail: String.t() | nil, state: String.t() | nil, type: String.t() | nil, workload: GoogleApi.DataPipelines.V1.Model.GoogleCloudDatapipelinesV1Workload.t() | nil }
Functions
Unwrap a decoded JSON object into its complex fields.