Class: OCI::DataIntegration::Models::Pipeline
- Inherits:
-
Object
- Object
- OCI::DataIntegration::Models::Pipeline
- Defined in:
- lib/oci/data_integration/models/pipeline.rb
Overview
A pipeline is a logical grouping of tasks that together perform a higher level operation. For example, a pipeline could contain a set of tasks that load and clean data, then execute a dataflow to analyze the data. The pipeline allows you to manage the activities as a unit instead of individually. Users can also schedule the pipeline instead of the tasks independently.
Instance Attribute Summary collapse
-
#description ⇒ String
Detailed description for the object.
- #flow_config_values ⇒ OCI::DataIntegration::Models::ConfigValues
-
#identifier ⇒ String
Value can only contain upper case letters, underscore, and numbers.
-
#key ⇒ String
Generated key that can be used in API calls to identify pipeline.
- #metadata ⇒ OCI::DataIntegration::Models::ObjectMetadata
-
#model_type ⇒ String
The type of the object.
-
#model_version ⇒ String
This is a version number that is used by the service to upgrade objects if needed through releases of the service.
-
#name ⇒ String
Free form text without any restriction on permitted characters.
-
#nodes ⇒ Array<OCI::DataIntegration::Models::FlowNode>
A list of nodes attached to the pipeline.
-
#object_status ⇒ Integer
The status of an object that can be set to value 1 for shallow references across objects, other values reserved.
-
#object_version ⇒ Integer
This is used by the service for optimistic locking of the object, to prevent multiple users from simultaneously updating the object.
-
#parameters ⇒ Array<OCI::DataIntegration::Models::Parameter>
A list of parameters for the pipeline, this allows certain aspects of the pipeline to be configured when the pipeline is executed.
- #parent_ref ⇒ OCI::DataIntegration::Models::ParentReference
-
#variables ⇒ Array<OCI::DataIntegration::Models::Variable>
The list of variables required in pipeline, variables can be used to store values that can be used as inputs to tasks in the pipeline.
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.swagger_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(other) ⇒ Object
Checks equality by comparing each attribute.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(other) ⇒ Boolean
-
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ Pipeline
constructor
Initializes the object.
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
Constructor Details
#initialize(attributes = {}) ⇒ Pipeline
Initializes the object
129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 |
# File 'lib/oci/data_integration/models/pipeline.rb', line 129 def initialize(attributes = {}) return unless attributes.is_a?(Hash) # convert string to symbol for hash key attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v } self.key = attributes[:'key'] if attributes[:'key'] self.model_version = attributes[:'modelVersion'] if attributes[:'modelVersion'] raise 'You cannot provide both :modelVersion and :model_version' if attributes.key?(:'modelVersion') && attributes.key?(:'model_version') self.model_version = attributes[:'model_version'] if attributes[:'model_version'] self.parent_ref = attributes[:'parentRef'] if attributes[:'parentRef'] raise 'You cannot provide both :parentRef and :parent_ref' if attributes.key?(:'parentRef') && attributes.key?(:'parent_ref') self.parent_ref = attributes[:'parent_ref'] if attributes[:'parent_ref'] self.name = attributes[:'name'] if attributes[:'name'] self.description = attributes[:'description'] if attributes[:'description'] self.model_type = attributes[:'modelType'] if attributes[:'modelType'] raise 'You cannot provide both :modelType and :model_type' if attributes.key?(:'modelType') && attributes.key?(:'model_type') self.model_type = attributes[:'model_type'] if attributes[:'model_type'] self.object_version = attributes[:'objectVersion'] if attributes[:'objectVersion'] raise 'You cannot provide both :objectVersion and :object_version' if attributes.key?(:'objectVersion') && attributes.key?(:'object_version') self.object_version = attributes[:'object_version'] if attributes[:'object_version'] self.object_status = attributes[:'objectStatus'] if attributes[:'objectStatus'] raise 'You cannot provide both :objectStatus and :object_status' if attributes.key?(:'objectStatus') && attributes.key?(:'object_status') self.object_status = attributes[:'object_status'] if attributes[:'object_status'] self.identifier = attributes[:'identifier'] if attributes[:'identifier'] self.nodes = attributes[:'nodes'] if attributes[:'nodes'] self.parameters = attributes[:'parameters'] if attributes[:'parameters'] self.flow_config_values = attributes[:'flowConfigValues'] if attributes[:'flowConfigValues'] raise 'You cannot provide both :flowConfigValues and :flow_config_values' if attributes.key?(:'flowConfigValues') && attributes.key?(:'flow_config_values') self.flow_config_values = attributes[:'flow_config_values'] if attributes[:'flow_config_values'] self.variables = attributes[:'variables'] if attributes[:'variables'] self. = attributes[:'metadata'] if attributes[:'metadata'] end |
Instance Attribute Details
#description ⇒ String
Detailed description for the object.
29 30 31 |
# File 'lib/oci/data_integration/models/pipeline.rb', line 29 def description @description end |
#flow_config_values ⇒ OCI::DataIntegration::Models::ConfigValues
56 57 58 |
# File 'lib/oci/data_integration/models/pipeline.rb', line 56 def flow_config_values @flow_config_values end |
#identifier ⇒ String
Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified.
45 46 47 |
# File 'lib/oci/data_integration/models/pipeline.rb', line 45 def identifier @identifier end |
#key ⇒ String
Generated key that can be used in API calls to identify pipeline. On scenarios where reference to the pipeline is needed, a value can be passed in create.
14 15 16 |
# File 'lib/oci/data_integration/models/pipeline.rb', line 14 def key @key end |
#metadata ⇒ OCI::DataIntegration::Models::ObjectMetadata
63 64 65 |
# File 'lib/oci/data_integration/models/pipeline.rb', line 63 def @metadata end |
#model_type ⇒ String
The type of the object.
33 34 35 |
# File 'lib/oci/data_integration/models/pipeline.rb', line 33 def model_type @model_type end |
#model_version ⇒ String
This is a version number that is used by the service to upgrade objects if needed through releases of the service.
18 19 20 |
# File 'lib/oci/data_integration/models/pipeline.rb', line 18 def model_version @model_version end |
#name ⇒ String
Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters.
25 26 27 |
# File 'lib/oci/data_integration/models/pipeline.rb', line 25 def name @name end |
#nodes ⇒ Array<OCI::DataIntegration::Models::FlowNode>
A list of nodes attached to the pipeline.
49 50 51 |
# File 'lib/oci/data_integration/models/pipeline.rb', line 49 def nodes @nodes end |
#object_status ⇒ Integer
The status of an object that can be set to value 1 for shallow references across objects, other values reserved.
41 42 43 |
# File 'lib/oci/data_integration/models/pipeline.rb', line 41 def object_status @object_status end |
#object_version ⇒ Integer
This is used by the service for optimistic locking of the object, to prevent multiple users from simultaneously updating the object.
37 38 39 |
# File 'lib/oci/data_integration/models/pipeline.rb', line 37 def object_version @object_version end |
#parameters ⇒ Array<OCI::DataIntegration::Models::Parameter>
A list of parameters for the pipeline, this allows certain aspects of the pipeline to be configured when the pipeline is executed.
53 54 55 |
# File 'lib/oci/data_integration/models/pipeline.rb', line 53 def parameters @parameters end |
#parent_ref ⇒ OCI::DataIntegration::Models::ParentReference
21 22 23 |
# File 'lib/oci/data_integration/models/pipeline.rb', line 21 def parent_ref @parent_ref end |
#variables ⇒ Array<OCI::DataIntegration::Models::Variable>
The list of variables required in pipeline, variables can be used to store values that can be used as inputs to tasks in the pipeline.
60 61 62 |
# File 'lib/oci/data_integration/models/pipeline.rb', line 60 def variables @variables end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 |
# File 'lib/oci/data_integration/models/pipeline.rb', line 66 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'key': :'key', 'model_version': :'modelVersion', 'parent_ref': :'parentRef', 'name': :'name', 'description': :'description', 'model_type': :'modelType', 'object_version': :'objectVersion', 'object_status': :'objectStatus', 'identifier': :'identifier', 'nodes': :'nodes', 'parameters': :'parameters', 'flow_config_values': :'flowConfigValues', 'variables': :'variables', 'metadata': :'metadata' # rubocop:enable Style/SymbolLiteral } end |
.swagger_types ⇒ Object
Attribute type mapping.
88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 |
# File 'lib/oci/data_integration/models/pipeline.rb', line 88 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'key': :'String', 'model_version': :'String', 'parent_ref': :'OCI::DataIntegration::Models::ParentReference', 'name': :'String', 'description': :'String', 'model_type': :'String', 'object_version': :'Integer', 'object_status': :'Integer', 'identifier': :'String', 'nodes': :'Array<OCI::DataIntegration::Models::FlowNode>', 'parameters': :'Array<OCI::DataIntegration::Models::Parameter>', 'flow_config_values': :'OCI::DataIntegration::Models::ConfigValues', 'variables': :'Array<OCI::DataIntegration::Models::Variable>', 'metadata': :'OCI::DataIntegration::Models::ObjectMetadata' # rubocop:enable Style/SymbolLiteral } end |
Instance Method Details
#==(other) ⇒ Object
Checks equality by comparing each attribute.
195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 |
# File 'lib/oci/data_integration/models/pipeline.rb', line 195 def ==(other) return true if equal?(other) self.class == other.class && key == other.key && model_version == other.model_version && parent_ref == other.parent_ref && name == other.name && description == other.description && model_type == other.model_type && object_version == other.object_version && object_status == other.object_status && identifier == other.identifier && nodes == other.nodes && parameters == other.parameters && flow_config_values == other.flow_config_values && variables == other.variables && == other. end |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 |
# File 'lib/oci/data_integration/models/pipeline.rb', line 238 def build_from_hash(attributes) return nil unless attributes.is_a?(Hash) self.class.swagger_types.each_pair do |key, type| if type =~ /^Array<(.*)>/i # check to ensure the input is an array given that the the attribute # is documented as an array but the input is not if attributes[self.class.attribute_map[key]].is_a?(Array) public_method("#{key}=").call( attributes[self.class.attribute_map[key]] .map { |v| OCI::Internal::Util.convert_to_type(Regexp.last_match(1), v) } ) end elsif !attributes[self.class.attribute_map[key]].nil? public_method("#{key}=").call( OCI::Internal::Util.convert_to_type(type, attributes[self.class.attribute_map[key]]) ) end # or else data not found in attributes(hash), not an issue as the data can be optional end self end |
#eql?(other) ⇒ Boolean
218 219 220 |
# File 'lib/oci/data_integration/models/pipeline.rb', line 218 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
227 228 229 |
# File 'lib/oci/data_integration/models/pipeline.rb', line 227 def hash [key, model_version, parent_ref, name, description, model_type, object_version, object_status, identifier, nodes, parameters, flow_config_values, variables, ].hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
271 272 273 274 275 276 277 278 279 280 |
# File 'lib/oci/data_integration/models/pipeline.rb', line 271 def to_hash hash = {} self.class.attribute_map.each_pair do |attr, param| value = public_method(attr).call next if value.nil? && !instance_variable_defined?("@#{attr}") hash[param] = _to_hash(value) end hash end |
#to_s ⇒ String
Returns the string representation of the object
265 266 267 |
# File 'lib/oci/data_integration/models/pipeline.rb', line 265 def to_s to_hash.to_s end |