Class: OCI::IdentityDomains::Models::BrandingSetting

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/identity_domains/models/branding_setting.rb

Overview

Brand Settings schema

Constant Summary collapse

IDCS_PREVENTED_OPERATIONS_ENUM = 
[
  IDCS_PREVENTED_OPERATIONS_REPLACE = 'replace'.freeze,
  IDCS_PREVENTED_OPERATIONS_UPDATE = 'update'.freeze,
  IDCS_PREVENTED_OPERATIONS_DELETE = 'delete'.freeze,
  IDCS_PREVENTED_OPERATIONS_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ BrandingSetting

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
 
# File 'lib/oci/identity_domains/models/branding_setting.rb', line 528

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

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

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

  self.idcs_created_by = attributes[:'idcsCreatedBy'] if attributes[:'idcsCreatedBy']

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

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

  self.idcs_last_modified_by = attributes[:'idcsLastModifiedBy'] if attributes[:'idcsLastModifiedBy']

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

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

  self.idcs_prevented_operations = attributes[:'idcsPreventedOperations'] if attributes[:'idcsPreventedOperations']

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

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

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

  self.delete_in_progress = attributes[:'deleteInProgress'] unless attributes[:'deleteInProgress'].nil?

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

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

  self.idcs_last_upgraded_in_release = attributes[:'idcsLastUpgradedInRelease'] if attributes[:'idcsLastUpgradedInRelease']

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

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

  self.domain_ocid = attributes[:'domainOcid'] if attributes[:'domainOcid']

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

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

  self.compartment_ocid = attributes[:'compartmentOcid'] if attributes[:'compartmentOcid']

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

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

  self.tenancy_ocid = attributes[:'tenancyOcid'] if attributes[:'tenancyOcid']

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

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

  self.external_id = attributes[:'externalId'] if attributes[:'externalId']

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

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

  self.custom_branding = attributes[:'customBranding'] unless attributes[:'customBranding'].nil?

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

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

  self.preferred_language = attributes[:'preferredLanguage'] if attributes[:'preferredLanguage']

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

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

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

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

  self.enable_terms_of_use = attributes[:'enableTermsOfUse'] unless attributes[:'enableTermsOfUse'].nil?

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

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

  self.terms_of_use_url = attributes[:'termsOfUseUrl'] if attributes[:'termsOfUseUrl']

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

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

  self.privacy_policy_url = attributes[:'privacyPolicyUrl'] if attributes[:'privacyPolicyUrl']

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

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

  self.is_hosted_page = attributes[:'isHostedPage'] unless attributes[:'isHostedPage'].nil?

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

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

  self.custom_html_location = attributes[:'customHtmlLocation'] if attributes[:'customHtmlLocation']

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

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

  self.custom_css_location = attributes[:'customCssLocation'] if attributes[:'customCssLocation']

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

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

  self.custom_translation = attributes[:'customTranslation'] if attributes[:'customTranslation']

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

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

  self.default_company_names = attributes[:'defaultCompanyNames'] if attributes[:'defaultCompanyNames']

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

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

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

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

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

  self.default_images = attributes[:'defaultImages'] if attributes[:'defaultImages']

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

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

  self.company_names = attributes[:'companyNames'] if attributes[:'companyNames']

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

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

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

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

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

  self.images = attributes[:'images'] if attributes[:'images']
end

Instance Attribute Details

#company_names ⇒ Array<OCI::IdentityDomains::Models::BrandingSettingsCompanyNames>

Name of the company in different locales

SCIM++ Properties: - idcsCompositeKey: [locale] - multiValued: true - mutability: readOnly - required: false - returned: default - type: complex

Returns:



387
388
389
 
# File 'lib/oci/identity_domains/models/branding_setting.rb', line 387

def company_names
  @company_names
end

#compartment_ocid ⇒ String

OCI Compartment Id (ocid) in which the resource lives.

SCIM++ Properties: - caseExact: false - idcsSearchable: false - multiValued: false - mutability: readOnly - required: false - returned: default - type: string - uniqueness: none

Returns:

  • (String) 


151
152
153
 
# File 'lib/oci/identity_domains/models/branding_setting.rb', line 151

def compartment_ocid
  @compartment_ocid
end

#custom_branding ⇒ BOOLEAN

Indicates if the branding is default or is custom branding

SCIM++ Properties: - multiValued: false - mutability: readOnly - required: false - returned: default - type: boolean

Returns:

  • (BOOLEAN) 


189
190
191
 
# File 'lib/oci/identity_domains/models/branding_setting.rb', line 189

def custom_branding
  @custom_branding
end

#custom_css_location ⇒ String

Storage URL location where the sanitized custom css is located

Added In: 20.1.3

SCIM++ Properties: - caseExact: false - multiValued: false - mutability: readWrite - required: false - returned: default - type: string - uniqueness: none

Returns:

  • (String) 


318
319
320
 
# File 'lib/oci/identity_domains/models/branding_setting.rb', line 318

def custom_css_location
  @custom_css_location
end

#custom_html_location ⇒ String

Storage URL location where the sanitized custom html is located

Added In: 20.1.3

SCIM++ Properties: - caseExact: false - multiValued: false - mutability: readWrite - required: false - returned: default - type: string - uniqueness: none

Returns:

  • (String) 


303
304
305
 
# File 'lib/oci/identity_domains/models/branding_setting.rb', line 303

def custom_html_location
  @custom_html_location
end

#custom_translation ⇒ String

Custom translations (JSON String)

Added In: 20.1.3

SCIM++ Properties: - caseExact: false - multiValued: false - mutability: readWrite - required: false - returned: default - type: string - uniqueness: none

Returns:

  • (String) 


333
334
335
 
# File 'lib/oci/identity_domains/models/branding_setting.rb', line 333

def custom_translation
  @custom_translation
end

#default_company_names ⇒ Array<OCI::IdentityDomains::Models::BrandingSettingsDefaultCompanyNames>

Default name of the Company in different locales

Added In: 18.2.2

SCIM++ Properties: - idcsCompositeKey: [locale] - multiValued: true - mutability: readOnly - required: false - returned: default - type: complex

Returns:



347
348
349
 
# File 'lib/oci/identity_domains/models/branding_setting.rb', line 347

def default_company_names
  @default_company_names
end

#default_images ⇒ Array<OCI::IdentityDomains::Models::BrandingSettingsDefaultImages>

References to various images

Added In: 18.2.2

SCIM++ Properties: - idcsCompositeKey: [type] - multiValued: true - mutability: readOnly - required: false - returned: default - type: complex

Returns:



375
376
377
 
# File 'lib/oci/identity_domains/models/branding_setting.rb', line 375

def default_images
  @default_images
end

#default_login_texts ⇒ Array<OCI::IdentityDomains::Models::BrandingSettingsDefaultLoginTexts>

Default Login text in different locales

Added In: 18.2.2

SCIM++ Properties: - idcsCompositeKey: [locale] - multiValued: true - mutability: readOnly - required: false - returned: default - type: complex

Returns:



361
362
363
 
# File 'lib/oci/identity_domains/models/branding_setting.rb', line 361

def 
  @default_login_texts
end

#delete_in_progress ⇒ BOOLEAN

A boolean flag indicating this resource in the process of being deleted. Usually set to true when synchronous deletion of the resource would take too long.

SCIM++ Properties: - caseExact: false - idcsSearchable: true - multiValued: false - mutability: readOnly - required: false - returned: default - type: boolean - uniqueness: none

Returns:

  • (BOOLEAN) 


109
110
111
 
# File 'lib/oci/identity_domains/models/branding_setting.rb', line 109

def delete_in_progress
  @delete_in_progress
end

#domain_ocid ⇒ String

OCI Domain Id (ocid) in which the resource lives.

SCIM++ Properties: - caseExact: false - idcsSearchable: false - multiValued: false - mutability: readOnly - required: false - returned: default - type: string - uniqueness: none

Returns:

  • (String) 


137
138
139
 
# File 'lib/oci/identity_domains/models/branding_setting.rb', line 137

def domain_ocid
  @domain_ocid
end

#enable_terms_of_use ⇒ BOOLEAN

Indicates if Terms of Use is enabled in UI

Added In: 18.2.4

SCIM++ Properties: - caseExact: false - multiValued: false - mutability: readOnly - required: false - returned: default - type: boolean - uniqueness: none

Returns:

  • (BOOLEAN) 


243
244
245
 
# File 'lib/oci/identity_domains/models/branding_setting.rb', line 243

def enable_terms_of_use
  @enable_terms_of_use
end

#external_id ⇒ String

An identifier for the Resource as defined by the Service Consumer. The externalId may simplify identification of the Resource between Service Consumer and Service Provider by allowing the Consumer to refer to the Resource with its own identifier, obviating the need to store a local mapping between the local identifier of the Resource and the identifier used by the Service Provider. Each Resource MAY include a non-empty externalId value. The value of the externalId attribute is always issued by the Service Consumer and can never be specified by the Service Provider. The Service Provider MUST always interpret the externalId as scoped to the Service Consumer's tenant.

SCIM++ Properties: - caseExact: false - multiValued: false - mutability: readWrite - required: false - returned: default - type: string - uniqueness: none

Returns:

  • (String) 


178
179
180
 
# File 'lib/oci/identity_domains/models/branding_setting.rb', line 178

def external_id
  @external_id
end

#id ⇒ String

Unique identifier for the SCIM Resource as defined by the Service Provider. Each representation of the Resource MUST include a non-empty id value. This identifier MUST be unique across the Service Provider's entire set of Resources. It MUST be a stable, non-reassignable identifier that does not change when the same Resource is returned in subsequent requests. The value of the id attribute is always issued by the Service Provider and MUST never be specified by the Service Consumer. bulkId: is a reserved keyword and MUST NOT be used in the unique identifier.

SCIM++ Properties: - caseExact: false - idcsSearchable: true - multiValued: false - mutability: readOnly - required: false - returned: always - type: string - uniqueness: global

Returns:

  • (String) 


31
32
33
 
# File 'lib/oci/identity_domains/models/branding_setting.rb', line 31

def id
  @id
end

#idcs_created_by ⇒ OCI::IdentityDomains::Models::IdcsCreatedBy

Returns:



65
66
67
 
# File 'lib/oci/identity_domains/models/branding_setting.rb', line 65

def idcs_created_by
  @idcs_created_by
end

#idcs_last_modified_by ⇒ OCI::IdentityDomains::Models::IdcsLastModifiedBy

Returns:



68
69
70
 
# File 'lib/oci/identity_domains/models/branding_setting.rb', line 68

def idcs_last_modified_by
  @idcs_last_modified_by
end

#idcs_last_upgraded_in_release ⇒ String

The release number when the resource was upgraded.

SCIM++ Properties: - caseExact: false - idcsSearchable: false - multiValued: false - mutability: readOnly - required: false - returned: request - type: string - uniqueness: none

Returns:

  • (String) 


123
124
125
 
# File 'lib/oci/identity_domains/models/branding_setting.rb', line 123

def idcs_last_upgraded_in_release
  @idcs_last_upgraded_in_release
end

#idcs_prevented_operations ⇒ Array<String>

Each value of this attribute specifies an operation that only an internal client may perform on this particular resource.

SCIM++ Properties: - idcsSearchable: false - multiValued: true - mutability: readOnly - required: false - returned: request - type: string - uniqueness: none

Returns:

  • (Array<String>) 


81
82
83
 
# File 'lib/oci/identity_domains/models/branding_setting.rb', line 81

def idcs_prevented_operations
  @idcs_prevented_operations
end

#images ⇒ Array<OCI::IdentityDomains::Models::BrandingSettingsImages>

References to various images

SCIM++ Properties: - idcsCompositeKey: [type] - multiValued: true - mutability: readOnly - required: false - returned: default - type: complex

Returns:



411
412
413
 
# File 'lib/oci/identity_domains/models/branding_setting.rb', line 411

def images
  @images
end

#is_hosted_page ⇒ BOOLEAN

Indicates if 'hosted' option was selected

Added In: 20.1.3

SCIM++ Properties: - caseExact: false - multiValued: false - mutability: readWrite - required: false - returned: default - type: boolean - uniqueness: none

Returns:

  • (BOOLEAN) 


288
289
290
 
# File 'lib/oci/identity_domains/models/branding_setting.rb', line 288

def is_hosted_page
  @is_hosted_page
end

#locale ⇒ String

Default location for purposes of localizing items such as currency, date and time format, numerical representations, and so on

SCIM++ Properties: - caseExact: false - multiValued: false - mutability: readOnly - required: false - returned: default - type: string - uniqueness: none

Returns:

  • (String) 


228
229
230
 
# File 'lib/oci/identity_domains/models/branding_setting.rb', line 228

def locale
  @locale
end

#login_texts ⇒ Array<OCI::IdentityDomains::Models::BrandingSettingsLoginTexts>

Login text in different locales

SCIM++ Properties: - idcsCompositeKey: [locale] - multiValued: true - mutability: readOnly - required: false - returned: default - type: complex

Returns:



399
400
401
 
# File 'lib/oci/identity_domains/models/branding_setting.rb', line 399

def 
  @login_texts
end

#meta ⇒ OCI::IdentityDomains::Models::Meta

Returns:



62
63
64
 
# File 'lib/oci/identity_domains/models/branding_setting.rb', line 62

def meta
  @meta
end

#ocid ⇒ String

Unique OCI identifier for the SCIM Resource.

SCIM++ Properties: - caseExact: true - idcsSearchable: true - multiValued: false - mutability: immutable - required: false - returned: default - type: string - uniqueness: global

Returns:

  • (String) 


45
46
47
 
# File 'lib/oci/identity_domains/models/branding_setting.rb', line 45

def ocid
  @ocid
end

#preferred_language ⇒ String

Preferred written or spoken language used for localized user interfaces

SCIM++ Properties: - caseExact: false - multiValued: false - mutability: readOnly - required: false - returned: default - type: string - uniqueness: none

Returns:

  • (String) 


202
203
204
 
# File 'lib/oci/identity_domains/models/branding_setting.rb', line 202

def preferred_language
  @preferred_language
end

#privacy_policy_url ⇒ String

Privacy Policy URL

Added In: 18.2.4

SCIM++ Properties: - caseExact: false - multiValued: false - mutability: readOnly - required: false - returned: default - type: string - uniqueness: none

Returns:

  • (String) 


273
274
275
 
# File 'lib/oci/identity_domains/models/branding_setting.rb', line 273

def privacy_policy_url
  @privacy_policy_url
end

#schemas ⇒ Array<String>

[Required] REQUIRED. The schemas attribute is an array of Strings which allows introspection of the supported schema version for a SCIM representation as well any schema extensions supported by that representation. Each String value must be a unique URI. This specification defines URIs for User, Group, and a standard \“enterprise\” extension. All representations of SCIM schema MUST include a non-zero value array with value(s) of the URIs supported by that representation. Duplicate values MUST NOT be included. Value order is not specified and MUST not impact behavior.

SCIM++ Properties: - caseExact: false - idcsSearchable: false - multiValued: true - mutability: readWrite - required: true - returned: default - type: string - uniqueness: none

Returns:

  • (Array<String>) 


59
60
61
 
# File 'lib/oci/identity_domains/models/branding_setting.rb', line 59

def schemas
  @schemas
end

#tags ⇒ Array<OCI::IdentityDomains::Models::Tags>

A list of tags on this resource.

SCIM++ Properties: - idcsCompositeKey: [key, value] - idcsSearchable: true - multiValued: true - mutability: readWrite - required: false - returned: request - type: complex - uniqueness: none

Returns:



95
96
97
 
# File 'lib/oci/identity_domains/models/branding_setting.rb', line 95

def tags
  @tags
end

#tenancy_ocid ⇒ String

OCI Tenant Id (ocid) in which the resource lives.

SCIM++ Properties: - caseExact: false - idcsSearchable: false - multiValued: false - mutability: readOnly - required: false - returned: default - type: string - uniqueness: none

Returns:

  • (String) 


165
166
167
 
# File 'lib/oci/identity_domains/models/branding_setting.rb', line 165

def tenancy_ocid
  @tenancy_ocid
end

#terms_of_use_url ⇒ String

Terms of Use URL

Added In: 18.2.4

SCIM++ Properties: - caseExact: false - multiValued: false - mutability: readOnly - required: false - returned: default - type: string - uniqueness: none

Returns:

  • (String) 


258
259
260
 
# File 'lib/oci/identity_domains/models/branding_setting.rb', line 258

def terms_of_use_url
  @terms_of_use_url
end

#timezone ⇒ String

User's timezone

SCIM++ Properties: - caseExact: false - multiValued: false - mutability: readOnly - required: false - returned: default - type: string - uniqueness: none

Returns:

  • (String) 


215
216
217
 
# File 'lib/oci/identity_domains/models/branding_setting.rb', line 215

def timezone
  @timezone
end

Class Method Details

.attribute_map ⇒ Object

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



414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
 
# File 'lib/oci/identity_domains/models/branding_setting.rb', line 414

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'ocid': :'ocid',
    'schemas': :'schemas',
    'meta': :'meta',
    'idcs_created_by': :'idcsCreatedBy',
    'idcs_last_modified_by': :'idcsLastModifiedBy',
    'idcs_prevented_operations': :'idcsPreventedOperations',
    'tags': :'tags',
    'delete_in_progress': :'deleteInProgress',
    'idcs_last_upgraded_in_release': :'idcsLastUpgradedInRelease',
    'domain_ocid': :'domainOcid',
    'compartment_ocid': :'compartmentOcid',
    'tenancy_ocid': :'tenancyOcid',
    'external_id': :'externalId',
    'custom_branding': :'customBranding',
    'preferred_language': :'preferredLanguage',
    'timezone': :'timezone',
    'locale': :'locale',
    'enable_terms_of_use': :'enableTermsOfUse',
    'terms_of_use_url': :'termsOfUseUrl',
    'privacy_policy_url': :'privacyPolicyUrl',
    'is_hosted_page': :'isHostedPage',
    'custom_html_location': :'customHtmlLocation',
    'custom_css_location': :'customCssLocation',
    'custom_translation': :'customTranslation',
    'default_company_names': :'defaultCompanyNames',
    'default_login_texts': :'defaultLoginTexts',
    'default_images': :'defaultImages',
    'company_names': :'companyNames',
    'login_texts': :'loginTexts',
    'images': :'images'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
 
# File 'lib/oci/identity_domains/models/branding_setting.rb', line 453

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'ocid': :'String',
    'schemas': :'Array<String>',
    'meta': :'OCI::IdentityDomains::Models::Meta',
    'idcs_created_by': :'OCI::IdentityDomains::Models::IdcsCreatedBy',
    'idcs_last_modified_by': :'OCI::IdentityDomains::Models::IdcsLastModifiedBy',
    'idcs_prevented_operations': :'Array<String>',
    'tags': :'Array<OCI::IdentityDomains::Models::Tags>',
    'delete_in_progress': :'BOOLEAN',
    'idcs_last_upgraded_in_release': :'String',
    'domain_ocid': :'String',
    'compartment_ocid': :'String',
    'tenancy_ocid': :'String',
    'external_id': :'String',
    'custom_branding': :'BOOLEAN',
    'preferred_language': :'String',
    'timezone': :'String',
    'locale': :'String',
    'enable_terms_of_use': :'BOOLEAN',
    'terms_of_use_url': :'String',
    'privacy_policy_url': :'String',
    'is_hosted_page': :'BOOLEAN',
    'custom_html_location': :'String',
    'custom_css_location': :'String',
    'custom_translation': :'String',
    'default_company_names': :'Array<OCI::IdentityDomains::Models::BrandingSettingsDefaultCompanyNames>',
    'default_login_texts': :'Array<OCI::IdentityDomains::Models::BrandingSettingsDefaultLoginTexts>',
    'default_images': :'Array<OCI::IdentityDomains::Models::BrandingSettingsDefaultImages>',
    'company_names': :'Array<OCI::IdentityDomains::Models::BrandingSettingsCompanyNames>',
    'login_texts': :'Array<OCI::IdentityDomains::Models::BrandingSettingsLoginTexts>',
    'images': :'Array<OCI::IdentityDomains::Models::BrandingSettingsImages>'
    # 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



716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
 
# File 'lib/oci/identity_domains/models/branding_setting.rb', line 716

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

  self.class == other.class &&
    id == other.id &&
    ocid == other.ocid &&
    schemas == other.schemas &&
    meta == other.meta &&
    idcs_created_by == other.idcs_created_by &&
    idcs_last_modified_by == other.idcs_last_modified_by &&
    idcs_prevented_operations == other.idcs_prevented_operations &&
    tags == other.tags &&
    delete_in_progress == other.delete_in_progress &&
    idcs_last_upgraded_in_release == other.idcs_last_upgraded_in_release &&
    domain_ocid == other.domain_ocid &&
    compartment_ocid == other.compartment_ocid &&
    tenancy_ocid == other.tenancy_ocid &&
    external_id == other.external_id &&
    custom_branding == other.custom_branding &&
    preferred_language == other.preferred_language &&
    timezone == other.timezone &&
    locale == other.locale &&
    enable_terms_of_use == other.enable_terms_of_use &&
    terms_of_use_url == other.terms_of_use_url &&
    privacy_policy_url == other.privacy_policy_url &&
    is_hosted_page == other.is_hosted_page &&
    custom_html_location == other.custom_html_location &&
    custom_css_location == other.custom_css_location &&
    custom_translation == other.custom_translation &&
    default_company_names == other.default_company_names &&
     == other. &&
    default_images == other.default_images &&
    company_names == other.company_names &&
     == other. &&
    images == other.images
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



776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
 
# File 'lib/oci/identity_domains/models/branding_setting.rb', line 776

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


756
757
758
 
# File 'lib/oci/identity_domains/models/branding_setting.rb', line 756

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



765
766
767
 
# File 'lib/oci/identity_domains/models/branding_setting.rb', line 765

def hash
  [id, ocid, schemas, meta, idcs_created_by, idcs_last_modified_by, idcs_prevented_operations, tags, delete_in_progress, idcs_last_upgraded_in_release, domain_ocid, compartment_ocid, tenancy_ocid, external_id, custom_branding, preferred_language, timezone, locale, enable_terms_of_use, terms_of_use_url, privacy_policy_url, is_hosted_page, custom_html_location, custom_css_location, custom_translation, default_company_names, , default_images, company_names, , images].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



809
810
811
812
813
814
815
816
817
818
 
# File 'lib/oci/identity_domains/models/branding_setting.rb', line 809

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



803
804
805
 
# File 'lib/oci/identity_domains/models/branding_setting.rb', line 803

def to_s
  to_hash.to_s
end