Class: OCI::Opensearch::Models::OpensearchClusterPipelineSummary

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/opensearch/models/opensearch_cluster_pipeline_summary.rb

Overview

The summary of information about an OpenSearch cluster Pipeline.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ OpensearchClusterPipelineSummary

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :id (String) —

    The value to assign to the #id property

  • :display_name (String) —

    The value to assign to the #display_name property

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :vcn_id (String) —

    The value to assign to the #vcn_id property

  • :subnet_id (String) —

    The value to assign to the #subnet_id property

  • :ocpu_count (Integer) —

    The value to assign to the #ocpu_count property

  • :memory_gb (Integer) —

    The value to assign to the #memory_gb property

  • :node_count (Integer) —

    The value to assign to the #node_count property

  • :node_shape (String) —

    The value to assign to the #node_shape property

  • :pipeline_configuration_body (String) —

    The value to assign to the #pipeline_configuration_body property

  • :data_prepper_configuration_body (String) —

    The value to assign to the #data_prepper_configuration_body property

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state property

  • :pipeline_mode (String) —

    The value to assign to the #pipeline_mode property

  • :time_created (DateTime) —

    The value to assign to the #time_created property

  • :time_updated (DateTime) —

    The value to assign to the #time_updated 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



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
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
 
# File 'lib/oci/opensearch/models/opensearch_cluster_pipeline_summary.rb', line 167

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

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

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

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

  self.subnet_id = attributes[:'subnetId'] if attributes[:'subnetId']

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

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

  self.ocpu_count = attributes[:'ocpuCount'] if attributes[:'ocpuCount']

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

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

  self.memory_gb = attributes[:'memoryGB'] if attributes[:'memoryGB']

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

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

  self.node_count = attributes[:'nodeCount'] if attributes[:'nodeCount']

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

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

  self.node_shape = attributes[:'nodeShape'] if attributes[:'nodeShape']

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

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

  self.pipeline_configuration_body = attributes[:'pipelineConfigurationBody'] if attributes[:'pipelineConfigurationBody']

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

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

  self.data_prepper_configuration_body = attributes[:'dataPrepperConfigurationBody'] if attributes[:'dataPrepperConfigurationBody']

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

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

  self.lifecycle_state = attributes[:'lifecycleState'] if attributes[:'lifecycleState']

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

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

  self.pipeline_mode = attributes[:'pipelineMode'] if attributes[:'pipelineMode']

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

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

  self.time_created = attributes[:'timeCreated'] if attributes[:'timeCreated']

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

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

  self.time_updated = attributes[:'timeUpdated'] if attributes[:'timeUpdated']

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

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

  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 where the cluster pipeline is located.

Returns:

  • (String) 


21
22
23
 
# File 'lib/oci/opensearch/models/opensearch_cluster_pipeline_summary.rb', line 21

def compartment_id
  @compartment_id
end

#data_prepper_configuration_body ⇒ String

[Required] The data prepper config in YAML format. The command accepts the data prepper config as a string or within a .yaml file. If you provide the configuration as a string, each new line must be escaped with .

Returns:

  • (String) 


55
56
57
 
# File 'lib/oci/opensearch/models/opensearch_cluster_pipeline_summary.rb', line 55

def data_prepper_configuration_body
  @data_prepper_configuration_body
end

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

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {\"foo-namespace\": {\"bar-key\": \"value\"}}

Returns:

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


83
84
85
 
# File 'lib/oci/opensearch/models/opensearch_cluster_pipeline_summary.rb', line 83

def defined_tags
  @defined_tags
end

#display_name ⇒ String

[Required] The name of the cluster pipeline. Avoid entering confidential information.

Returns:

  • (String) 


17
18
19
 
# File 'lib/oci/opensearch/models/opensearch_cluster_pipeline_summary.rb', line 17

def display_name
  @display_name
end

#freeform_tags ⇒ Hash<String, String>

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


77
78
79
 
# File 'lib/oci/opensearch/models/opensearch_cluster_pipeline_summary.rb', line 77

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the cluster pipeline.

Returns:

  • (String) 


13
14
15
 
# File 'lib/oci/opensearch/models/opensearch_cluster_pipeline_summary.rb', line 13

def id
  @id
end

#lifecycle_state ⇒ String

[Required] The current state of the cluster pipeline.

Returns:

  • (String) 


59
60
61
 
# File 'lib/oci/opensearch/models/opensearch_cluster_pipeline_summary.rb', line 59

def lifecycle_state
  @lifecycle_state
end

#memory_gb ⇒ Integer

[Required] The amount of memory in GB, for each pipeline node.

Returns:

  • (Integer) 


37
38
39
 
# File 'lib/oci/opensearch/models/opensearch_cluster_pipeline_summary.rb', line 37

def memory_gb
  @memory_gb
end

#node_count ⇒ Integer

[Required] The number of nodes configured for the pipeline.

Returns:

  • (Integer) 


41
42
43
 
# File 'lib/oci/opensearch/models/opensearch_cluster_pipeline_summary.rb', line 41

def node_count
  @node_count
end

#node_shape ⇒ String

The pipeline node shape.

Returns:

  • (String) 


45
46
47
 
# File 'lib/oci/opensearch/models/opensearch_cluster_pipeline_summary.rb', line 45

def node_shape
  @node_shape
end

#ocpu_count ⇒ Integer

[Required] The number of OCPUs configured for each pipeline node.

Returns:

  • (Integer) 


33
34
35
 
# File 'lib/oci/opensearch/models/opensearch_cluster_pipeline_summary.rb', line 33

def ocpu_count
  @ocpu_count
end

#pipeline_configuration_body ⇒ String

[Required] The pipeline configuration in YAML format. The command accepts the pipeline configuration as a string or within a .yaml file. If you provide the configuration as a string, each new line must be escaped with .

Returns:

  • (String) 


50
51
52
 
# File 'lib/oci/opensearch/models/opensearch_cluster_pipeline_summary.rb', line 50

def pipeline_configuration_body
  @pipeline_configuration_body
end

#pipeline_mode ⇒ String

[Required] The current state of the pipeline.

Returns:

  • (String) 


63
64
65
 
# File 'lib/oci/opensearch/models/opensearch_cluster_pipeline_summary.rb', line 63

def pipeline_mode
  @pipeline_mode
end

#subnet_id ⇒ String

The OCID of the pipeline's subnet.

Returns:

  • (String) 


29
30
31
 
# File 'lib/oci/opensearch/models/opensearch_cluster_pipeline_summary.rb', line 29

def subnet_id
  @subnet_id
end

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

Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}

