Class: OCI::GenerativeAi::Models::CreateGenerativeAiPrivateEndpointDetails

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

Overview

The details required to create a Generative AI private endpoint.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateGenerativeAiPrivateEndpointDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :subnet_id (String) —

    The value to assign to the #subnet_id property

  • :description (String) —

    The value to assign to the #description property

  • :display_name (String) —

    The value to assign to the #display_name property

  • :dns_prefix (String) —

    The value to assign to the #dns_prefix property

  • :nsg_ids (Array<String>) —

    The value to assign to the #nsg_ids property

  • :is_allow_on_demand (BOOLEAN) —

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

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

    The value to assign to the #security_attributes property



130
131
132
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
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
 
# File 'lib/oci/generative_ai/models/create_generative_ai_private_endpoint_details.rb', line 130

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

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

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

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

  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.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.resource_type = attributes[:'resourceType'] if attributes[:'resourceType']
  self.resource_type = "ENDPOINT" if resource_type.nil? && !attributes.key?(:'resourceType') # rubocop:disable Style/StringLiterals

  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.resource_type = "ENDPOINT" if resource_type.nil? && !attributes.key?(:'resourceType') && !attributes.key?(:'resource_type') # rubocop:disable Style/StringLiterals

  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.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 where the private endpoint is created.

Returns:

  • (String) 


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

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


66
67
68
 
# File 'lib/oci/generative_ai/models/create_generative_ai_private_endpoint_details.rb', line 66

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


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

def display_name
  @display_name
end

#dns_prefix ⇒ String

[Required] dnsPrefix of the private endpoint FQDN.

Returns:

  • (String) 


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

def dns_prefix
  @dns_prefix
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>) 


58
59
60
 
# File 'lib/oci/generative_ai/models/create_generative_ai_private_endpoint_details.rb', line 58

def freeform_tags
  @freeform_tags
end

#is_allow_on_demand ⇒ BOOLEAN

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

Returns:

  • (BOOLEAN) 


45
46
47
 
# File 'lib/oci/generative_ai/models/create_generative_ai_private_endpoint_details.rb', line 45

def is_allow_on_demand
  @is_allow_on_demand
end

#nsg_ids ⇒ Array<String>

A list of the OCIDs of the network security groups (NSGs) to add the private endpoint's VNIC to.

Returns:

  • (Array<String>) 


40
41
42
 
# File 'lib/oci/generative_ai/models/create_generative_ai_private_endpoint_details.rb', line 40

def nsg_ids
  @nsg_ids
end

#resource_type ⇒ String

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

Returns:

  • (String) 


50
51
52
 
# File 'lib/oci/generative_ai/models/create_generative_ai_private_endpoint_details.rb', line 50

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


73
74
75
 
# File 'lib/oci/generative_ai/models/create_generative_ai_private_endpoint_details.rb', line 73

def security_attributes
  @security_attributes
end

#subnet_id ⇒ String

[Required] The OCID of the customer's subnet where the private endpoint VNIC will reside.

Returns:

  • (String) 


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

def subnet_id
  @subnet_id
end

Class Method Details

.attribute_map ⇒ Object

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



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/oci/generative_ai/models/create_generative_ai_private_endpoint_details.rb', line 76

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'compartment_id': :'compartmentId',
    'subnet_id': :'subnetId',
    'description': :'description',
    'display_name': :'displayName',
    'dns_prefix': :'dnsPrefix',
    'nsg_ids': :'nsgIds',
    'is_allow_on_demand': :'isAllowOnDemand',
    'resource_type': :'resourceType',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'security_attributes': :'securityAttributes'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/oci/generative_ai/models/create_generative_ai_private_endpoint_details.rb', line 95

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'compartment_id': :'String',
    'subnet_id': :'String',
    'description': :'String',
    'display_name': :'String',
    'dns_prefix': :'String',
    'nsg_ids': :'Array<String>',
    'is_allow_on_demand': :'BOOLEAN',
    'resource_type': :'String',
    'freeform_tags': :'Hash<String, String>',
    'defined_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



210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
 
# File 'lib/oci/generative_ai/models/create_generative_ai_private_endpoint_details.rb', line 210

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

  self.class == other.class &&
    compartment_id == other.compartment_id &&
    subnet_id == other.subnet_id &&
    description == other.description &&
    display_name == other.display_name &&
    dns_prefix == other.dns_prefix &&
    nsg_ids == other.nsg_ids &&
    is_allow_on_demand == other.is_allow_on_demand &&
    resource_type == other.resource_type &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_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



250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
 
# File 'lib/oci/generative_ai/models/create_generative_ai_private_endpoint_details.rb', line 250

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


230
231
232
 
# File 'lib/oci/generative_ai/models/create_generative_ai_private_endpoint_details.rb', line 230

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



239
240
241
 
# File 'lib/oci/generative_ai/models/create_generative_ai_private_endpoint_details.rb', line 239

def hash
  [compartment_id, subnet_id, description, display_name, dns_prefix, nsg_ids, is_allow_on_demand, resource_type, freeform_tags, defined_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



283
284
285
286
287
288
289
290
291
292
 
# File 'lib/oci/generative_ai/models/create_generative_ai_private_endpoint_details.rb', line 283

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



277
278
279
 
# File 'lib/oci/generative_ai/models/create_generative_ai_private_endpoint_details.rb', line 277

def to_s
  to_hash.to_s
end