Class: OCI::FusionApps::Models::CreateFusionEnvironmentDetails

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/fusion_apps/models/create_fusion_environment_details.rb

Overview

The configuration details of the FusionEnvironment. For more information about these fields, see Managing Environments.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateFusionEnvironmentDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
 
# File 'lib/oci/fusion_apps/models/create_fusion_environment_details.rb', line 134

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

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

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

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

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

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

  self.fusion_environment_type = attributes[:'fusionEnvironmentType'] if attributes[:'fusionEnvironmentType']

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

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

  self.kms_key_id = attributes[:'kmsKeyId'] if attributes[:'kmsKeyId']

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

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

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

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

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

  self.is_i_pv6_dual_stack_enabled = attributes[:'isIPv6DualStackEnabled'] unless attributes[:'isIPv6DualStackEnabled'].nil?

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

  self.is_i_pv6_dual_stack_enabled = attributes[:'is_i_pv6_dual_stack_enabled'] unless attributes[:'is_i_pv6_dual_stack_enabled'].nil?

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

  self.additional_egress_rules = attributes[:'additionalEgressRules'] if attributes[:'additionalEgressRules']

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

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

  self.create_fusion_environment_admin_user_details = attributes[:'createFusionEnvironmentAdminUserDetails'] if attributes[:'createFusionEnvironmentAdminUserDetails']

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

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

  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

#additional_egress_rules ⇒ Array<OCI::FusionApps::Models::AdditionalEgressRule>

Additional egress rules that should be applied to the environment. Some standard ports are open for general use; see Securing Network Access to a Fusion Applications Environment. If access to a non-standard port is required, however, they can be listed here.

Returns:



52
53
54
 
# File 'lib/oci/fusion_apps/models/create_fusion_environment_details.rb', line 52

def additional_egress_rules
  @additional_egress_rules
end

#additional_language_packs ⇒ Array<String>

Language packs.

Returns:

  • (Array<String>) 


40
41
42
 
# File 'lib/oci/fusion_apps/models/create_fusion_environment_details.rb', line 40

def additional_language_packs
  @additional_language_packs
end

#compartment_id ⇒ String

[Required] The unique identifier (OCID) of the compartment where the Fusion Environment is located.

Returns:

  • (String) 


20
21
22
 
# File 'lib/oci/fusion_apps/models/create_fusion_environment_details.rb', line 20

def compartment_id
  @compartment_id
end

#create_fusion_environment_admin_user_details ⇒ OCI::FusionApps::Models::CreateFusionEnvironmentAdminUserDetails

This attribute is required.

Returns:



56
57
58
 
# File 'lib/oci/fusion_apps/models/create_fusion_environment_details.rb', line 56

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


68
69
70
 
# File 'lib/oci/fusion_apps/models/create_fusion_environment_details.rb', line 68

def defined_tags
  @defined_tags
end

#display_name ⇒ String

[Required] FusionEnvironment Identifier can be renamed.

Returns:

  • (String) 


13
14
15
 
# File 'lib/oci/fusion_apps/models/create_fusion_environment_details.rb', line 13

def display_name
  @display_name
end

#dns_prefix ⇒ String

DNS prefix.

Returns:

  • (String) 


36
37
38
 
# File 'lib/oci/fusion_apps/models/create_fusion_environment_details.rb', line 36

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


62
63
64
 
# File 'lib/oci/fusion_apps/models/create_fusion_environment_details.rb', line 62

def freeform_tags
  @freeform_tags
end

#fusion_environment_family_id ⇒ String

[Required] The unique identifier (OCID) of the Fusion Environment Family that the Fusion Environment belongs to.

Returns:

  • (String) 


24
25
26
 
# File 'lib/oci/fusion_apps/models/create_fusion_environment_details.rb', line 24

def fusion_environment_family_id
  @fusion_environment_family_id
end

#fusion_environment_type ⇒ String

[Required] The type of environment. Valid values are Production, Test, Development, or Demo.

Returns:

  • (String) 


28
29
30
 
# File 'lib/oci/fusion_apps/models/create_fusion_environment_details.rb', line 28

def fusion_environment_type
  @fusion_environment_type
end

#is_i_pv6_dual_stack_enabled ⇒ BOOLEAN

Enable IPv4/IPv6 dual stack support for the environment (where available). Setting to true will assign an IPv6 address to the environment in addition to an IPv4 address. The default value is false.

