Class: OCI::GenerativeAi::Models::GenerativeAiPrivateEndpoint

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/generative_ai/models/generative_ai_private_endpoint.rb

Overview

Generative AI private endpoint.

Constant Summary collapse

LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_CREATING = 'CREATING'.freeze,
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_UPDATING = 'UPDATING'.freeze,
  LIFECYCLE_STATE_DELETING = 'DELETING'.freeze,
  LIFECYCLE_STATE_DELETED = 'DELETED'.freeze,
  LIFECYCLE_STATE_FAILED = 'FAILED'.freeze,
  LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
RESOURCE_TYPE_ENUM = 
[
  RESOURCE_TYPE_APPLICATION = 'APPLICATION'.freeze,
  RESOURCE_TYPE_ENDPOINT = 'ENDPOINT'.freeze,
  RESOURCE_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ GenerativeAiPrivateEndpoint

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

  • :description (String) —

    The value to assign to the #description property

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :subnet_id (String) —

    The value to assign to the #subnet_id property

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state property

  • :lifecycle_details (String) —

    The value to assign to the #lifecycle_details property

  • :nsg_ids (Array<String>) —

    The value to assign to the #nsg_ids property

  • :fqdn (String) —

    The value to assign to the #fqdn property

  • :is_allow_on_demand (BOOLEAN) —

    The value to assign to the #is_allow_on_demand property

  • :private_endpoint_ip (String) —

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

  • :previous_state (OCI::GenerativeAi::Models::GenerativeAiPrivateEndpoint) —

    The value to assign to the #previous_state property

  • :resource_type (String) —

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

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

    The value to assign to the #security_attributes property



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
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
 
# File 'lib/oci/generative_ai/models/generative_ai_private_endpoint.rb', line 211

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

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

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

  self.nsg_ids = attributes[:'nsgIds'] if attributes[:'nsgIds']

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

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

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

  self.is_allow_on_demand = attributes[:'isAllowOnDemand'] unless attributes[:'isAllowOnDemand'].nil?
  self.is_allow_on_demand = false if is_allow_on_demand.nil? && !attributes.key?(:'isAllowOnDemand') # rubocop:disable Style/StringLiterals

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

  self.is_allow_on_demand = attributes[:'is_allow_on_demand'] unless attributes[:'is_allow_on_demand'].nil?
  self.is_allow_on_demand = false if is_allow_on_demand.nil? && !attributes.key?(:'isAllowOnDemand') && !attributes.key?(:'is_allow_on_demand') # rubocop:disable Style/StringLiterals

  self.private_endpoint_ip = attributes[:'privateEndpointIp'] if attributes[:'privateEndpointIp']

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

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

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

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

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

  self.resource_type = attributes[:'resourceType'] if attributes[:'resourceType']

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

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

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

  self.security_attributes = attributes[:'securityAttributes'] if attributes[:'securityAttributes']

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

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

Instance Attribute Details

#compartment_id ⇒ String

[Required] The OCID of the compartment that contains the private endpoint.

Returns:

  • (String) 


47
48
49
 
# File 'lib/oci/generative_ai/models/generative_ai_private_endpoint.rb', line 47

def compartment_id
  @compartment_id
end

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

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

Example: {\"Operations\": {\"CostCenter\": \"42\"}}

Returns:

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


116
117
118
 
# File 'lib/oci/generative_ai/models/generative_ai_private_endpoint.rb', line 116

def defined_tags
  @defined_tags
end

#description ⇒ String

A description of this private endpoint.

Returns:

  • (String) 


42
43
44
 
# File 'lib/oci/generative_ai/models/generative_ai_private_endpoint.rb', line 42

def description
  @description
end

#display_name ⇒ String

A user friendly name. It doesn't have to be unique. Avoid entering confidential information.

Returns:

  • (String) 


37
38
39
 
# File 'lib/oci/generative_ai/models/generative_ai_private_endpoint.rb', line 37

def display_name
  @display_name
end

#fqdn ⇒ String

[Required] Fully qualified domain name the customer will use for access (for eg: xyz.oraclecloud.com)

Returns:

  • (String) 


72
73
74
 
# File 'lib/oci/generative_ai/models/generative_ai_private_endpoint.rb', line 72

def fqdn
  @fqdn
end

#freeform_tags ⇒ Hash<String, String>

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.

Example: {\"Department\": \"Finance\"}

Returns:

  • (Hash<String, String>) 


108
109
110
 
# File 'lib/oci/generative_ai/models/generative_ai_private_endpoint.rb', line 108

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of a private endpoint.

Returns:

  • (String) 


32
33
34
 
# File 'lib/oci/generative_ai/models/generative_ai_private_endpoint.rb', line 32

def id
  @id
end

#is_allow_on_demand ⇒ BOOLEAN

Flag that allows access to on-demand models using this private endpoint.

Returns:

  • (BOOLEAN) 


77
78
79
 
# File 'lib/oci/generative_ai/models/generative_ai_private_endpoint.rb', line 77

def is_allow_on_demand
  @is_allow_on_demand
end

#lifecycle_details ⇒ String

The detailed messages about the lifecycle state

Returns:

  • (String) 


62
63
64
 
# File 'lib/oci/generative_ai/models/generative_ai_private_endpoint.rb', line 62

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

[Required] The current state of the Generative AI Private Endpoint.

Returns:

  • (String) 


57
58
59
 
# File 'lib/oci/generative_ai/models/generative_ai_private_endpoint.rb', line 57

def lifecycle_state
  @lifecycle_state
end

#nsg_ids ⇒ Array<String>

A list of the OCIDs of the network security groups that the private endpoint's VNIC belongs to.

Returns:

  • (Array<String>) 


67
68
69
 
# File 'lib/oci/generative_ai/models/generative_ai_private_endpoint.rb', line 67

def nsg_ids
  @nsg_ids
end

#previous_state ⇒ OCI::GenerativeAi::Models::GenerativeAiPrivateEndpoint

Returns:



95
96
97
 
# File 'lib/oci/generative_ai/models/generative_ai_private_endpoint.rb', line 95

def previous_state
  @previous_state
end

#private_endpoint_ip ⇒ String

The private IP address (in the customer's VCN) that represents the access point for the associated endpoint service.

Returns:

  • (String) 


82
83
84
 
# File 'lib/oci/generative_ai/models/generative_ai_private_endpoint.rb', line 82

def private_endpoint_ip
  @private_endpoint_ip
end

#resource_type ⇒ String

The resource type that Generative AI private endpoint can be used for.

Returns:

  • (String) 


100
101
102
 
# File 'lib/oci/generative_ai/models/generative_ai_private_endpoint.rb', line 100

def resource_type
  @resource_type
end

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

Security attributes for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {\"Oracle-ZPR\": {\"MaxEgressCount\": {\"value\": \"42\", \"mode\": \"enforce\"}}}

Returns:

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


130
131
132
 
# File 'lib/oci/generative_ai/models/generative_ai_private_endpoint.rb', line 130

def security_attributes
  @security_attributes
end

#subnet_id ⇒ String

[Required] The OCID of the subnet that the private endpoint belongs to.

Returns:

  • (String) 


52
53
54
 
# File 'lib/oci/generative_ai/models/generative_ai_private_endpoint.rb', line 52

def subnet_id
  @subnet_id
end

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

System tags for this resource. Each key is predefined and scoped to a namespace.

Example: {\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}

Returns:

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


123
124
125
 
# File 'lib/oci/generative_ai/models/generative_ai_private_endpoint.rb', line 123

def system_tags
  @system_tags
end

#time_created ⇒ DateTime

[Required] The date and time that the Generative AI private endpoint was created expressed in RFC 3339 timestamp format. Example: 2018-04-03T21:10:29.600Z

Returns:

  • (DateTime) 


87
88
89
 
# File 'lib/oci/generative_ai/models/generative_ai_private_endpoint.rb', line 87

def time_created
  @time_created
end

#time_updated ⇒ DateTime

[Required] The date and time that the Generative AI private endpoint was updated expressed in RFC 3339 timestamp format. Example: 2018-04-03T21:10:29.600Z

Returns:

  • (DateTime) 


92
93
94
 
# File 'lib/oci/generative_ai/models/generative_ai_private_endpoint.rb', line 92

def time_updated
  @time_updated
end

Class Method Details

.attribute_map ⇒ Object

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



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
 
# File 'lib/oci/generative_ai/models/generative_ai_private_endpoint.rb', line 133

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'display_name': :'displayName',
    'description': :'description',
    'compartment_id': :'compartmentId',
    'subnet_id': :'subnetId',
    'lifecycle_state': :'lifecycleState',
    'lifecycle_details': :'lifecycleDetails',
    'nsg_ids': :'nsgIds',
    'fqdn': :'fqdn',
    'is_allow_on_demand': :'isAllowOnDemand',
    'private_endpoint_ip': :'privateEndpointIp',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'previous_state': :'previousState',
    'resource_type': :'resourceType',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags',
    'security_attributes': :'securityAttributes'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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
 
# File 'lib/oci/generative_ai/models/generative_ai_private_endpoint.rb', line 160

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'display_name': :'String',
    'description': :'String',
    'compartment_id': :'String',
    'subnet_id': :'String',
    'lifecycle_state': :'String',
    'lifecycle_details': :'String',
    'nsg_ids': :'Array<String>',
    'fqdn': :'String',
    'is_allow_on_demand': :'BOOLEAN',
    'private_endpoint_ip': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'previous_state': :'OCI::GenerativeAi::Models::GenerativeAiPrivateEndpoint',
    'resource_type': :'String',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'system_tags': :'Hash<String, Hash<String, Object>>',
    'security_attributes': :'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



355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
 
# File 'lib/oci/generative_ai/models/generative_ai_private_endpoint.rb', line 355

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

  self.class == other.class &&
    id == other.id &&
    display_name == other.display_name &&
    description == other.description &&
    compartment_id == other.compartment_id &&
    subnet_id == other.subnet_id &&
    lifecycle_state == other.lifecycle_state &&
    lifecycle_details == other.lifecycle_details &&
    nsg_ids == other.nsg_ids &&
    fqdn == other.fqdn &&
    is_allow_on_demand == other.is_allow_on_demand &&
    private_endpoint_ip == other.private_endpoint_ip &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    previous_state == other.previous_state &&
    resource_type == other.resource_type &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    system_tags == other.system_tags &&
    security_attributes == other.security_attributes
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



403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
 
# File 'lib/oci/generative_ai/models/generative_ai_private_endpoint.rb', line 403

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


383
384
385
 
# File 'lib/oci/generative_ai/models/generative_ai_private_endpoint.rb', line 383

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



392
393
394
 
# File 'lib/oci/generative_ai/models/generative_ai_private_endpoint.rb', line 392

def hash
  [id, display_name, description, compartment_id, subnet_id, lifecycle_state, lifecycle_details, nsg_ids, fqdn, is_allow_on_demand, private_endpoint_ip, time_created, time_updated, previous_state, resource_type, freeform_tags, defined_tags, system_tags, security_attributes].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



436
437
438
439
440
441
442
443
444
445
 
# File 'lib/oci/generative_ai/models/generative_ai_private_endpoint.rb', line 436

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



430
431
432
 
# File 'lib/oci/generative_ai/models/generative_ai_private_endpoint.rb', line 430

def to_s
  to_hash.to_s
end