Class: OCI::GoldenGate::Models::CreatePipelineDetails

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/golden_gate/models/create_pipeline_details.rb

Overview

Details with which to create a pipeline.

This class has direct subclasses. If you are using this class as input to a service operations then you should favor using a subclass over the base class

Direct Known Subclasses

CreateZeroEtlPipelineDetails

Constant Summary collapse

RECIPE_TYPE_ENUM = 
[
  RECIPE_TYPE_ZERO_ETL = 'ZERO_ETL'.freeze
].freeze
LICENSE_MODEL_ENUM = 
[
  LICENSE_MODEL_LICENSE_INCLUDED = 'LICENSE_INCLUDED'.freeze,
  LICENSE_MODEL_BRING_YOUR_OWN_LICENSE = 'BRING_YOUR_OWN_LICENSE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreatePipelineDetails

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash

Options Hash (attributes):



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
187
188
189
190
191
192
193
194
195
196
197
198
 
# File 'lib/oci/golden_gate/models/create_pipeline_details.rb', line 141

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.recipe_type = attributes[:'recipeType'] if attributes[:'recipeType']

  raise 'You cannot provide both :recipeType and :recipe_type' if attributes.key?(:'recipeType') && attributes.key?(:'recipe_type')

  self.recipe_type = attributes[:'recipe_type'] if attributes[:'recipe_type']

  self.display_name = attributes[:'displayName'] if attributes[:'displayName']

  raise 'You cannot provide both :displayName and :display_name' if attributes.key?(:'displayName') && attributes.key?(:'display_name')

  self.display_name = attributes[:'display_name'] if attributes[:'display_name']

  self.description = attributes[:'description'] if attributes[:'description']

  self.compartment_id = attributes[:'compartmentId'] if attributes[:'compartmentId']

  raise 'You cannot provide both :compartmentId and :compartment_id' if attributes.key?(:'compartmentId') && attributes.key?(:'compartment_id')

  self.compartment_id = attributes[:'compartment_id'] if attributes[:'compartment_id']

  self.license_model = attributes[:'licenseModel'] if attributes[:'licenseModel']

  raise 'You cannot provide both :licenseModel and :license_model' if attributes.key?(:'licenseModel') && attributes.key?(:'license_model')

  self.license_model = attributes[:'license_model'] if attributes[:'license_model']

  self.freeform_tags = attributes[:'freeformTags'] if attributes[:'freeformTags']

  raise 'You cannot provide both :freeformTags and :freeform_tags' if attributes.key?(:'freeformTags') && attributes.key?(:'freeform_tags')

  self.freeform_tags = attributes[:'freeform_tags'] if attributes[:'freeform_tags']

  self.defined_tags = attributes[:'definedTags'] if attributes[:'definedTags']

  raise 'You cannot provide both :definedTags and :defined_tags' if attributes.key?(:'definedTags') && attributes.key?(:'defined_tags')

  self.defined_tags = attributes[:'defined_tags'] if attributes[:'defined_tags']

  self.locks = attributes[:'locks'] if attributes[:'locks']

  self.source_connection_details = attributes[:'sourceConnectionDetails'] if attributes[:'sourceConnectionDetails']

  raise 'You cannot provide both :sourceConnectionDetails and :source_connection_details' if attributes.key?(:'sourceConnectionDetails') && attributes.key?(:'source_connection_details')

  self.source_connection_details = attributes[:'source_connection_details'] if attributes[:'source_connection_details']

  self.target_connection_details = attributes[:'targetConnectionDetails'] if attributes[:'targetConnectionDetails']

  raise 'You cannot provide both :targetConnectionDetails and :target_connection_details' if attributes.key?(:'targetConnectionDetails') && attributes.key?(:'target_connection_details')

  self.target_connection_details = attributes[:'target_connection_details'] if attributes[:'target_connection_details']
end

Instance Attribute Details

#compartment_id ⇒ String

[Required] The OCID of the compartment being referenced.

Returns:

  • (String) 


40
41
42
 
# File 'lib/oci/golden_gate/models/create_pipeline_details.rb', line 40

def compartment_id
  @compartment_id
end

#defined_tags ⇒ Hash<String, Hash<String, Object>>

Tags defined for this resource. Each key is predefined and scoped to a namespace.

Example: {\"foo-namespace\": {\"bar-key\": \"value\"}}

Returns:

  • (Hash<String, Hash<String, Object>>) 


60
61
62
 
# File 'lib/oci/golden_gate/models/create_pipeline_details.rb', line 60

def defined_tags
  @defined_tags
end

#description ⇒ String

Metadata about this specific object.

Returns:

  • (String) 


35
36
37
 
# File 'lib/oci/golden_gate/models/create_pipeline_details.rb', line 35

def description
  @description
end

#display_name ⇒ String

[Required] An object's Display Name.

Returns:

  • (String) 


30
31
32
 
# File 'lib/oci/golden_gate/models/create_pipeline_details.rb', line 30

def display_name
  @display_name
end

#freeform_tags ⇒ Hash<String, String>

A simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only.

Example: {\"bar-key\": \"value\"}

Returns:

  • (Hash<String, String>) 


53
54
55
 
# File 'lib/oci/golden_gate/models/create_pipeline_details.rb', line 53

def freeform_tags
  @freeform_tags
end

#license_model ⇒ String

[Required] The Oracle license model that applies to a Deployment.

Returns:

  • (String) 


45
46
47
 
# File 'lib/oci/golden_gate/models/create_pipeline_details.rb', line 45

def license_model
  @license_model
end

#locks ⇒ Array<OCI::GoldenGate::Models::ResourceLock>

Locks associated with this resource.

Returns:



64
65
66
 
# File 'lib/oci/golden_gate/models/create_pipeline_details.rb', line 64

def locks
  @locks
end

#recipe_type ⇒ String

[Required] The type of the recipe

Returns:

  • (String) 


25
26
27
 
# File 'lib/oci/golden_gate/models/create_pipeline_details.rb', line 25

def recipe_type
  @recipe_type
end

#source_connection_details ⇒ OCI::GoldenGate::Models::SourcePipelineConnectionDetails

This attribute is required.

Returns:



68
69
70
 
# File 'lib/oci/golden_gate/models/create_pipeline_details.rb', line 68

def source_connection_details
  @source_connection_details
end

#target_connection_details ⇒ OCI::GoldenGate::Models::TargetPipelineConnectionDetails

This attribute is required.

Returns:



72
73
74
 
# File 'lib/oci/golden_gate/models/create_pipeline_details.rb', line 72

def target_connection_details
  @target_connection_details
end

Class Method Details

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/oci/golden_gate/models/create_pipeline_details.rb', line 75

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'recipe_type': :'recipeType',
    'display_name': :'displayName',
    'description': :'description',
    'compartment_id': :'compartmentId',
    'license_model': :'licenseModel',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'locks': :'locks',
    'source_connection_details': :'sourceConnectionDetails',
    'target_connection_details': :'targetConnectionDetails'
    # rubocop:enable Style/SymbolLiteral
  }
end

.get_subtype(object_hash) ⇒ Object

Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.



115
116
117
118
119
120
121
122
 
# File 'lib/oci/golden_gate/models/create_pipeline_details.rb', line 115

def self.get_subtype(object_hash)
  type = object_hash[:'recipeType'] # rubocop:disable Style/SymbolLiteral

  return 'OCI::GoldenGate::Models::CreateZeroEtlPipelineDetails' if type == 'ZERO_ETL'

  # TODO: Log a warning when the subtype is not found.
  'OCI::GoldenGate::Models::CreatePipelineDetails'
end

.swagger_types ⇒ Object

Attribute type mapping.



93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/oci/golden_gate/models/create_pipeline_details.rb', line 93

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'recipe_type': :'String',
    'display_name': :'String',
    'description': :'String',
    'compartment_id': :'String',
    'license_model': :'String',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'locks': :'Array<OCI::GoldenGate::Models::ResourceLock>',
    'source_connection_details': :'OCI::GoldenGate::Models::SourcePipelineConnectionDetails',
    'target_connection_details': :'OCI::GoldenGate::Models::TargetPipelineConnectionDetails'
    # rubocop:enable Style/SymbolLiteral
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other (Object) —

    the other object to be compared



223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
 
# File 'lib/oci/golden_gate/models/create_pipeline_details.rb', line 223

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    recipe_type == other.recipe_type &&
    display_name == other.display_name &&
    description == other.description &&
    compartment_id == other.compartment_id &&
    license_model == other.license_model &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    locks == other.locks &&
    source_connection_details == other.source_connection_details &&
    target_connection_details == other.target_connection_details
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
 
# File 'lib/oci/golden_gate/models/create_pipeline_details.rb', line 262

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

Parameters:

  • other (Object) —

    the other object to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


242
243
244
 
# File 'lib/oci/golden_gate/models/create_pipeline_details.rb', line 242

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



251
252
253
 
# File 'lib/oci/golden_gate/models/create_pipeline_details.rb', line 251

def hash
  [recipe_type, display_name, description, compartment_id, license_model, freeform_tags, defined_tags, locks, source_connection_details, target_connection_details].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



295
296
297
298
299
300
301
302
303
304
 
# File 'lib/oci/golden_gate/models/create_pipeline_details.rb', line 295

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

Returns:

  • (String) —

    String presentation of the object



289
290
291
 
# File 'lib/oci/golden_gate/models/create_pipeline_details.rb', line 289

def to_s
  to_hash.to_s
end