Class: Google::Apis::DatapipelinesV1::GoogleCloudDatapipelinesV1Pipeline

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/datapipelines_v1/classes.rb,
lib/google/apis/datapipelines_v1/representations.rb,
lib/google/apis/datapipelines_v1/representations.rb

Overview

The main pipeline entity and all the needed metadata to launch and manage linked jobs.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDatapipelinesV1Pipeline

Returns a new instance of GoogleCloudDatapipelinesV1Pipeline.



556
557
558
 
# File 'lib/google/apis/datapipelines_v1/classes.rb', line 556

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#create_time ⇒ String

Output only. Immutable. The timestamp when the pipeline was initially created. Set by the Data Pipelines service. Corresponds to the JSON property createTime

Returns:

  • (String) 


486
487
488
 
# File 'lib/google/apis/datapipelines_v1/classes.rb', line 486

def create_time
  @create_time
end

#display_name ⇒ String

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

Returns:

  • (String) 


492
493
494
 
# File 'lib/google/apis/datapipelines_v1/classes.rb', line 492

def display_name
  @display_name
end

#job_count ⇒ Fixnum

Output only. Number of jobs. Corresponds to the JSON property jobCount

Returns:

  • (Fixnum) 


497
498
499
 
# File 'lib/google/apis/datapipelines_v1/classes.rb', line 497

def job_count
  @job_count
end

#last_update_time ⇒ String

Output only. Immutable. The timestamp when the pipeline was last modified. Set by the Data Pipelines service. Corresponds to the JSON property lastUpdateTime

Returns:

  • (String) 


503
504
505
 
# File 'lib/google/apis/datapipelines_v1/classes.rb', line 503

def last_update_time
  @last_update_time
end

#name ⇒ String

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 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. Corresponds to the JSON property name

Returns:

  • (String) 


518
519
520
 
# File 'lib/google/apis/datapipelines_v1/classes.rb', line 518

def name
  @name
end

#pipeline_sources ⇒ Hash<String,String>

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

Returns:

  • (Hash<String,String>) 


524
525
526
 
# File 'lib/google/apis/datapipelines_v1/classes.rb', line 524

def pipeline_sources
  @pipeline_sources
end

#schedule_info ⇒ Google::Apis::DatapipelinesV1::GoogleCloudDatapipelinesV1ScheduleSpec

Details of the schedule the pipeline runs on. Corresponds to the JSON property scheduleInfo

Returns:



529
530
531
 
# File 'lib/google/apis/datapipelines_v1/classes.rb', line 529

def schedule_info
  @schedule_info
end

#scheduler_service_account_email ⇒ String

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

Returns:

  • (String) 


535
536
537
 
# File 'lib/google/apis/datapipelines_v1/classes.rb', line 535

def 
  @scheduler_service_account_email
end

#state ⇒ String

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

Returns:

  • (String) 


543
544
545
 
# File 'lib/google/apis/datapipelines_v1/classes.rb', line 543

def state
  @state
end

#type ⇒ String

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

Returns:

  • (String) 


549
550
551
 
# File 'lib/google/apis/datapipelines_v1/classes.rb', line 549

def type
  @type
end

#workload ⇒ Google::Apis::DatapipelinesV1::GoogleCloudDatapipelinesV1Workload

Workload details for creating the pipeline jobs. Corresponds to the JSON property workload

Returns:



554
555
556
 
# File 'lib/google/apis/datapipelines_v1/classes.rb', line 554

def workload
  @workload
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



561
562
563
564
565
566
567
568
569
570
571
572
573
 
# File 'lib/google/apis/datapipelines_v1/classes.rb', line 561

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