class Google::Apis::DatapipelinesV1::GoogleCloudDatapipelinesV1Pipeline

The main pipeline entity and all the necessary metadata for launching and managing linked jobs.

Attributes

create_time[RW]

Output only. Immutable. The timestamp when the pipeline was initially created. Set by the Data Pipelines service. Corresponds to the JSON property ‘createTime` @return [String]

display_name[RW]

Required. The display name of the pipeline. It can contain only letters ([A-Za- z]), numbers ([0-9]), hyphens (-), and underscores (_). Corresponds to the JSON property ‘displayName` @return [String]

job_count[RW]

Output only. Number of jobs. Corresponds to the JSON property ‘jobCount` @return [Fixnum]

last_update_time[RW]

Output only. Immutable. The timestamp when the pipeline was last modified. Set by the Data Pipelines service. Corresponds to the JSON property ‘lastUpdateTime` @return [String]

name[RW]

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](cloud.google.com/resource-manager/docs/creating- managing-projects#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](cloud.google.com/about/locations#region). * ‘PIPELINE_ID` is the ID of the pipeline. Must be unique for the selected project and location. Corresponds to the JSON property `name` @return [String]

pipeline_sources[RW]

Immutable. The sources of the pipeline (for example, Dataplex). The keys and values are set by the corresponding sources during pipeline creation. Corresponds to the JSON property ‘pipelineSources` @return [Hash<String,String>]

schedule_info[RW]

Details of the schedule the pipeline runs on. Corresponds to the JSON property ‘scheduleInfo` @return [Google::Apis::DatapipelinesV1::GoogleCloudDatapipelinesV1ScheduleSpec]

scheduler_service_account_email[RW]

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. Corresponds to the JSON property ‘schedulerServiceAccountEmail` @return [String]

state[RW]

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. Corresponds to the JSON property ‘state` @return [String]

type[RW]

Required. The type of the pipeline. This field affects the scheduling of the pipeline and the type of metrics to show for the pipeline. Corresponds to the JSON property ‘type` @return [String]

workload[RW]

Workload details for creating the pipeline jobs. Corresponds to the JSON property ‘workload` @return [Google::Apis::DatapipelinesV1::GoogleCloudDatapipelinesV1Workload]

Public Class Methods

new(**args) click to toggle source
# File lib/google/apis/datapipelines_v1/classes.rb, line 583
def initialize(**args)
   update!(**args)
end

Public Instance Methods

update!(**args) click to toggle source

Update properties of this object

# File lib/google/apis/datapipelines_v1/classes.rb, line 588
def update!(**args)
  @create_time = args[:create_time] if args.key?(:create_time)
  @display_name = args[:display_name] if args.key?(:display_name)
  @job_count = args[:job_count] if args.key?(:job_count)
  @last_update_time = args[:last_update_time] if args.key?(:last_update_time)
  @name = args[:name] if args.key?(:name)
  @pipeline_sources = args[:pipeline_sources] if args.key?(:pipeline_sources)
  @schedule_info = args[:schedule_info] if args.key?(:schedule_info)
  @scheduler_service_account_email = args[:scheduler_service_account_email] if args.key?(:scheduler_service_account_email)
  @state = args[:state] if args.key?(:state)
  @type = args[:type] if args.key?(:type)
  @workload = args[:workload] if args.key?(:workload)
end