Class: OCI::FusionApps::Models::Microsite

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

Overview

microsite details for a marketing brand

Constant Summary collapse

LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_INACTIVE = 'INACTIVE'.freeze,
  LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
LIFECYCLE_DETAILS_ENUM = 
[
  LIFECYCLE_DETAILS_PENDING = 'PENDING'.freeze,
  LIFECYCLE_DETAILS_NONE = 'NONE'.freeze,
  LIFECYCLE_DETAILS_CREATING_TEMP_PROPERTY = 'CREATING_TEMP_PROPERTY'.freeze,
  LIFECYCLE_DETAILS_FAILURE_TEMP_PROPERTY_CREATION = 'FAILURE_TEMP_PROPERTY_CREATION'.freeze,
  LIFECYCLE_DETAILS_ACTIVATING_TEMP_PROPERTY = 'ACTIVATING_TEMP_PROPERTY'.freeze,
  LIFECYCLE_DETAILS_FAILURE_TEMP_PROPERTY_ACTIVATION = 'FAILURE_TEMP_PROPERTY_ACTIVATION'.freeze,
  LIFECYCLE_DETAILS_ACTIVATING_HOSTNAME_TEMP_PROPERTY = 'ACTIVATING_HOSTNAME_TEMP_PROPERTY'.freeze,
  LIFECYCLE_DETAILS_FAILURE_TEMP_PROPERTY_HOSTNAME_ACTIVATION = 'FAILURE_TEMP_PROPERTY_HOSTNAME_ACTIVATION'.freeze,
  LIFECYCLE_DETAILS_READY_FOR_MAIN_ACTIVATION = 'READY_FOR_MAIN_ACTIVATION'.freeze,
  LIFECYCLE_DETAILS_ACTIVATING_HOSTNAME = 'ACTIVATING_HOSTNAME'.freeze,
  LIFECYCLE_DETAILS_FAILURE_HOSTNAME_ACTIVATION = 'FAILURE_HOSTNAME_ACTIVATION'.freeze,
  LIFECYCLE_DETAILS_SENDING_BRAND_EVENT = 'SENDING_BRAND_EVENT'.freeze,
  LIFECYCLE_DETAILS_FAILURE_BRAND_EVENT = 'FAILURE_BRAND_EVENT'.freeze,
  LIFECYCLE_DETAILS_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
DNS_MANAGEMENT_ENUM = 
[
  DNS_MANAGEMENT_CUSTOMER_MANAGED = 'CUSTOMER_MANAGED'.freeze,
  DNS_MANAGEMENT_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
DNS_STATUS_ENUM = 
[
  DNS_STATUS_ACTIVE = 'ACTIVE'.freeze,
  DNS_STATUS_NOT_CONFIRMED = 'NOT_CONFIRMED'.freeze,
  DNS_STATUS_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
CERTIFICATE_MANAGEMENT_ENUM = 
[
  CERTIFICATE_MANAGEMENT_ORACLE_MANAGED = 'ORACLE_MANAGED'.freeze,
  CERTIFICATE_MANAGEMENT_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Microsite

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

  • :name (String) —

    The value to assign to the #name property

  • :marketing_brand_id (String) —

    The value to assign to the #marketing_brand_id property

  • :fusion_environment_id (String) —

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

  • :dns_management (String) —

    The value to assign to the #dns_management property

  • :dns_status (String) —

    The value to assign to the #dns_status property

  • :certificate_management (String) —

    The value to assign to the #certificate_management property

  • :time_created (DateTime) —

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



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
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
 
# File 'lib/oci/fusion_apps/models/microsite.rb', line 171

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

  self.marketing_brand_id = attributes[:'marketingBrandId'] if attributes[:'marketingBrandId']

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

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

  self.fusion_environment_id = attributes[:'fusionEnvironmentId'] if attributes[:'fusionEnvironmentId']

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

  self.fusion_environment_id = attributes[:'fusion_environment_id'] if attributes[:'fusion_environment_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.dns_management = attributes[:'dnsManagement'] if attributes[:'dnsManagement']

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

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

  self.dns_status = attributes[:'dnsStatus'] if attributes[:'dnsStatus']

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

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

  self.certificate_management = attributes[:'certificateManagement'] if attributes[:'certificateManagement']

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

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

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

Instance Attribute Details

#certificate_management ⇒ String

[Required] certificate management type for microsite

Returns:

  • (String) 


85
86
87
 
# File 'lib/oci/fusion_apps/models/microsite.rb', line 85

def certificate_management
  @certificate_management
end

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

[Required] 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>>) 


101
102
103
 
# File 'lib/oci/fusion_apps/models/microsite.rb', line 101

def defined_tags
  @defined_tags
end

#dns_management ⇒ String

[Required] dns management type for microsite

Returns:

  • (String) 


77
78
79
 
# File 'lib/oci/fusion_apps/models/microsite.rb', line 77

def dns_management
  @dns_management
end

#dns_status ⇒ String

[Required] dns status for microsite

Returns:

  • (String) 


81
82
83
 
# File 'lib/oci/fusion_apps/models/microsite.rb', line 81

def dns_status
  @dns_status
end

#freeform_tags ⇒ Hash<String, String>

[Required] 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>) 


95
96
97
 
# File 'lib/oci/fusion_apps/models/microsite.rb', line 95

def freeform_tags
  @freeform_tags
end

#fusion_environment_id ⇒ String

[Required] Fusion Environment Identifier

Returns:

  • (String) 


65
66
67
 
# File 'lib/oci/fusion_apps/models/microsite.rb', line 65

def fusion_environment_id
  @fusion_environment_id
end

#id ⇒ String

[Required] The unique identifier (OCID) of microsite. Can't be changed after creation.

Returns:

  • (String) 


53
54
55
 
# File 'lib/oci/fusion_apps/models/microsite.rb', line 53

def id
  @id
end

#lifecycle_details ⇒ String

microsite intermediate states

Returns:

  • (String) 


73
74
75
 
# File 'lib/oci/fusion_apps/models/microsite.rb', line 73

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

[Required] microsite lifecycle state

Returns:

  • (String) 


69
70
71
 
# File 'lib/oci/fusion_apps/models/microsite.rb', line 69

def lifecycle_state
  @lifecycle_state
end

#marketing_brand_id ⇒ String

[Required] Marketing Brand Identifier

Returns:

  • (String) 


61
62
63
 
# File 'lib/oci/fusion_apps/models/microsite.rb', line 61

def marketing_brand_id
  @marketing_brand_id
end

#name ⇒ String

[Required] microsite sudomain name

Returns:

  • (String) 


57
58
59
 
# File 'lib/oci/fusion_apps/models/microsite.rb', line 57

def name
  @name
end

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

[Required] The system tags associated with this resource, if any. The system tags are set by Oracle cloud infrastructure services. Each key is predefined and scoped to namespaces. For more information, see Resource Tags. Example: {orcl-cloud: {free-tier-retain: true}}

Returns:

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


108
109
110
 
# File 'lib/oci/fusion_apps/models/microsite.rb', line 108

def system_tags
  @system_tags
end

#time_created ⇒ DateTime

The time the Microsite was created. An RFC3339 formatted datetime string

Returns:

  • (DateTime) 


89
90
91
 
# File 'lib/oci/fusion_apps/models/microsite.rb', line 89

def time_created
  @time_created
end

Class Method Details

.attribute_map ⇒ Object

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



111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/oci/fusion_apps/models/microsite.rb', line 111

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'name': :'name',
    'marketing_brand_id': :'marketingBrandId',
    'fusion_environment_id': :'fusionEnvironmentId',
    'lifecycle_state': :'lifecycleState',
    'lifecycle_details': :'lifecycleDetails',
    'dns_management': :'dnsManagement',
    'dns_status': :'dnsStatus',
    'certificate_management': :'certificateManagement',
    'time_created': :'timeCreated',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags'
    # 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
 
# File 'lib/oci/fusion_apps/models/microsite.rb', line 132

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'name': :'String',
    'marketing_brand_id': :'String',
    'fusion_environment_id': :'String',
    'lifecycle_state': :'String',
    'lifecycle_details': :'String',
    'dns_management': :'String',
    'dns_status': :'String',
    'certificate_management': :'String',
    'time_created': :'DateTime',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'system_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



320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
 
# File 'lib/oci/fusion_apps/models/microsite.rb', line 320

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

  self.class == other.class &&
    id == other.id &&
    name == other.name &&
    marketing_brand_id == other.marketing_brand_id &&
    fusion_environment_id == other.fusion_environment_id &&
    lifecycle_state == other.lifecycle_state &&
    lifecycle_details == other.lifecycle_details &&
    dns_management == other.dns_management &&
    dns_status == other.dns_status &&
    certificate_management == other.certificate_management &&
    time_created == other.time_created &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    system_tags == other.system_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



362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
 
# File 'lib/oci/fusion_apps/models/microsite.rb', line 362

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


342
343
344
 
# File 'lib/oci/fusion_apps/models/microsite.rb', line 342

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



351
352
353
 
# File 'lib/oci/fusion_apps/models/microsite.rb', line 351

def hash
  [id, name, marketing_brand_id, fusion_environment_id, lifecycle_state, lifecycle_details, dns_management, dns_status, certificate_management, time_created, freeform_tags, defined_tags, system_tags].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



395
396
397
398
399
400
401
402
403
404
 
# File 'lib/oci/fusion_apps/models/microsite.rb', line 395

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



389
390
391
 
# File 'lib/oci/fusion_apps/models/microsite.rb', line 389

def to_s
  to_hash.to_s
end