Returns:

  • (BOOLEAN) 


44
45
46
 
# File 'lib/oci/fusion_apps/models/create_fusion_environment_details.rb', line 44

def is_i_pv6_dual_stack_enabled
  @is_i_pv6_dual_stack_enabled
end

#kms_key_id ⇒ String

byok kms keyId

Returns:

  • (String) 


32
33
34
 
# File 'lib/oci/fusion_apps/models/create_fusion_environment_details.rb', line 32

def kms_key_id
  @kms_key_id
end

#maintenance_policy ⇒ OCI::FusionApps::Models::MaintenancePolicy

Returns:



16
17
18
 
# File 'lib/oci/fusion_apps/models/create_fusion_environment_details.rb', line 16

def maintenance_policy
  @maintenance_policy
end

#rules ⇒ Array<OCI::FusionApps::Models::Rule>

Rules.

Returns:



48
49
50
 
# File 'lib/oci/fusion_apps/models/create_fusion_environment_details.rb', line 48

def rules
  @rules
end

Class Method Details

.attribute_map ⇒ Object

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



71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/oci/fusion_apps/models/create_fusion_environment_details.rb', line 71

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'displayName',
    'maintenance_policy': :'maintenancePolicy',
    'compartment_id': :'compartmentId',
    'fusion_environment_family_id': :'fusionEnvironmentFamilyId',
    'fusion_environment_type': :'fusionEnvironmentType',
    'kms_key_id': :'kmsKeyId',
    'dns_prefix': :'dnsPrefix',
    'additional_language_packs': :'additionalLanguagePacks',
    'is_i_pv6_dual_stack_enabled': :'isIPv6DualStackEnabled',
    'rules': :'rules',
    'additional_egress_rules': :'additionalEgressRules',
    'create_fusion_environment_admin_user_details': :'createFusionEnvironmentAdminUserDetails',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'String',
    'maintenance_policy': :'OCI::FusionApps::Models::MaintenancePolicy',
    'compartment_id': :'String',
    'fusion_environment_family_id': :'String',
    'fusion_environment_type': :'String',
    'kms_key_id': :'String',
    'dns_prefix': :'String',
    'additional_language_packs': :'Array<String>',
    'is_i_pv6_dual_stack_enabled': :'BOOLEAN',
    'rules': :'Array<OCI::FusionApps::Models::Rule>',
    'additional_egress_rules': :'Array<OCI::FusionApps::Models::AdditionalEgressRule>',
    'create_fusion_environment_admin_user_details': :'OCI::FusionApps::Models::CreateFusionEnvironmentAdminUserDetails',
    '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



228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
 
# File 'lib/oci/fusion_apps/models/create_fusion_environment_details.rb', line 228

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

  self.class == other.class &&
    display_name == other.display_name &&
    maintenance_policy == other.maintenance_policy &&
    compartment_id == other.compartment_id &&
    fusion_environment_family_id == other.fusion_environment_family_id &&
    fusion_environment_type == other.fusion_environment_type &&
    kms_key_id == other.kms_key_id &&
    dns_prefix == other.dns_prefix &&
    additional_language_packs == other.additional_language_packs &&
    is_i_pv6_dual_stack_enabled == other.is_i_pv6_dual_stack_enabled &&
    rules == other.rules &&
    additional_egress_rules == other.additional_egress_rules &&
    create_fusion_environment_admin_user_details == other.create_fusion_environment_admin_user_details &&
    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



271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
 
# File 'lib/oci/fusion_apps/models/create_fusion_environment_details.rb', line 271

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


251
252
253
 
# File 'lib/oci/fusion_apps/models/create_fusion_environment_details.rb', line 251

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



260
261
262
 
# File 'lib/oci/fusion_apps/models/create_fusion_environment_details.rb', line 260

def hash
  [display_name, maintenance_policy, compartment_id, fusion_environment_family_id, fusion_environment_type, kms_key_id, dns_prefix, additional_language_packs, is_i_pv6_dual_stack_enabled, rules, additional_egress_rules, create_fusion_environment_admin_user_details, 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



304
305
306
307
308
309
310
311
312
313
 
# File 'lib/oci/fusion_apps/models/create_fusion_environment_details.rb', line 304

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



298
299
300
 
# File 'lib/oci/fusion_apps/models/create_fusion_environment_details.rb', line 298

def to_s
  to_hash.to_s
end