Class: OCI::Opensearch::Models::UpdateOpensearchClusterPipelineDetails

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

Overview

The configuration to update on an existing OpenSearch cluster pipeline. You can only edit capacity limits and pipeline configurations. You can't edit its network settings.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ UpdateOpensearchClusterPipelineDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
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
 
# File 'lib/oci/opensearch/models/update_opensearch_cluster_pipeline_details.rb', line 145

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

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

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

  self.subnet_compartment_id = attributes[:'subnetCompartmentId'] if attributes[:'subnetCompartmentId']

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

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

  self.nsg_id = attributes[:'nsgId'] if attributes[:'nsgId']

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

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

  self.reverse_connection_endpoints = attributes[:'reverseConnectionEndpoints'] if attributes[:'reverseConnectionEndpoints']

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

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

  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']
end

Instance Attribute Details

#data_prepper_configuration_body ⇒ String

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) 


40
41
42
 
# File 'lib/oci/opensearch/models/update_opensearch_cluster_pipeline_details.rb', line 40

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


76
77
78
 
# File 'lib/oci/opensearch/models/update_opensearch_cluster_pipeline_details.rb', line 76

def defined_tags
  @defined_tags
end

#display_name ⇒ String

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

Returns:

  • (String) 


14
15
16
 
# File 'lib/oci/opensearch/models/update_opensearch_cluster_pipeline_details.rb', line 14

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


70
71
72
 
# File 'lib/oci/opensearch/models/update_opensearch_cluster_pipeline_details.rb', line 70

def freeform_tags
  @freeform_tags
end

#memory_gb ⇒ Integer

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

Returns:

  • (Integer) 


22
23
24
 
# File 'lib/oci/opensearch/models/update_opensearch_cluster_pipeline_details.rb', line 22

def memory_gb
  @memory_gb
end

#node_count ⇒ Integer

The number of nodes configured for the pipeline.

Returns:

  • (Integer) 


26
27
28
 
# File 'lib/oci/opensearch/models/update_opensearch_cluster_pipeline_details.rb', line 26

def node_count
  @node_count
end

#node_shape ⇒ String

The pipeline node shape.

Returns:

  • (String) 


30
31
32
 
# File 'lib/oci/opensearch/models/update_opensearch_cluster_pipeline_details.rb', line 30

def node_shape
  @node_shape
end

#nsg_id ⇒ String

The OCID of the NSG where the pipeline private endpoint vnic will be attached.

Returns:

  • (String) 


60
61
62
 
# File 'lib/oci/opensearch/models/update_opensearch_cluster_pipeline_details.rb', line 60

def nsg_id
  @nsg_id
end

#ocpu_count ⇒ Integer

The number of OCPUs configured for each pipeline node.

Returns:

  • (Integer) 


18
19
20
 
# File 'lib/oci/opensearch/models/update_opensearch_cluster_pipeline_details.rb', line 18

def ocpu_count
  @ocpu_count
end

#pipeline_configuration_body ⇒ String

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) 


35
36
37
 
# File 'lib/oci/opensearch/models/update_opensearch_cluster_pipeline_details.rb', line 35

def pipeline_configuration_body
  @pipeline_configuration_body
end

#reverse_connection_endpoints ⇒ Array<OCI::Opensearch::Models::OpensearchPipelineReverseConnectionEndpoint>

The customer IP and the corresponding fully qualified domain name that the pipeline will connect to.

Returns:



64
65
66
 
# File 'lib/oci/opensearch/models/update_opensearch_cluster_pipeline_details.rb', line 64

def reverse_connection_endpoints
  @reverse_connection_endpoints
end

#subnet_compartment_id ⇒ String

The OCID for the compartment where the pipeline's subnet is located.

Returns:

  • (String) 


56
57
58
 
# File 'lib/oci/opensearch/models/update_opensearch_cluster_pipeline_details.rb', line 56

def subnet_compartment_id
  @subnet_compartment_id
end

#subnet_id ⇒ String