Returns:

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


89
90
91
 
# File 'lib/oci/opensearch/models/opensearch_cluster_pipeline_summary.rb', line 89

def system_tags
  @system_tags
end

#time_created ⇒ DateTime

The date and time the cluster pipeline was created. Format defined by RFC3339.

Returns:

  • (DateTime) 


67
68
69
 
# File 'lib/oci/opensearch/models/opensearch_cluster_pipeline_summary.rb', line 67

def time_created
  @time_created
end

#time_updated ⇒ DateTime

The date and time the cluster pipeline was updated. Format defined by RFC3339.

Returns:

  • (DateTime) 


71
72
73
 
# File 'lib/oci/opensearch/models/opensearch_cluster_pipeline_summary.rb', line 71

def time_updated
  @time_updated
end

#vcn_id ⇒ String

The OCID of the pipeline's VCN.

Returns:

  • (String) 


25
26
27
 
# File 'lib/oci/opensearch/models/opensearch_cluster_pipeline_summary.rb', line 25

def vcn_id
  @vcn_id
end

Class Method Details

.attribute_map ⇒ Object

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



92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
 
# File 'lib/oci/opensearch/models/opensearch_cluster_pipeline_summary.rb', line 92

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'display_name': :'displayName',
    'compartment_id': :'compartmentId',
    'vcn_id': :'vcnId',
    'subnet_id': :'subnetId',
    'ocpu_count': :'ocpuCount',
    'memory_gb': :'memoryGB',
    'node_count': :'nodeCount',
    'node_shape': :'nodeShape',
    'pipeline_configuration_body': :'pipelineConfigurationBody',
    'data_prepper_configuration_body': :'dataPrepperConfigurationBody',
    'lifecycle_state': :'lifecycleState',
    'pipeline_mode': :'pipelineMode',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
 
# File 'lib/oci/opensearch/models/opensearch_cluster_pipeline_summary.rb', line 118

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'display_name': :'String',
    'compartment_id': :'String',
    'vcn_id': :'String',
    'subnet_id': :'String',
    'ocpu_count': :'Integer',
    'memory_gb': :'Integer',
    'node_count': :'Integer',
    'node_shape': :'String',
    'pipeline_configuration_body': :'String',
    'data_prepper_configuration_body': :'String',
    'lifecycle_state': :'String',
    'pipeline_mode': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    '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



285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
 
# File 'lib/oci/opensearch/models/opensearch_cluster_pipeline_summary.rb', line 285

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

  self.class == other.class &&
    id == other.id &&
    display_name == other.display_name &&
    compartment_id == other.compartment_id &&
    vcn_id == other.vcn_id &&
    subnet_id == other.subnet_id &&
    ocpu_count == other.ocpu_count &&
    memory_gb == other.memory_gb &&
    node_count == other.node_count &&
    node_shape == other.node_shape &&
    pipeline_configuration_body == other.pipeline_configuration_body &&
    data_prepper_configuration_body == other.data_prepper_configuration_body &&
    lifecycle_state == other.lifecycle_state &&
    pipeline_mode == other.pipeline_mode &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    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



332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
 
# File 'lib/oci/opensearch/models/opensearch_cluster_pipeline_summary.rb', line 332

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


312
313
314
 
# File 'lib/oci/opensearch/models/opensearch_cluster_pipeline_summary.rb', line 312

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



321
322
323
 
# File 'lib/oci/opensearch/models/opensearch_cluster_pipeline_summary.rb', line 321

def hash
  [id, display_name, compartment_id, vcn_id, subnet_id, ocpu_count, memory_gb, node_count, node_shape, pipeline_configuration_body, data_prepper_configuration_body, lifecycle_state, pipeline_mode, time_created, time_updated, 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



365
366
367
368
369
370
371
372
373
374
 
# File 'lib/oci/opensearch/models/opensearch_cluster_pipeline_summary.rb', line 365

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



359
360
361
 
# File 'lib/oci/opensearch/models/opensearch_cluster_pipeline_summary.rb', line 359

def to_s
  to_hash.to_s
end