Class: OCI::GenerativeAi::Models::CreateHostedApplicationDetails

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

Overview

The details required to create a hosted application.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateHostedApplicationDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
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
 
# File 'lib/oci/generative_ai/models/create_hosted_application_details.rb', line 115

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

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

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

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

  self.scaling_config = attributes[:'scalingConfig'] if attributes[:'scalingConfig']

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

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

  self.networking_config = attributes[:'networkingConfig'] if attributes[:'networkingConfig']

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

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

  self.storage_configs = attributes[:'storageConfigs'] if attributes[:'storageConfigs']

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

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

  self.environment_variables = attributes[:'environmentVariables'] if attributes[:'environmentVariables']

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

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

  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 compartment OCID for the Hosted Application.

Returns:

  • (String) 


23
24
25
 
# File 'lib/oci/generative_ai/models/create_hosted_application_details.rb', line 23

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


61
62
63
 
# File 'lib/oci/generative_ai/models/create_hosted_application_details.rb', line 61

def defined_tags
  @defined_tags
end

#description ⇒ String

The description for the Hosted Application.

Returns:

  • (String) 


27
28
29
 
# File 'lib/oci/generative_ai/models/create_hosted_application_details.rb', line 27

def description
  @description
end

#display_name ⇒ String

[Required] The user-friendly display name for the Hosted Application. Does not need to be unique and can be updated after creation.

Returns:

  • (String) 


19
20
21
 
# File 'lib/oci/generative_ai/models/create_hosted_application_details.rb', line 19

def display_name
  @display_name
end

#environment_variables ⇒ Array<OCI::GenerativeAi::Models::EnvironmentVariable>

The list of environment variables for the Hosted Application. Defines a list of environment variables injected at runtime.

Returns:



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

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


53
54
55
 
# File 'lib/oci/generative_ai/models/create_hosted_application_details.rb', line 53

def freeform_tags
  @freeform_tags
end

#inbound_auth_config ⇒ OCI::GenerativeAi::Models::InboundAuthConfig

This attribute is required.

Returns:



13
14
15
 
# File 'lib/oci/generative_ai/models/create_hosted_application_details.rb', line 13

def inbound_auth_config
  @inbound_auth_config
end

#networking_config ⇒ OCI::GenerativeAi::Models::NetworkingConfig

Returns:



33
34
35
 
# File 'lib/oci/generative_ai/models/create_hosted_application_details.rb', line 33

def networking_config
  @networking_config
end

#scaling_config ⇒ OCI::GenerativeAi::Models::ScalingConfig

Returns:



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

def scaling_config
  @scaling_config
end

#storage_configs ⇒ Array<OCI::GenerativeAi::Models::StorageConfig>

The list of storage configuration for the Hosted Application. Defines a list of service-managed storage back-ends.

Returns:



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

def storage_configs
  @storage_configs
end

Class Method Details

.attribute_map ⇒ Object

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



64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/oci/generative_ai/models/create_hosted_application_details.rb', line 64

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'inbound_auth_config': :'inboundAuthConfig',
    'display_name': :'displayName',
    'compartment_id': :'compartmentId',
    'description': :'description',
    'scaling_config': :'scalingConfig',
    'networking_config': :'networkingConfig',
    'storage_configs': :'storageConfigs',
    'environment_variables': :'environmentVariables',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/oci/generative_ai/models/create_hosted_application_details.rb', line 82

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'inbound_auth_config': :'OCI::GenerativeAi::Models::InboundAuthConfig',
    'display_name': :'String',
    'compartment_id': :'String',
    'description': :'String',
    'scaling_config': :'OCI::GenerativeAi::Models::ScalingConfig',
    'networking_config': :'OCI::GenerativeAi::Models::NetworkingConfig',
    'storage_configs': :'Array<OCI::GenerativeAi::Models::StorageConfig>',
    'environment_variables': :'Array<OCI::GenerativeAi::Models::EnvironmentVariable>',
    '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



185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
 
# File 'lib/oci/generative_ai/models/create_hosted_application_details.rb', line 185

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

  self.class == other.class &&
    inbound_auth_config == other.inbound_auth_config &&
    display_name == other.display_name &&
    compartment_id == other.compartment_id &&
    description == other.description &&
    scaling_config == other.scaling_config &&
    networking_config == other.networking_config &&
    storage_configs == other.storage_configs &&
    environment_variables == other.environment_variables &&
    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



224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
 
# File 'lib/oci/generative_ai/models/create_hosted_application_details.rb', line 224

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


204
205
206
 
# File 'lib/oci/generative_ai/models/create_hosted_application_details.rb', line 204

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



213
214
215
 
# File 'lib/oci/generative_ai/models/create_hosted_application_details.rb', line 213

def hash
  [inbound_auth_config, display_name, compartment_id, description, scaling_config, networking_config, storage_configs, environment_variables, 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



257
258
259
260
261
262
263
264
265
266
 
# File 'lib/oci/generative_ai/models/create_hosted_application_details.rb', line 257

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



251
252
253
 
# File 'lib/oci/generative_ai/models/create_hosted_application_details.rb', line 251

def to_s
  to_hash.to_s
end