Class: OCI::Opensearch::Models::CreateOpensearchClusterPipelineDetails

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

Overview

The configuration details for a new OpenSearch cluster pipeline.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateOpensearchClusterPipelineDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
241
242
243
244
245
246
247
248
249
250
251
252
 
# File 'lib/oci/opensearch/models/create_opensearch_cluster_pipeline_details.rb', line 151

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

#compartment_id ⇒ String

[Required] The OCID of the compartment to create the pipeline in.

Returns:

  • (String) 


43
44
45
 
# File 'lib/oci/opensearch/models/create_opensearch_cluster_pipeline_details.rb', line 43

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) 


39
40
41
 
# File 'lib/oci/opensearch/models/create_opensearch_cluster_pipeline_details.rb', line 39

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


79
80
81
 
# File 'lib/oci/opensearch/models/create_opensearch_cluster_pipeline_details.rb', line 79

def defined_tags
  @defined_tags
end

#display_name ⇒ String

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

Returns:

  • (String) 


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

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


73
74
75
 
# File 'lib/oci/opensearch/models/create_opensearch_cluster_pipeline_details.rb', line 73

def freeform_tags
  @freeform_tags
end

#memory_gb ⇒ Integer

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

Returns:

  • (Integer) 


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

def memory_gb
  @memory_gb
end

#node_count ⇒ Integer

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

Returns:

  • (Integer) 


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

def node_count
  @node_count
end

#node_shape ⇒ String

The pipeline node shape.

Returns:

  • (String) 


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

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) 


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

def nsg_id
  @nsg_id
end

#ocpu_count ⇒ Integer

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

Returns:

  • (Integer) 


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

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) 


34
35
36
 
# File 'lib/oci/opensearch/models/create_opensearch_cluster_pipeline_details.rb', line 34

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:



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

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) 


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

def subnet_compartment_id
  @subnet_compartment_id
end

#subnet_id ⇒ String

The OCID of the pipeline's subnet.

Returns:

  • (String) 


51
52
53
 
# File 'lib/oci/opensearch/models/create_opensearch_cluster_pipeline_details.rb', line 51

def subnet_id
  @subnet_id
end

#vcn_compartment_id ⇒ String

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

Returns:

  • (String) 


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

def vcn_compartment_id
  @vcn_compartment_id
end

#vcn_id ⇒ String

The OCID of the pipeline's VCN.

Returns:

  • (String) 


47
48
49
 
# File 'lib/oci/opensearch/models/create_opensearch_cluster_pipeline_details.rb', line 47

def vcn_id
  @vcn_id
end

Class Method Details

.attribute_map ⇒ Object

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



82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/oci/opensearch/models/create_opensearch_cluster_pipeline_details.rb', line 82

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',
    'compartment_id': :'compartmentId',
    '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.



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'lib/oci/opensearch/models/create_opensearch_cluster_pipeline_details.rb', line 106

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',
    'compartment_id': :'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



261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
 
# File 'lib/oci/opensearch/models/create_opensearch_cluster_pipeline_details.rb', line 261

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 &&
    compartment_id == other.compartment_id &&
    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



306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
 
# File 'lib/oci/opensearch/models/create_opensearch_cluster_pipeline_details.rb', line 306

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


286
287
288
 
# File 'lib/oci/opensearch/models/create_opensearch_cluster_pipeline_details.rb', line 286

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



295
296
297
 
# File 'lib/oci/opensearch/models/create_opensearch_cluster_pipeline_details.rb', line 295

def hash
  [display_name, ocpu_count, memory_gb, node_count, node_shape, pipeline_configuration_body, data_prepper_configuration_body, compartment_id, 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



339
340
341
342
343
344
345
346
347
348
 
# File 'lib/oci/opensearch/models/create_opensearch_cluster_pipeline_details.rb', line 339

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



333
334
335
 
# File 'lib/oci/opensearch/models/create_opensearch_cluster_pipeline_details.rb', line 333

def to_s
  to_hash.to_s
end