Class BrandingSetting


  • @Generated(value="OracleSDKGenerator",
               comments="API Version: v1")
    public final class BrandingSetting
    extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
    Brand Settings schema
    Note: Objects should always be created or deserialized using the BrandingSetting.Builder.

    This model distinguishes fields that are null because they are unset from fields that are explicitly set to null. This is done in the setter methods of the BrandingSetting.Builder, which maintain a set of all explicitly set fields called BrandingSetting.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set fields into account. The constructor, on the other hand, does not take the explicitly set fields into account (since the constructor cannot distinguish explicit null from unset null).

    • Method Detail

      • getId

        public String getId()
        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:
        the value
      • getOcid

        public String getOcid()
        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:
        the value
      • getSchemas

        public List<String> getSchemas()
        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:
        the value
      • getMeta

        public Meta getMeta()
      • getIdcsPreventedOperations

        public List<IdcsPreventedOperations> getIdcsPreventedOperations()
        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:
        the value
      • getTags

        public List<Tags> getTags()
        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:
        the value
      • getDeleteInProgress

        public Boolean getDeleteInProgress()
        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:
        the value
      • getIdcsLastUpgradedInRelease

        public String getIdcsLastUpgradedInRelease()
        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:
        the value
      • getDomainOcid

        public String getDomainOcid()
        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:
        the value
      • getCompartmentOcid

        public String getCompartmentOcid()
        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:
        the value
      • getTenancyOcid

        public String getTenancyOcid()
        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:
        the value
      • getExternalId

        public String getExternalId()
        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:
        the value
      • getCustomBranding

        public Boolean getCustomBranding()
        Indicates if the branding is default or is custom branding

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

        Returns:
        the value
      • getPreferredLanguage

        public String getPreferredLanguage()
        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:
        the value
      • getTimezone

        public String getTimezone()
        User’s timezone

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

        Returns:
        the value
      • getLocale

        public String getLocale()
        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:
        the value
      • getEnableTermsOfUse

        public Boolean getEnableTermsOfUse()
        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:
        the value
      • getTermsOfUseUrl

        public String getTermsOfUseUrl()
        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:
        the value
      • getPrivacyPolicyUrl

        public String getPrivacyPolicyUrl()
        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:
        the value
      • getIsHostedPage

        public Boolean getIsHostedPage()
        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:
        the value
      • getCustomHtmlLocation

        public String getCustomHtmlLocation()
        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:
        the value
      • getCustomCssLocation

        public String getCustomCssLocation()
        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:
        the value
      • getCustomTranslation

        public String getCustomTranslation()
        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:
        the value
      • getDefaultCompanyNames

        public List<BrandingSettingsDefaultCompanyNames> getDefaultCompanyNames()
        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:
        the value
      • getDefaultLoginTexts

        public List<BrandingSettingsDefaultLoginTexts> getDefaultLoginTexts()
        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:
        the value
      • getDefaultImages

        public List<BrandingSettingsDefaultImages> getDefaultImages()
        References to various images

        *Added In:** 18.2.2

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

        Returns:
        the value
      • getCompanyNames

        public List<BrandingSettingsCompanyNames> getCompanyNames()
        Name of the company in different locales

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

        Returns:
        the value
      • getLoginTexts

        public List<BrandingSettingsLoginTexts> getLoginTexts()
        Login text in different locales

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

        Returns:
        the value
      • getImages

        public List<BrandingSettingsImages> getImages()
        References to various images

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

        Returns:
        the value
      • toString

        public String toString()
        Overrides:
        toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
      • toString

        public String toString​(boolean includeByteArrayContents)
        Return a string representation of the object.
        Parameters:
        includeByteArrayContents - true to include the full contents of byte arrays
        Returns:
        string representation
      • equals

        public boolean equals​(Object o)
        Overrides:
        equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel