Package com.oracle.bmc.identitydomains.model

Class ResourceTypeSchemaAttribute

  • @Generated(value="OracleSDKGenerator",
           comments="API Version: v1")
public final class ResourceTypeSchemaAttribute
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
    ResourceTypeSchemaAttribute Schema Definition
    Note: Objects should always be created or deserialized using the ResourceTypeSchemaAttribute.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 ResourceTypeSchemaAttribute.Builder, which maintain a set of all explicitly set fields called ResourceTypeSchemaAttribute.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

      • getName

        public String getName()
        Attribute’s name

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

        Returns:
        the value

      • getIdcsDisplayNameMessageId

        public String getIdcsDisplayNameMessageId()
        Localized schema attribute display name for use by UI client for displaying attribute labels

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

        Returns:
        the value

      • getResourceType

        public String getResourceType()
        ResourceType this attribute belongs to.

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

        Returns:
        the value

      • getIdcsSchemaUrn

        public String getIdcsSchemaUrn()
        Schema URN string that this attribute belongs to

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

        Returns:
        the value

      • getIdcsFullyQualifiedName

        public String getIdcsFullyQualifiedName()
        Fully qualified name of this attribute

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

        Returns:
        the value

      • getIdcsCustomAttribute

        public Boolean getIdcsCustomAttribute()
        custom attribute flag.

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

        Returns:
        the value

      • getType

        public ResourceTypeSchemaAttribute.Type getType()
        The attribute’s data type–for example, String

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

        Returns:
        the value

      • getMultiValued

        public Boolean getMultiValued()
        Indicates the attribute’s plurality

        *SCIM++ Properties:** - multiValued: false - mutability: readWrite - required: false - idcsSearchable: true - returned: default - type: boolean

        Returns:
        the value

      • getDescription

        public String getDescription()
        The attribute’s human-readable description

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

        Returns:
        the value

      • getRequired

        public Boolean getRequired()
        Specifies if the attribute is required

        *SCIM++ Properties:** - multiValued: false - mutability: readWrite - required: false - idcsSearchable: true - returned: default - type: boolean

        Returns:
        the value

      • getCanonicalValues

        public List<String> getCanonicalValues()
        A collection of canonical values.

        Applicable Service Providers MUST specify the canonical types specified in the core schema specification–for example, \“work\”, \“home\”.

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

        Returns:
        the value

      • getCaseExact

        public Boolean getCaseExact()
        Specifies if the String attribute is case-sensitive

        *SCIM++ Properties:** - multiValued: false - mutability: readWrite - required: false - idcsSearchable: true - returned: default - type: boolean

        Returns:
        the value

      • getMutability

        public ResourceTypeSchemaAttribute.Mutability getMutability()
        Specifies if the attribute is mutable

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

        Returns:
        the value

      • getEndUserMutability

        public ResourceTypeSchemaAttribute.EndUserMutability getEndUserMutability()
        Specifies User mutability for this attribute

        *Added In:** 18.2.6

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

        Returns:
        the value

      • getEndUserMutabilityAllowedValues

        public List<ResourceTypeSchemaAttribute.EndUserMutabilityAllowedValues> getEndUserMutabilityAllowedValues()
        Specifies the list of User mutabilities allowed

        *Added In:** 18.2.6

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

        Returns:
        the value

      • getReturned

        public ResourceTypeSchemaAttribute.Returned getReturned()
        A single keyword that indicates when an attribute and associated values are returned in response to a GET request or in response to a PUT, POST, or PATCH request

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

        Returns:
        the value

      • getUniqueness

        public ResourceTypeSchemaAttribute.Uniqueness getUniqueness()
        A single keyword value that specifies how the Service Provider enforces uniqueness of attribute values.

        A server MAY reject an invalid value based on uniqueness by returning an HTTP response code of 400 (Bad Request). A client MAY enforce uniqueness on the client side to a greater degree than the Service Provider enforces. For example, a client could make a value unique while the server has the uniqueness of \“none\”.

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

        Returns:
        the value

      • getIdcsCsvColumnHeaderName

        public String getIdcsCsvColumnHeaderName()
        The attribute defining the CSV column header name for import/export

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

        Returns:
        the value

      • getIdcsICFBundleAttributeName

        public String getIdcsICFBundleAttributeName()
        Maps to ICF target attribute name

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

        Returns:
        the value

      • getIdcsICFRequired

        public Boolean getIdcsICFRequired()
        Metadata to identify the ICF required attribute

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

        Returns:
        the value

      • getIdcsICFAttributeType

        public ResourceTypeSchemaAttribute.IdcsICFAttributeType getIdcsICFAttributeType()
        Maps to ICF data type

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

        Returns:
        the value

      • getReferenceTypes

        public List<String> getReferenceTypes()
        The names of the Resource types that may be referenced–for example, User.

        This is only applicable for attributes that are of the \“reference\” data type.

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

        Returns:
        the value

      • getIdcsDeprecatedSinceVersion

        public Integer getIdcsDeprecatedSinceVersion()
        Indicates that the schema has been deprecated since version

        *SCIM++ Properties:** - multiValued: false - mutability: readWrite - required: false - idcsSearchable: true - returned: default - type: integer

        Returns:
        the value

      • getIdcsAddedSinceVersion

        public Integer getIdcsAddedSinceVersion()
        Indicates that the schema has been added since version

        *SCIM++ Properties:** - multiValued: false - mutability: readWrite - required: false - idcsSearchable: true - returned: default - type: integer

        Returns:
        the value

      • getIdcsDeprecatedSinceReleaseNumber

        public String getIdcsDeprecatedSinceReleaseNumber()
        Indicates that the schema has been deprecated since this release number

        *Added In:** 17.3.4

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

        Returns:
        the value

      • getIdcsAddedSinceReleaseNumber

        public String getIdcsAddedSinceReleaseNumber()
        Indicates that the schema has been added since this release number

        *Added In:** 17.3.4

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

        Returns:
        the value

      • getIdcsMinLength

        public Integer getIdcsMinLength()
        Specifies the minimum length of the attribute

        *SCIM++ Properties:** - multiValued: false - mutability: readWrite - idcsSearchable: true - required: false - returned: default - type: integer

        Returns:
        the value

      • getIdcsMaxLength

        public Integer getIdcsMaxLength()
        Specifies the maximum length of the attribute

        *SCIM++ Properties:** - multiValued: false - mutability: readWrite - required: false - idcsSearchable: true - returned: default - type: integer

        Returns:
        the value

      • getIdcsMinValue

        public Integer getIdcsMinValue()
        Specifies the minimum value of the integer attribute

        *SCIM++ Properties:** - multiValued: false - mutability: readOnly - required: false - idcsSearchable: true - returned: default - type: integer

        Returns:
        the value

      • getIdcsMaxValue

        public Integer getIdcsMaxValue()
        Specifies the maximum value of the integer attribute

        *SCIM++ Properties:** - multiValued: false - mutability: readOnly - idcsSearchable: true - required: false - returned: default - type: integer

        Returns:
        the value

      • getIdcsMultiLanguage

        public Boolean getIdcsMultiLanguage()
        If true, specifies that the attribute can have multiple language values set for the attribute on which this is set.

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

        Returns:
        the value

      • getIdcsRefResourceAttributes

        public List<String> getIdcsRefResourceAttributes()
        Specifies the directly referenced Resources

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

        Returns:
        the value

      • getIdcsIndirectRefResourceAttributes

        public List<String> getIdcsIndirectRefResourceAttributes()
        Specifies the indirectly referenced Resources

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

        Returns:
        the value

      • getIdcsAutoIncrementSeqName

        public String getIdcsAutoIncrementSeqName()
        Sequence tracking ID name for the attribute

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

        Returns:
        the value

      • getIdcsValuePersisted

        public Boolean getIdcsValuePersisted()
        Specifies whether the value of the Resource attribute is persisted

        *SCIM++ Properties:** - multiValued: false - mutability: readWrite - required: false - idcsSearchable: true - returned: default - type: boolean

        Returns:
        the value

      • getIdcsSensitive

        public ResourceTypeSchemaAttribute.IdcsSensitive getIdcsSensitive()
        Flag to specify if the attribute should be encrypted or hashed

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

        Returns:
        the value

      • getIdcsInternal

        public Boolean getIdcsInternal()
        Specifies whether the schema attribute is for internal use only.

        Internal attributes are not exposed via REST. This attribute overrides mutability for create/update if the request is internal and the attribute internalflag is set to True. This attribute overrides the return attribute while building SCIM response attributes when both the request is internal and the schema attribute is internal.

        *SCIM++ Properties:** - multiValued: false - mutability: readWrite - required: false - idcsSearchable: true - returned: default - type: boolean

        Returns:
        the value

      • getIdcsTrimStringValue

        public Boolean getIdcsTrimStringValue()
        Trims any leading and trailing blanks from String values.

        Default is True.

        *SCIM++ Properties:** - multiValued: false - mutability: readWrite - required: false - idcsSearchable: true - returned: default - type: boolean

        Returns:
        the value

      • getIdcsSearchable

        public Boolean getIdcsSearchable()
        Specifies whether this attribute can be included in a search filter

        *SCIM++ Properties:** - multiValued: false - mutability: readWrite - required: false - idcsSearchable: true - returned: default - type: boolean

        Returns:
        the value

      • getIdcsGenerated

        public Boolean getIdcsGenerated()
        Specifies whether this attribute value was generated

        *SCIM++ Properties:** - multiValued: false - mutability: readWrite - required: false - idcsSearchable: true - returned: default - type: boolean

        Returns:
        the value

      • getIdcsAuditable

        public Boolean getIdcsAuditable()
        Specifies whether changes to this attribute value are audited

        *SCIM++ Properties:** - multiValued: false - mutability: readWrite - idcsSearchable: true - required: false - returned: default - type: boolean

        Returns:
        the value

      • getIdcsTargetAttributeName

        public String getIdcsTargetAttributeName()
        Target attribute name that this attribute gets mapped to for persistence

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

        Returns:
        the value

      • getIdcsTargetUniqueConstraintName

        public String getIdcsTargetUniqueConstraintName()
        Target index name created for this attribute for performance

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

        Returns:
        the value

      • getIdcsTargetNormAttributeName

        public String getIdcsTargetNormAttributeName()
        Target normalized attribute name that this normalized value of attribute gets mapped to for persistence.

        Only set for caseExact=false & searchable attributes. Do not use by default.

        *Added In:** 19.1.4

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

        Returns:
        the value

      • getIdcsTargetAttributeNameToMigrateFrom

        public String getIdcsTargetAttributeNameToMigrateFrom()
        Old Target attribute name from child table for CSVA attribute prior to migration.

        This maintains this attribute used to get mapped to for persistence

        *Added In:** 19.1.4

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

        Returns:
        the value

      • getIdcsToTargetMapper

        public String getIdcsToTargetMapper()
        Specifies the mapper to use when mapping this attribute value to DataProvider-specific semantics

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

        Returns:
        the value

      • getIdcsFromTargetMapper

        public String getIdcsFromTargetMapper()
        Specifies the mapper to use when mapping this attribute value from DataProvider-specific semantics

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

        Returns:
        the value

      • getIdcsDisplayName

        public String getIdcsDisplayName()
        Specifies the user-friendly displayable attribute name or catalog key used for localization

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

        Returns:
        the value

      • getIdcsCanonicalValueSourceResourceType

        public String getIdcsCanonicalValueSourceResourceType()
        Specifies the Resource type to read from for dynamic canonical values

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

        Returns:
        the value

      • getIdcsCanonicalValueSourceFilter

        public String getIdcsCanonicalValueSourceFilter()
        Filter to use when getting canonical values for this schema attribute

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

        Returns:
        the value

      • getIdcsValidateReference

        public Boolean getIdcsValidateReference()
        Validate payload reference value during create, replace, and update.

        Default is True.

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

        Returns:
        the value

      • getIdcsCompositeKey

        public List<String> getIdcsCompositeKey()
        The set of one or more sub attributes’ names of a CMVA, whose values uniquely identify an instance of a CMVA

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

        Returns:
        the value

      • getIdcsFetchComplexAttributeValues

        public Boolean getIdcsFetchComplexAttributeValues()
        SCIM++ Properties: - caseExact: false - multiValued: false - mutability: readOnly - required: false - idcsSearchable: true - returned: default - type: boolean - uniqueness: none Whether the CMVA attribute will be fetched or not for current resource in AbstractResourceManager update operation before calling data provider update.

        Default is true.

        Returns:
        the value

      • getIdcsScimCompliant

        public Boolean getIdcsScimCompliant()
        Indicates if the attribute is scim compliant, default is true

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

        Returns:
        the value

      • getIdcsAttributeMappable

        public Boolean getIdcsAttributeMappable()
        Specifies if the attribute can be used for mapping with external identity sources such as AD or LDAP.

        If isSchemaMappable: false for the schema in which this attribute is defined, then this flag is ignored

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

        Returns:
        the value

      • getIdcsRefResourceAttribute

        public String getIdcsRefResourceAttribute()
        Specifies the referenced Resource attribute

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

        Returns:
        the value

      • getIdcsAttributeCacheable

        public Boolean getIdcsAttributeCacheable()
        Specifies whether the attribute is cacheable.

        True by default for all attributes. If attribute with idcsAttributeCachable = false, is present \“attributesToGet\” while executing GET/SEARCH on cacheable resource, Cache is missed and data is fetched from Data Provider.

        *Added In:** 17.3.4

        *SCIM++ Properties:** - multiValued: false - mutability: readWrite - idcsSearchable: true - required: false - returned: default - type: boolean

        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