Class: OCI::GoldenGate::Models::ClonePipelineDetails

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

Overview

Details for a pipeline clone.

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

DefaultClonePipelineDetails

Constant Summary collapse

TYPE_ENUM = 
[
  TYPE_DEFAULT = 'DEFAULT'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ClonePipelineDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :type (String) —

    The value to assign to the #type property

  • :display_name (String) —

    The value to assign to the #display_name property

  • :source_pipeline_id (String) —

    The value to assign to the #source_pipeline_id property

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :description (String) —

    The value to assign to the #description property

  • :freeform_tags (Hash<String, String>) —

    The value to assign to the #freeform_tags property

  • :defined_tags (Hash<String, Hash<String, Object>>) —

    The value to assign to the #defined_tags property

  • :system_tags (Hash<String, Hash<String, Object>>) —

    The value to assign to the #system_tags property



127
128
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
 
# File 'lib/oci/golden_gate/models/clone_pipeline_details.rb', line 127

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.type = attributes[:'type'] if attributes[:'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.source_pipeline_id = attributes[:'sourcePipelineId'] if attributes[:'sourcePipelineId']

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

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

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

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

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

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

Instance Attribute Details

#compartment_id ⇒ String

[Required] The OCID of the compartment being referenced.

Returns:

  • (String) 


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

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>>) 


55
56
57
 
# File 'lib/oci/golden_gate/models/clone_pipeline_details.rb', line 55

def defined_tags
  @defined_tags
end

#description ⇒ String

Metadata about this specific object.

Returns:

  • (String) 


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

def description
  @description
end

#display_name ⇒ String

[Required] An object's Display Name.

Returns:

  • (String) 


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

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>) 


48
49
50
 
# File 'lib/oci/golden_gate/models/clone_pipeline_details.rb', line 48

def freeform_tags
  @freeform_tags
end

#source_pipeline_id ⇒ String

[Required] The OCID of the pipeline. This option applies when retrieving a pipeline.

Returns:

  • (String) 


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

def source_pipeline_id
  @source_pipeline_id
end

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

The system tags associated with this resource, if any. The system tags are set by Oracle Cloud Infrastructure services. Each key is predefined and scoped to namespaces. For more information, see Resource Tags.

Example: {orcl-cloud: {free-tier-retain: true}}

Returns:

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


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

def system_tags
  @system_tags
end

#type ⇒ String

[Required] Type of a pipeline clone. This option applies when cloning a pipeline.

Returns:

  • (String) 


20
21
22
 
# File 'lib/oci/golden_gate/models/clone_pipeline_details.rb', line 20

def type
  @type
end

Class Method Details

.attribute_map ⇒ Object

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



67
68
69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/oci/golden_gate/models/clone_pipeline_details.rb', line 67

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'type': :'type',
    'display_name': :'displayName',
    'source_pipeline_id': :'sourcePipelineId',
    'compartment_id': :'compartmentId',
    'description': :'description',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags'
    # 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.



103
104
105
106
107
108
109
110
 
# File 'lib/oci/golden_gate/models/clone_pipeline_details.rb', line 103

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

  return 'OCI::GoldenGate::Models::DefaultClonePipelineDetails' if type == 'DEFAULT'

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

.swagger_types ⇒ Object

Attribute type mapping.



83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/oci/golden_gate/models/clone_pipeline_details.rb', line 83

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'type': :'String',
    'display_name': :'String',
    'source_pipeline_id': :'String',
    'compartment_id': :'String',
    'description': :'String',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'system_tags': :'Hash<String, Hash<String, Object>>'
    # 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



189
190
191
192
193
194
195
196
197
198
199
200
201
 
# File 'lib/oci/golden_gate/models/clone_pipeline_details.rb', line 189

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

  self.class == other.class &&
    type == other.type &&
    display_name == other.display_name &&
    source_pipeline_id == other.source_pipeline_id &&
    compartment_id == other.compartment_id &&
    description == other.description &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    system_tags == other.system_tags
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



226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
 
# File 'lib/oci/golden_gate/models/clone_pipeline_details.rb', line 226

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


206
207
208
 
# File 'lib/oci/golden_gate/models/clone_pipeline_details.rb', line 206

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



215
216
217
 
# File 'lib/oci/golden_gate/models/clone_pipeline_details.rb', line 215

def hash
  [type, display_name, source_pipeline_id, compartment_id, description, freeform_tags, defined_tags, system_tags].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



259
260
261
262
263
264
265
266
267
268
 
# File 'lib/oci/golden_gate/models/clone_pipeline_details.rb', line 259

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



253
254
255
 
# File 'lib/oci/golden_gate/models/clone_pipeline_details.rb', line 253

def to_s
  to_hash.to_s
end