Class: AWSCDK::Pipelines::FileSet

Inherits:
Jsii::Object
  • Object
show all
Includes:
IFileSetProducer
Defined in:
pipelines/file_set.rb

Overview

A set of files traveling through the deployment pipeline.

Individual steps in the pipeline produce or consume FileSets.

Direct Known Subclasses

CodePipelineFileSet

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(id, producer = nil) ⇒ FileSet

Returns a new instance of FileSet.

Parameters:

  • id (String) —

    Human-readable descriptor for this file set (does not need to be unique).

  • producer (AWSCDK::Pipelines::Step, nil) (defaults to: nil) 


14
15
16
17
18
 
# File 'pipelines/file_set.rb', line 14

def initialize(id, producer = nil)
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(producer, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5waXBlbGluZXMuU3RlcCJ9")), "producer") unless producer.nil?
  Jsii::Object.instance_method(:initialize).bind(self).call(id, producer)
end

Class Method Details

.jsii_overridable_methods ⇒ Object 



20
21
22
23
24
25
26
27
28
 
# File 'pipelines/file_set.rb', line 20

def self.jsii_overridable_methods
  {
    :id => { kind: :property, name: "id", is_optional: false },
    :producer => { kind: :property, name: "producer", is_optional: false },
    :primary_output => { kind: :property, name: "primaryOutput", is_optional: true },
    :produced_by => { kind: :method, name: "producedBy", is_optional: false },
    :to_string => { kind: :method, name: "toString", is_optional: false },
  }
end

Instance Method Details

#id ⇒ String

Human-readable descriptor for this file set (does not need to be unique).

Returns:

  • (String) 


33
34
35
 
# File 'pipelines/file_set.rb', line 33

def id()
  jsii_get_property("id")
end

#primary_output ⇒ AWSCDK::Pipelines::FileSet?

The primary output of a file set producer.

The primary output of a FileSet is itself.

Returns:

  • (AWSCDK::Pipelines::FileSet, nil) 


49
50
51
 
# File 'pipelines/file_set.rb', line 49

def primary_output()
  jsii_get_property("primaryOutput")
end

#produced_by(producer = nil) ⇒ void

This method returns an undefined value.

Mark the given Step as the producer for this FileSet.

This method can only be called once.

Parameters:



59
60
61
62
 
# File 'pipelines/file_set.rb', line 59

def produced_by(producer = nil)
  Jsii::Type.check_type(producer, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5waXBlbGluZXMuU3RlcCJ9")), "producer") unless producer.nil?
  jsii_call_method("producedBy", [producer])
end

#producer ⇒ AWSCDK::Pipelines::Step

The Step that produces this FileSet.

Returns:



40
41
42
 
# File 'pipelines/file_set.rb', line 40

def producer()
  jsii_get_property("producer")
end

#to_string ⇒ String

Return a string representation of this FileSet.

Returns:

  • (String) 


67
68
69
 
# File 'pipelines/file_set.rb', line 67

def to_string()
  jsii_call_method("toString", [])
end