PipelineArgs

data class PipelineArgs(val displayName: Output<String>? = null, val location: Output<String>? = null, val name: Output<String>? = null, val pipelineSources: Output<Map<String, String>>? = null, val project: Output<String>? = null, val scheduleInfo: Output<GoogleCloudDatapipelinesV1ScheduleSpecArgs>? = null, val schedulerServiceAccountEmail: Output<String>? = null, val state: Output<PipelineState>? = null, val type: Output<PipelineType>? = null, val workload: Output<GoogleCloudDatapipelinesV1WorkloadArgs>? = null) : ConvertibleToJava<PipelineArgs>

Creates a pipeline. For a batch pipeline, you can pass scheduler information. Data Pipelines uses the scheduler information to create an internal scheduler that runs jobs periodically. If the internal scheduler is not configured, you can use RunPipeline to run jobs.

Constructors

Link copied to clipboard
constructor(displayName: Output<String>? = null, location: Output<String>? = null, name: Output<String>? = null, pipelineSources: Output<Map<String, String>>? = null, project: Output<String>? = null, scheduleInfo: Output<GoogleCloudDatapipelinesV1ScheduleSpecArgs>? = null, schedulerServiceAccountEmail: Output<String>? = null, state: Output<PipelineState>? = null, type: Output<PipelineType>? = null, workload: Output<GoogleCloudDatapipelinesV1WorkloadArgs>? = null)

Properties

Link copied to clipboard
val displayName: Output<String>? = null

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

Link copied to clipboard
val location: Output<String>? = null
Link copied to clipboard
val name: Output<String>? = null

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&#46;cloud&#46;location&#46;Locations&#46;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.

Link copied to clipboard
val pipelineSources: Output<Map<String, String>>? = null

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

Link copied to clipboard
val project: Output<String>? = null
Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard
val state: Output<PipelineState>? = null

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.

Link copied to clipboard
val type: Output<PipelineType>? = null

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

Link copied to clipboard

Workload information for creating new jobs.

Functions

Link copied to clipboard
open override fun toJava(): PipelineArgs