Class: OCI::GenerativeAi::Models::GenerativeAiPrivateEndpointSummary

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

Overview

List of Generative AI private endpoints.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ GenerativeAiPrivateEndpointSummary

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

  • :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

  • :resource_type (String) —

    The value to assign to the #resource_type property

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

    The value to assign to the #defined_tags property

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

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



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/generative_ai/models/generative_ai_private_endpoint_summary.rb', line 179

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


30
31
32
 
# File 'lib/oci/generative_ai/models/generative_ai_private_endpoint_summary.rb', line 30

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


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

def defined_tags
  @defined_tags
end

#description ⇒ String

A description of this private endpoint.

Returns:

  • (String) 


25
26
27
 
# File 'lib/oci/generative_ai/models/generative_ai_private_endpoint_summary.rb', line 25

def description
  @description
end

#display_name ⇒ String

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

Returns:

  • (String) 


20
21
22
 
# File 'lib/oci/generative_ai/models/generative_ai_private_endpoint_summary.rb', line 20

def display_name
  @display_name
end

#fqdn ⇒ String

[Required] Fully qualified domain name the customer will use for access

Returns:

  • (String) 


49
50
51
 
# File 'lib/oci/generative_ai/models/generative_ai_private_endpoint_summary.rb', line 49

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


90
91
92
 
# File 'lib/oci/generative_ai/models/generative_ai_private_endpoint_summary.rb', line 90

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of a private endpoint.

Returns:

  • (String) 


15
16
17
 
# File 'lib/oci/generative_ai/models/generative_ai_private_endpoint_summary.rb', line 15

def id
  @id
end

#is_allow_on_demand ⇒ BOOLEAN

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

Returns:

  • (BOOLEAN) 


54
55
56
 
# File 'lib/oci/generative_ai/models/generative_ai_private_endpoint_summary.rb', line 54

def is_allow_on_demand
  @is_allow_on_demand
end

#lifecycle_details ⇒ String

Details of the state of a private endpoint.

Returns:

  • (String) 


44
45
46
 
# File 'lib/oci/generative_ai/models/generative_ai_private_endpoint_summary.rb', line 44

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

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

Returns:

  • (String) 


39
40
41
 
# File 'lib/oci/generative_ai/models/generative_ai_private_endpoint_summary.rb', line 39

def lifecycle_state
  @lifecycle_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) 


59
60
61
 
# File 'lib/oci/generative_ai/models/generative_ai_private_endpoint_summary.rb', line 59

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) 


74
75
76
 
# File 'lib/oci/generative_ai/models/generative_ai_private_endpoint_summary.rb', line 74

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


104
105
106
 
# File 'lib/oci/generative_ai/models/generative_ai_private_endpoint_summary.rb', line 104

def security_attributes
  @security_attributes
end

#subnet_id ⇒ String

[Required] The OCID of a subnet.

Returns:

  • (String) 


35
36
37
 
# File 'lib/oci/generative_ai/models/generative_ai_private_endpoint_summary.rb', line 35

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


97
98
99
 
# File 'lib/oci/generative_ai/models/generative_ai_private_endpoint_summary.rb', line 97

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) 


64
65
66
 
# File 'lib/oci/generative_ai/models/generative_ai_private_endpoint_summary.rb', line 64

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) 


69
70
71
 
# File 'lib/oci/generative_ai/models/generative_ai_private_endpoint_summary.rb', line 69

def time_updated
  @time_updated
end

Class Method Details

.attribute_map ⇒ Object

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



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

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',
    'fqdn': :'fqdn',
    'is_allow_on_demand': :'isAllowOnDemand',
    'private_endpoint_ip': :'privateEndpointIp',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'resource_type': :'resourceType',
    'defined_tags': :'definedTags',
    'freeform_tags': :'freeformTags',
    'system_tags': :'systemTags',
    'security_attributes': :'securityAttributes'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
 
# File 'lib/oci/generative_ai/models/generative_ai_private_endpoint_summary.rb', line 132

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',
    'fqdn': :'String',
    'is_allow_on_demand': :'BOOLEAN',
    'private_endpoint_ip': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'resource_type': :'String',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'freeform_tags': :'Hash<String, String>',
    '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



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

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 &&
    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 &&
    resource_type == other.resource_type &&
    defined_tags == other.defined_tags &&
    freeform_tags == other.freeform_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



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

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


311
312
313
 
# File 'lib/oci/generative_ai/models/generative_ai_private_endpoint_summary.rb', line 311

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



320
321
322
 
# File 'lib/oci/generative_ai/models/generative_ai_private_endpoint_summary.rb', line 320

def hash
  [id, display_name, description, compartment_id, subnet_id, lifecycle_state, lifecycle_details, fqdn, is_allow_on_demand, private_endpoint_ip, time_created, time_updated, resource_type, defined_tags, freeform_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



364
365
366
367
368
369
370
371
372
373
 
# File 'lib/oci/generative_ai/models/generative_ai_private_endpoint_summary.rb', line 364

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



358
359
360
 
# File 'lib/oci/generative_ai/models/generative_ai_private_endpoint_summary.rb', line 358

def to_s
  to_hash.to_s
end