The OCID of the pipeline's subnet.

Returns:

  • (String) 


48
49
50
 
# File 'lib/oci/opensearch/models/update_opensearch_cluster_pipeline_details.rb', line 48

def subnet_id
  @subnet_id
end

#vcn_compartment_id ⇒ String

The OCID for the compartment where the pipeline's VCN is located.

Returns:

  • (String) 


52
53
54
 
# File 'lib/oci/opensearch/models/update_opensearch_cluster_pipeline_details.rb', line 52

def vcn_compartment_id
  @vcn_compartment_id
end

#vcn_id ⇒ String

The OCID of the pipeline's VCN.

Returns:

  • (String) 


44
45
46
 
# File 'lib/oci/opensearch/models/update_opensearch_cluster_pipeline_details.rb', line 44

def vcn_id
  @vcn_id
end

Class Method Details

.attribute_map ⇒ Object

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



79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/oci/opensearch/models/update_opensearch_cluster_pipeline_details.rb', line 79

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'displayName',
    'ocpu_count': :'ocpuCount',
    'memory_gb': :'memoryGB',
    'node_count': :'nodeCount',
    'node_shape': :'nodeShape',
    'pipeline_configuration_body': :'pipelineConfigurationBody',
    'data_prepper_configuration_body': :'dataPrepperConfigurationBody',
    'vcn_id': :'vcnId',
    'subnet_id': :'subnetId',
    'vcn_compartment_id': :'vcnCompartmentId',
    'subnet_compartment_id': :'subnetCompartmentId',
    'nsg_id': :'nsgId',
    'reverse_connection_endpoints': :'reverseConnectionEndpoints',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
 
# File 'lib/oci/opensearch/models/update_opensearch_cluster_pipeline_details.rb', line 102

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'String',
    'ocpu_count': :'Integer',
    'memory_gb': :'Integer',
    'node_count': :'Integer',
    'node_shape': :'String',
    'pipeline_configuration_body': :'String',
    'data_prepper_configuration_body': :'String',
    'vcn_id': :'String',
    'subnet_id': :'String',
    'vcn_compartment_id': :'String',
    'subnet_compartment_id': :'String',
    'nsg_id': :'String',
    'reverse_connection_endpoints': :'Array<OCI::Opensearch::Models::OpensearchPipelineReverseConnectionEndpoint>',
    'freeform_tags': :'Hash<String, String>',
    'defined_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



249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
 
# File 'lib/oci/opensearch/models/update_opensearch_cluster_pipeline_details.rb', line 249

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

  self.class == other.class &&
    display_name == other.display_name &&
    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 &&
    vcn_id == other.vcn_id &&
    subnet_id == other.subnet_id &&
    vcn_compartment_id == other.vcn_compartment_id &&
    subnet_compartment_id == other.subnet_compartment_id &&
    nsg_id == other.nsg_id &&
    reverse_connection_endpoints == other.reverse_connection_endpoints &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_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



293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
 
# File 'lib/oci/opensearch/models/update_opensearch_cluster_pipeline_details.rb', line 293

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


273
274
275
 
# File 'lib/oci/opensearch/models/update_opensearch_cluster_pipeline_details.rb', line 273

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



282
283
284
 
# File 'lib/oci/opensearch/models/update_opensearch_cluster_pipeline_details.rb', line 282

def hash
  [display_name, ocpu_count, memory_gb, node_count, node_shape, pipeline_configuration_body, data_prepper_configuration_body, vcn_id, subnet_id, vcn_compartment_id, subnet_compartment_id, nsg_id, reverse_connection_endpoints, freeform_tags, defined_tags].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



326
327
328
329
330
331
332
333
334
335
 
# File 'lib/oci/opensearch/models/update_opensearch_cluster_pipeline_details.rb', line 326

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



320
321
322
 
# File 'lib/oci/opensearch/models/update_opensearch_cluster_pipeline_details.rb', line 320

def to_s
  to_hash.to_s
end