SchemaSubAttributes.Builder (Oracle Cloud Infrastructure Java SDK

java.lang.Object
- com.oracle.bmc.identitydomains.model.SchemaSubAttributes.Builder

Enclosing class:: SchemaSubAttributes

public static class SchemaSubAttributes.Builder
extends Object

Constructor Summary

Constructors
Constructor and Description

Builder()

Constructors
Constructor and Description
`Builder()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`SchemaSubAttributes`	`build()`
`SchemaSubAttributes.Builder`	`canonicalValues(List<String> canonicalValues)` A collection of canonical values.
`SchemaSubAttributes.Builder`	`caseExact(Boolean caseExact)` Specifies if the String attribute is case-sensitive
`SchemaSubAttributes.Builder`	`copy(SchemaSubAttributes model)`
`SchemaSubAttributes.Builder`	`description(String description)` Attribute’s human-readable description
`SchemaSubAttributes.Builder`	`idcsAddedSinceReleaseNumber(String idcsAddedSinceReleaseNumber)` Indicates that the schema has been added since this release number
`SchemaSubAttributes.Builder`	`idcsAddedSinceVersion(Integer idcsAddedSinceVersion)` Indicates that the schema has been added since version
`SchemaSubAttributes.Builder`	`idcsAttributeCacheable(Boolean idcsAttributeCacheable)` Specifies whether the attribute is cacheable.
`SchemaSubAttributes.Builder`	`idcsAttributeMappable(Boolean idcsAttributeMappable)` Specifies if the attribute can be used for mapping with external identity sources such as AD or LDAP.
`SchemaSubAttributes.Builder`	`idcsAuditable(Boolean idcsAuditable)` Specifies whether changes to this attribute value will be audited
`SchemaSubAttributes.Builder`	`idcsCanonicalValueSourceDisplayAttrName(String idcsCanonicalValueSourceDisplayAttrName)` Display name for the canonical value attribute name.
`SchemaSubAttributes.Builder`	`idcsCanonicalValueSourceFilter(String idcsCanonicalValueSourceFilter)` Filter to use when getting canonical values for this schema attribute
`SchemaSubAttributes.Builder`	`idcsCanonicalValueSourceKeyAttrName(String idcsCanonicalValueSourceKeyAttrName)` Source key attribute for the canonical value.
`SchemaSubAttributes.Builder`	`idcsCanonicalValueSourceResourceType(String idcsCanonicalValueSourceResourceType)` Specifies the Resource type to read from for dynamic canonical values
`SchemaSubAttributes.Builder`	`idcsCanonicalValueSourceResourceTypeID(String idcsCanonicalValueSourceResourceTypeID)` Specifies the Resource type ID to read from for dynamic canonical values
`SchemaSubAttributes.Builder`	`idcsCsvAttributeName(String idcsCsvAttributeName)` The attribute that defines the CSV header name for import/export
`SchemaSubAttributes.Builder`	`idcsDefaultValue(String idcsDefaultValue)` Specifies the default value for an attribute.
`SchemaSubAttributes.Builder`	`idcsDeprecatedSinceReleaseNumber(String idcsDeprecatedSinceReleaseNumber)` Indicates that the schema has been deprecated since this release number
`SchemaSubAttributes.Builder`	`idcsDeprecatedSinceVersion(Integer idcsDeprecatedSinceVersion)` Indicates that the schema has been deprecated since version
`SchemaSubAttributes.Builder`	`idcsDisplayName(String idcsDisplayName)` Specifies the user-friendly displayable attribute name or catalog key used for localization
`SchemaSubAttributes.Builder`	`idcsDisplayNameMessageId(String idcsDisplayNameMessageId)` Localized schema attribute display name for use by UI client for displaying attribute labels
`SchemaSubAttributes.Builder`	`idcsExcludeFromUpgradePatch(Boolean idcsExcludeFromUpgradePatch)` Specifies whether the attribute should be excluded from the BulkApi patch generated by gradle task for upgrading OOTB resources.
`SchemaSubAttributes.Builder`	`idcsFromTargetMapper(String idcsFromTargetMapper)` Specifies the mapper to use when mapping this attribute value from DataProvider-specific semantics
`SchemaSubAttributes.Builder`	`idcsGenerated(Boolean idcsGenerated)` Specifies whether this attribute value was generated
`SchemaSubAttributes.Builder`	`idcsIndirectRefResourceAttributes(List<String> idcsIndirectRefResourceAttributes)` Specifies the indirectly referenced Resources
`SchemaSubAttributes.Builder`	`idcsInternal(Boolean idcsInternal)` Specifies whether the schema attribute is for internal use only.
`SchemaSubAttributes.Builder`	`idcsMaxLength(Integer idcsMaxLength)` Specifies the maximum length of this attribute
`SchemaSubAttributes.Builder`	`idcsMaxValue(Integer idcsMaxValue)` Specifies the maximum value of the integer attribute
`SchemaSubAttributes.Builder`	`idcsMaxValuesReturned(Integer idcsMaxValuesReturned)` SCIM++ Properties: - caseExact: true - multiValued: false - mutability: readOnly - required: false - returned: default - type: integer - uniqueness: none Specify a limit on the number of attribute-values that any caller will receive when requesting a CMVA attribute.
`SchemaSubAttributes.Builder`	`idcsMinLength(Integer idcsMinLength)` Specifies the minimum length of this attribute
`SchemaSubAttributes.Builder`	`idcsMinValue(Integer idcsMinValue)` Specifies the minimum value of the integer attribute
`SchemaSubAttributes.Builder`	`idcsOneValueMustBeTrue(Boolean idcsOneValueMustBeTrue)` If true, ARM will ensure atleast one of the instances of CMVA has the attribute value set to true.
`SchemaSubAttributes.Builder`	`idcsOnlyOneValueCanBeTrue(Boolean idcsOnlyOneValueCanBeTrue)` If true, specifies that the sub attribute value can be set to true on one and only one instance of the CMVA.
`SchemaSubAttributes.Builder`	`idcsPii(Boolean idcsPii)` Specifies whether the attribute is PII (personal information).
`SchemaSubAttributes.Builder`	`idcsRefResourceAttributes(List<String> idcsRefResourceAttributes)` Specifies the directly referenced Resources
`SchemaSubAttributes.Builder`	`idcsRequiresImmediateReadAfterWriteForAccessFlows(Boolean idcsRequiresImmediateReadAfterWriteForAccessFlows)` If true, indicates that the attribute value must be written to the home region and requires immediate read-after-write consistency for access flows initiated from a replica region.
`SchemaSubAttributes.Builder`	`idcsRequiresWriteForAccessFlows(Boolean idcsRequiresWriteForAccessFlows)` If true, indicates that the attribute value must be written to the home region for access flows initiated from a replica region.
`SchemaSubAttributes.Builder`	`idcsReturnEmptyWhenNull(Boolean idcsReturnEmptyWhenNull)` Specifies if the attribute is required
`SchemaSubAttributes.Builder`	`idcsRtsaHideAttribute(Boolean idcsRtsaHideAttribute)` Specifies if the attributes in this schema can be displayed externally
`SchemaSubAttributes.Builder`	`idcsSanitize(Boolean idcsSanitize)` Specifies if the value of the attribute should be sanitized using OWASP library for HTML content
`SchemaSubAttributes.Builder`	`idcsScimCompliant(Boolean idcsScimCompliant)` Indicates if the attribute is scim compliant, default is true
`SchemaSubAttributes.Builder`	`idcsSearchable(Boolean idcsSearchable)` Specifies whether this attribute can be included in a search filter
`SchemaSubAttributes.Builder`	`idcsSensitive(SchemaSubAttributes.IdcsSensitive idcsSensitive)` Specifiees if the attribute should be encrypted or hashed
`SchemaSubAttributes.Builder`	`idcsTargetAttributeName(String idcsTargetAttributeName)` Target attribute name that this attribute gets mapped to for persistence
`SchemaSubAttributes.Builder`	`idcsTargetAttributeNameToMigrateFrom(String idcsTargetAttributeNameToMigrateFrom)` Old Target attribute name from child table for CSVA attribute prior to migration.
`SchemaSubAttributes.Builder`	`idcsTargetNormAttributeName(String idcsTargetNormAttributeName)` Target normalized attribute name that this normalized value of attribute gets mapped to for persistence.
`SchemaSubAttributes.Builder`	`idcsTargetUniqueConstraintName(String idcsTargetUniqueConstraintName)` Target index name created for this attribute for performance
`SchemaSubAttributes.Builder`	`idcsToTargetMapper(String idcsToTargetMapper)` Specifies the mapper to use when mapping this attribute value to DataProvider-specific semantics
`SchemaSubAttributes.Builder`	`idcsTrimStringValue(Boolean idcsTrimStringValue)` Trims any leading and trailing blanks from String values.
`SchemaSubAttributes.Builder`	`idcsuiOrder(Integer idcsuiOrder)` Metadata used by Oracle Identity Cloud Service UI to sequence the attributes displayed on the Account Form.
`SchemaSubAttributes.Builder`	`idcsuiRegexp(String idcsuiRegexp)` Metadata used by Oracle Identity Cloud Service UI to validate the attribute values using regular expressions.
`SchemaSubAttributes.Builder`	`idcsuiVisible(Boolean idcsuiVisible)` Metadata used by Oracle Identity Cloud Service UI to decide whether the attribute must be displayed on the Account Form.
`SchemaSubAttributes.Builder`	`idcsuiWidget(SchemaSubAttributes.IdcsuiWidget idcsuiWidget)` Metadata used by Oracle Identity Cloud Service UI to render a widget for this attribute on the Account Form.
`SchemaSubAttributes.Builder`	`idcsValidateReference(Boolean idcsValidateReference)` Validate payload reference value during create, replace, and update.
`SchemaSubAttributes.Builder`	`idcsValuePersisted(Boolean idcsValuePersisted)` Specifies whether the sub-attribute of the Resource attribute is persisted
`SchemaSubAttributes.Builder`	`idcsValuePersistedInOtherAttribute(Boolean idcsValuePersistedInOtherAttribute)` If true, ARM should not validate the value of the attribute since it will be converted/migrated to another attribute internally by the manager which will build valid post, put, or patch payload, depending on the client requested operation
`SchemaSubAttributes.Builder`	`multiValued(Boolean multiValued)` Indicates the attribute’s plurality
`SchemaSubAttributes.Builder`	`mutability(SchemaSubAttributes.Mutability mutability)` Specifies if the attribute is mutable
`SchemaSubAttributes.Builder`	`name(String name)` Attribute’s name
`SchemaSubAttributes.Builder`	`referenceTypes(List<String> referenceTypes)` The names of the Resource types that may be referenced–for example, User.
`SchemaSubAttributes.Builder`	`required(Boolean required)` Specifies if the attribute is required
`SchemaSubAttributes.Builder`	`returned(SchemaSubAttributes.Returned returned)` 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
`SchemaSubAttributes.Builder`	`type(SchemaSubAttributes.Type type)` Attribute’s data type–for example, String
`SchemaSubAttributes.Builder`	`uniqueness(SchemaSubAttributes.Uniqueness uniqueness)` A single keyword value that specifies how the Service Provider enforces uniqueness of attribute values.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Builder
```
public Builder()
```
- Method Detail
  - name
```
public SchemaSubAttributes.Builder name(String name)
```
    Attribute’s name
    
    *SCIM++ Properties:** - caseExact: true - multiValued: false - mutability: readWrite - required: false - returned: default - type: string - uniqueness: none
    
    Parameters:
    
    name - the value to set
    
    Returns:
    
    this builder
  - idcsRequiresImmediateReadAfterWriteForAccessFlows
```
public SchemaSubAttributes.Builder idcsRequiresImmediateReadAfterWriteForAccessFlows(Boolean idcsRequiresImmediateReadAfterWriteForAccessFlows)
```
    If true, indicates that the attribute value must be written to the home region and requires immediate read-after-write consistency for access flows initiated from a replica region.
    
    *Added In:** 2209220956
    *SCIM++ Properties:** - multiValued: false - mutability: readWrite - required: false - returned: never - type: boolean
    
    Parameters:
    
    idcsRequiresImmediateReadAfterWriteForAccessFlows - the value to set
    
    Returns:
    
    this builder
  - idcsRequiresWriteForAccessFlows
```
public SchemaSubAttributes.Builder idcsRequiresWriteForAccessFlows(Boolean idcsRequiresWriteForAccessFlows)
```
    If true, indicates that the attribute value must be written to the home region for access flows initiated from a replica region.
    
    *Added In:** 2205120021
    *SCIM++ Properties:** - multiValued: false - mutability: readWrite - required: false - returned: default - type: boolean - uniqueness: none
    
    Parameters:
    
    idcsRequiresWriteForAccessFlows - the value to set
    
    Returns:
    
    this builder
  - idcsDisplayNameMessageId
```
public SchemaSubAttributes.Builder idcsDisplayNameMessageId(String idcsDisplayNameMessageId)
```
    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 - type: string - uniqueness: none
    
    Parameters:
    
    idcsDisplayNameMessageId - the value to set
    
    Returns:
    
    this builder
  - idcsRtsaHideAttribute
```
public SchemaSubAttributes.Builder idcsRtsaHideAttribute(Boolean idcsRtsaHideAttribute)
```
    Specifies if the attributes in this schema can be displayed externally
    
    *Added In:** 19.1.4
    *SCIM++ Properties:** - caseExact: false - multiValued: false - mutability: readOnly - required: false - returned: default - type: boolean - uniqueness: none
    
    Parameters:
    
    idcsRtsaHideAttribute - the value to set
    
    Returns:
    
    this builder
  - idcsInternal
```
public SchemaSubAttributes.Builder idcsInternal(Boolean idcsInternal)
```
    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 internal flag 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 - returned: default - type: boolean
    
    Parameters:
    
    idcsInternal - the value to set
    
    Returns:
    
    this builder
  - type
```
public SchemaSubAttributes.Builder type(SchemaSubAttributes.Type type)
```
    Attribute’s data type–for example, String
    
    *SCIM++ Properties:** - caseExact: false - multiValued: false - mutability: readWrite - required: false - returned: default - type: string - uniqueness: none
    
    Parameters:
    
    type - the value to set
    
    Returns:
    
    this builder
  - multiValued
```
public SchemaSubAttributes.Builder multiValued(Boolean multiValued)
```
    Indicates the attribute’s plurality
    
    *SCIM++ Properties:** - multiValued: false - mutability: readWrite - required: false - returned: default - type: boolean
    
    Parameters:
    
    multiValued - the value to set
    
    Returns:
    
    this builder
  - description
```
public SchemaSubAttributes.Builder description(String description)
```
    Attribute’s human-readable description
    
    *SCIM++ Properties:** - caseExact: true - multiValued: false - mutability: readWrite - required: false - returned: default - type: string - uniqueness: none
    
    Parameters:
    
    description - the value to set
    
    Returns:
    
    this builder
  - required
```
public SchemaSubAttributes.Builder required(Boolean required)
```
    Specifies if the attribute is required
    
    *SCIM++ Properties:** - multiValued: false - mutability: readWrite - required: false - returned: default - type: boolean
    
    Parameters:
    
    required - the value to set
    
    Returns:
    
    this builder
  - idcsReturnEmptyWhenNull
```
public SchemaSubAttributes.Builder idcsReturnEmptyWhenNull(Boolean idcsReturnEmptyWhenNull)
```
    Specifies if the attribute is required
    
    *Added In:** 2305190132
    *SCIM++ Properties:** - multiValued: false - mutability: readWrite - required: false - returned: default - type: boolean
    
    Parameters:
    
    idcsReturnEmptyWhenNull - the value to set
    
    Returns:
    
    this builder
  - canonicalValues
```
public SchemaSubAttributes.Builder canonicalValues(List<String> canonicalValues)
```
    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 - returned: default - type: string - uniqueness: none
    
    Parameters:
    
    canonicalValues - the value to set
    
    Returns:
    
    this builder
  - idcsDefaultValue
```
public SchemaSubAttributes.Builder idcsDefaultValue(String idcsDefaultValue)
```
    Specifies the default value for an attribute. The value must be one from canonicalValues if defined.
    
    *Added In:** 18.1.6
    *SCIM++ Properties:** - caseExact: true - multiValued: false - mutability: readWrite - required: false - returned: default - type: string - uniqueness: none
    
    Parameters:
    
    idcsDefaultValue - the value to set
    
    Returns:
    
    this builder
  - caseExact
```
public SchemaSubAttributes.Builder caseExact(Boolean caseExact)
```
    Specifies if the String attribute is case-sensitive
    
    *SCIM++ Properties:** - multiValued: false - mutability: readWrite - required: false - returned: default - type: boolean
    
    Parameters:
    
    caseExact - the value to set
    
    Returns:
    
    this builder
  - mutability
```
public SchemaSubAttributes.Builder mutability(SchemaSubAttributes.Mutability mutability)
```
    Specifies if the attribute is mutable
    
    *SCIM++ Properties:** - caseExact: true - multiValued: false - mutability: readWrite - required: false - returned: default - type: string - uniqueness: none
    
    Parameters:
    
    mutability - the value to set
    
    Returns:
    
    this builder
  - returned
```
public SchemaSubAttributes.Builder returned(SchemaSubAttributes.Returned returned)
```
    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 - type: string - uniqueness: none
    
    Parameters:
    
    returned - the value to set
    
    Returns:
    
    this builder
  - idcsCsvAttributeName
```
public SchemaSubAttributes.Builder idcsCsvAttributeName(String idcsCsvAttributeName)
```
    The attribute that defines the CSV header name for import/export
    
    *SCIM++ Properties:** - caseExact: true - multiValued: false - mutability: readWrite - required: false - returned: default - type: string - uniqueness: none
    
    Parameters:
    
    idcsCsvAttributeName - the value to set
    
    Returns:
    
    this builder
  - uniqueness
```
public SchemaSubAttributes.Builder uniqueness(SchemaSubAttributes.Uniqueness uniqueness)
```
    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 a uniqueness of \“none\”.
    
    *SCIM++ Properties:** - caseExact: true - multiValued: false - mutability: readWrite - required: false - returned: default - type: string - uniqueness: none
    
    Parameters:
    
    uniqueness - the value to set
    
    Returns:
    
    this builder
  - referenceTypes
```
public SchemaSubAttributes.Builder referenceTypes(List<String> referenceTypes)
```
    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 - returned: default - type: string - uniqueness: none
    
    Parameters:
    
    referenceTypes - the value to set
    
    Returns:
    
    this builder
  - idcsDeprecatedSinceVersion
```
public SchemaSubAttributes.Builder idcsDeprecatedSinceVersion(Integer idcsDeprecatedSinceVersion)
```
    Indicates that the schema has been deprecated since version
    
    *Deprecated Since: 19.3.3**
    *SCIM++ Properties:** - multiValued: false - mutability: readWrite - required: false - returned: default - type: integer
    
    Parameters:
    
    idcsDeprecatedSinceVersion - the value to set
    
    Returns:
    
    this builder
  - idcsAddedSinceVersion
```
public SchemaSubAttributes.Builder idcsAddedSinceVersion(Integer idcsAddedSinceVersion)
```
    Indicates that the schema has been added since version
    
    *Deprecated Since: 19.3.3**
    *SCIM++ Properties:** - multiValued: false - mutability: readWrite - required: false - returned: default - type: integer
    
    Parameters:
    
    idcsAddedSinceVersion - the value to set
    
    Returns:
    
    this builder
  - idcsDeprecatedSinceReleaseNumber
```
public SchemaSubAttributes.Builder idcsDeprecatedSinceReleaseNumber(String idcsDeprecatedSinceReleaseNumber)
```
    Indicates that the schema has been deprecated since this release number
    
    *Added In:** 17.3.4
    *SCIM++ Properties:** - multiValued: false - mutability: readWrite - required: false - returned: default - type: string
    
    Parameters:
    
    idcsDeprecatedSinceReleaseNumber - the value to set
    
    Returns:
    
    this builder
  - idcsAddedSinceReleaseNumber
```
public SchemaSubAttributes.Builder idcsAddedSinceReleaseNumber(String idcsAddedSinceReleaseNumber)
```
    Indicates that the schema has been added since this release number
    
    *Added In:** 17.3.4
    *SCIM++ Properties:** - multiValued: false - mutability: readWrite - required: false - returned: default - type: string
    
    Parameters:
    
    idcsAddedSinceReleaseNumber - the value to set
    
    Returns:
    
    this builder
  - idcsMinLength
```
public SchemaSubAttributes.Builder idcsMinLength(Integer idcsMinLength)
```
    Specifies the minimum length of this attribute
    
    *SCIM++ Properties:** - multiValued: false - mutability: readWrite - required: false - returned: default - type: integer
    
    Parameters:
    
    idcsMinLength - the value to set
    
    Returns:
    
    this builder
  - idcsMaxLength
```
public SchemaSubAttributes.Builder idcsMaxLength(Integer idcsMaxLength)
```
    Specifies the maximum length of this attribute
    
    *SCIM++ Properties:** - multiValued: false - mutability: readWrite - required: false - returned: default - type: integer
    
    Parameters:
    
    idcsMaxLength - the value to set
    
    Returns:
    
    this builder
  - idcsMinValue
```
public SchemaSubAttributes.Builder idcsMinValue(Integer idcsMinValue)
```
    Specifies the minimum value of the integer attribute
    
    *SCIM++ Properties:** - multiValued: false - mutability: readOnly - required: false - returned: default - type: integer
    
    Parameters:
    
    idcsMinValue - the value to set
    
    Returns:
    
    this builder
  - idcsMaxValue
```
public SchemaSubAttributes.Builder idcsMaxValue(Integer idcsMaxValue)
```
    Specifies the maximum value of the integer attribute
    
    *SCIM++ Properties:** - multiValued: false - mutability: readOnly - required: false - returned: default - type: integer
    
    Parameters:
    
    idcsMaxValue - the value to set
    
    Returns:
    
    this builder
  - idcsOnlyOneValueCanBeTrue
```
public SchemaSubAttributes.Builder idcsOnlyOneValueCanBeTrue(Boolean idcsOnlyOneValueCanBeTrue)
```
    If true, specifies that the sub attribute value can be set to true on one and only one instance of the CMVA.
    
    *SCIM++ Properties:** - caseExact: true - multiValued: false - mutability: readOnly - required: false - returned: default - type: boolean - uniqueness: none
    
    Parameters:
    
    idcsOnlyOneValueCanBeTrue - the value to set
    
    Returns:
    
    this builder
  - idcsMaxValuesReturned
```
public SchemaSubAttributes.Builder idcsMaxValuesReturned(Integer idcsMaxValuesReturned)
```
    SCIM++ Properties: - caseExact: true - multiValued: false - mutability: readOnly - required: false - returned: default - type: integer - uniqueness: none Specify a limit on the number of attribute-values that any caller will receive when requesting a CMVA attribute. If the no of CMVA instances exceeds the limit then Oracle Identity Cloud Service will throw exception. Users can choose to refine the filter on CMVA attribute.
    
    Parameters:
    
    idcsMaxValuesReturned - the value to set
    
    Returns:
    
    this builder
  - idcsOneValueMustBeTrue
```
public SchemaSubAttributes.Builder idcsOneValueMustBeTrue(Boolean idcsOneValueMustBeTrue)
```
    If true, ARM will ensure atleast one of the instances of CMVA has the attribute value set to true.
    
    *SCIM++ Properties:** - caseExact: true - multiValued: false - mutability: readOnly - required: false - returned: default - type: boolean - uniqueness: none
    
    Parameters:
    
    idcsOneValueMustBeTrue - the value to set
    
    Returns:
    
    this builder
  - idcsRefResourceAttributes
```
public SchemaSubAttributes.Builder idcsRefResourceAttributes(List<String> idcsRefResourceAttributes)
```
    Specifies the directly referenced Resources
    
    *SCIM++ Properties:** - multiValued: true - mutability: readWrite - required: false - returned: default - type: string
    
    Parameters:
    
    idcsRefResourceAttributes - the value to set
    
    Returns:
    
    this builder
  - idcsIndirectRefResourceAttributes
```
public SchemaSubAttributes.Builder idcsIndirectRefResourceAttributes(List<String> idcsIndirectRefResourceAttributes)
```
    Specifies the indirectly referenced Resources
    
    *SCIM++ Properties:** - multiValued: true - mutability: readWrite - required: false - returned: default - type: string
    
    Parameters:
    
    idcsIndirectRefResourceAttributes - the value to set
    
    Returns:
    
    this builder
  - idcsValuePersisted
```
public SchemaSubAttributes.Builder idcsValuePersisted(Boolean idcsValuePersisted)
```
    Specifies whether the sub-attribute of the Resource attribute is persisted
    
    *SCIM++ Properties:** - multiValued: false - mutability: readWrite - required: false - returned: default - type: boolean
    
    Parameters:
    
    idcsValuePersisted - the value to set
    
    Returns:
    
    this builder
  - idcsSensitive
```
public SchemaSubAttributes.Builder idcsSensitive(SchemaSubAttributes.IdcsSensitive idcsSensitive)
```
    Specifiees if the attribute should be encrypted or hashed
    
    *SCIM++ Properties:** - caseExact: true - multiValued: false - mutability: readWrite - required: false - returned: default - type: string - uniqueness: none
    
    Parameters:
    
    idcsSensitive - the value to set
    
    Returns:
    
    this builder
  - idcsTrimStringValue
```
public SchemaSubAttributes.Builder idcsTrimStringValue(Boolean idcsTrimStringValue)
```
    Trims any leading and trailing blanks from String values. Default is True.
    
    *SCIM++ Properties:** - multiValued: false - mutability: readOnly - required: false - returned: default - type: boolean
    
    Parameters:
    
    idcsTrimStringValue - the value to set
    
    Returns:
    
    this builder
  - idcsSearchable
```
public SchemaSubAttributes.Builder idcsSearchable(Boolean idcsSearchable)
```
    Specifies whether this attribute can be included in a search filter
    
    *SCIM++ Properties:** - multiValued: false - mutability: readWrite - required: false - returned: default - type: boolean
    
    Parameters:
    
    idcsSearchable - the value to set
    
    Returns:
    
    this builder
  - idcsGenerated
```
public SchemaSubAttributes.Builder idcsGenerated(Boolean idcsGenerated)
```
    Specifies whether this attribute value was generated
    
    *SCIM++ Properties:** - multiValued: false - mutability: readWrite - required: false - returned: default - type: boolean
    
    Parameters:
    
    idcsGenerated - the value to set
    
    Returns:
    
    this builder
  - idcsAuditable
```
public SchemaSubAttributes.Builder idcsAuditable(Boolean idcsAuditable)
```
    Specifies whether changes to this attribute value will be audited
    
    *SCIM++ Properties:** - multiValued: false - mutability: readWrite - required: false - returned: default - type: boolean
    
    Parameters:
    
    idcsAuditable - the value to set
    
    Returns:
    
    this builder
  - idcsTargetAttributeName
```
public SchemaSubAttributes.Builder idcsTargetAttributeName(String idcsTargetAttributeName)
```
    Target attribute name that this attribute gets mapped to for persistence
    
    *SCIM++ Properties:** - caseExact: true - multiValued: false - mutability: readWrite - required: false - returned: default - type: string - uniqueness: none
    
    Parameters:
    
    idcsTargetAttributeName - the value to set
    
    Returns:
    
    this builder
  - idcsTargetNormAttributeName
```
public SchemaSubAttributes.Builder idcsTargetNormAttributeName(String idcsTargetNormAttributeName)
```
    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: readWrite - required: false - returned: default - type: string - uniqueness: none
    
    Parameters:
    
    idcsTargetNormAttributeName - the value to set
    
    Returns:
    
    this builder
  - idcsTargetAttributeNameToMigrateFrom
```
public SchemaSubAttributes.Builder idcsTargetAttributeNameToMigrateFrom(String idcsTargetAttributeNameToMigrateFrom)
```
    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.2.1
    *SCIM++ Properties:** - caseExact: true - multiValued: false - mutability: readWrite - required: false - returned: default - type: string - uniqueness: none
    
    Parameters:
    
    idcsTargetAttributeNameToMigrateFrom - the value to set
    
    Returns:
    
    this builder
  - idcsTargetUniqueConstraintName
```
public SchemaSubAttributes.Builder idcsTargetUniqueConstraintName(String idcsTargetUniqueConstraintName)
```
    Target index name created for this attribute for performance
    
    *SCIM++ Properties:** - caseExact: true - multiValued: false - mutability: readOnly - required: false - returned: default - type: string - uniqueness: none
    
    Parameters:
    
    idcsTargetUniqueConstraintName - the value to set
    
    Returns:
    
    this builder
  - idcsToTargetMapper
```
public SchemaSubAttributes.Builder idcsToTargetMapper(String idcsToTargetMapper)
```
    Specifies the mapper to use when mapping this attribute value to DataProvider-specific semantics
    
    *SCIM++ Properties:** - caseExact: true - multiValued: false - mutability: readWrite - required: false - returned: default - type: string - uniqueness: none
    
    Parameters:
    
    idcsToTargetMapper - the value to set
    
    Returns:
    
    this builder
  - idcsFromTargetMapper
```
public SchemaSubAttributes.Builder idcsFromTargetMapper(String idcsFromTargetMapper)
```
    Specifies the mapper to use when mapping this attribute value from DataProvider-specific semantics
    
    *SCIM++ Properties:** - caseExact: true - multiValued: false - mutability: readWrite - required: false - returned: default - type: string - uniqueness: none
    
    Parameters:
    
    idcsFromTargetMapper - the value to set
    
    Returns:
    
    this builder
  - idcsDisplayName
```
public SchemaSubAttributes.Builder idcsDisplayName(String idcsDisplayName)
```
    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 - type: string - uniqueness: none
    
    Parameters:
    
    idcsDisplayName - the value to set
    
    Returns:
    
    this builder
  - idcsCanonicalValueSourceResourceType
```
public SchemaSubAttributes.Builder idcsCanonicalValueSourceResourceType(String idcsCanonicalValueSourceResourceType)
```
    Specifies the Resource type to read from for dynamic canonical values
    
    *SCIM++ Properties:** - caseExact: true - multiValued: false - mutability: readWrite - required: false - returned: default - type: string - uniqueness: none
    
    Parameters:
    
    idcsCanonicalValueSourceResourceType - the value to set
    
    Returns:
    
    this builder
  - idcsCanonicalValueSourceFilter
```
public SchemaSubAttributes.Builder idcsCanonicalValueSourceFilter(String idcsCanonicalValueSourceFilter)
```
    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
    
    Parameters:
    
    idcsCanonicalValueSourceFilter - the value to set
    
    Returns:
    
    this builder
  - idcsCanonicalValueSourceResourceTypeID
```
public SchemaSubAttributes.Builder idcsCanonicalValueSourceResourceTypeID(String idcsCanonicalValueSourceResourceTypeID)
```
    Specifies the Resource type ID to read from for dynamic canonical values
    
    *Added In:** 17.4.4
    *SCIM++ Properties:** - caseExact: true - multiValued: false - mutability: readWrite - required: false - returned: default - type: string - uniqueness: none
    
    Parameters:
    
    idcsCanonicalValueSourceResourceTypeID - the value to set
    
    Returns:
    
    this builder
  - idcsCanonicalValueSourceDisplayAttrName
```
public SchemaSubAttributes.Builder idcsCanonicalValueSourceDisplayAttrName(String idcsCanonicalValueSourceDisplayAttrName)
```
    Display name for the canonical value attribute name.
    
    *Added In:** 17.4.4
    *SCIM++ Properties:** - caseExact: false - idcsSearchable: false - multiValued: false - mutability: readWrite - required: false - returned: default - type: string - uniqueness: none
    
    Parameters:
    
    idcsCanonicalValueSourceDisplayAttrName - the value to set
    
    Returns:
    
    this builder
  - idcsCanonicalValueSourceKeyAttrName
```
public SchemaSubAttributes.Builder idcsCanonicalValueSourceKeyAttrName(String idcsCanonicalValueSourceKeyAttrName)
```
    Source key attribute for the canonical value.
    
    *Added In:** 17.4.4
    *SCIM++ Properties:** - caseExact: true - multiValued: false - mutability: readWrite - required: false - returned: default - type: string - uniqueness: none
    
    Parameters:
    
    idcsCanonicalValueSourceKeyAttrName - the value to set
    
    Returns:
    
    this builder
  - idcsValidateReference
```
public SchemaSubAttributes.Builder idcsValidateReference(Boolean idcsValidateReference)
```
    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
    
    Parameters:
    
    idcsValidateReference - the value to set
    
    Returns:
    
    this builder
  - idcsScimCompliant
```
public SchemaSubAttributes.Builder idcsScimCompliant(Boolean idcsScimCompliant)
```
    Indicates if the attribute is scim compliant, default is true
    
    *SCIM++ Properties:** - multiValued: false - mutability: readOnly - required: false - returned: default - type: boolean
    
    Parameters:
    
    idcsScimCompliant - the value to set
    
    Returns:
    
    this builder
  - idcsAttributeMappable
```
public SchemaSubAttributes.Builder idcsAttributeMappable(Boolean idcsAttributeMappable)
```
    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 - returned: default - type: boolean
    
    Parameters:
    
    idcsAttributeMappable - the value to set
    
    Returns:
    
    this builder
  - idcsAttributeCacheable
```
public SchemaSubAttributes.Builder idcsAttributeCacheable(Boolean idcsAttributeCacheable)
```
    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 - required: false - returned: default - type: boolean
    
    Parameters:
    
    idcsAttributeCacheable - the value to set
    
    Returns:
    
    this builder
  - idcsuiOrder
```
public SchemaSubAttributes.Builder idcsuiOrder(Integer idcsuiOrder)
```
    Metadata used by Oracle Identity Cloud Service UI to sequence the attributes displayed on the Account Form.
    
    *Added In:** 17.4.2
    *SCIM++ Properties:** - multiValued: false - mutability: readWrite - required: false - returned: default - type: integer
    
    Parameters:
    
    idcsuiOrder - the value to set
    
    Returns:
    
    this builder
  - idcsuiRegexp
```
public SchemaSubAttributes.Builder idcsuiRegexp(String idcsuiRegexp)
```
    Metadata used by Oracle Identity Cloud Service UI to validate the attribute values using regular expressions.
    
    *Added In:** 17.4.2
    *SCIM++ Properties:** - multiValued: false - mutability: readWrite - required: false - returned: default - type: string
    
    Parameters:
    
    idcsuiRegexp - the value to set
    
    Returns:
    
    this builder
  - idcsuiVisible
```
public SchemaSubAttributes.Builder idcsuiVisible(Boolean idcsuiVisible)
```
    Metadata used by Oracle Identity Cloud Service UI to decide whether the attribute must be displayed on the Account Form.
    
    *Added In:** 17.4.2
    *SCIM++ Properties:** - multiValued: false - mutability: readWrite - required: false - returned: default - type: boolean
    
    Parameters:
    
    idcsuiVisible - the value to set
    
    Returns:
    
    this builder
  - idcsuiWidget
```
public SchemaSubAttributes.Builder idcsuiWidget(SchemaSubAttributes.IdcsuiWidget idcsuiWidget)
```
    Metadata used by Oracle Identity Cloud Service UI to render a widget for this attribute on the Account Form.
    
    *Added In:** 17.4.2
    *SCIM++ Properties:** - multiValued: false - mutability: readWrite - required: false - returned: default - type: string
    
    Parameters:
    
    idcsuiWidget - the value to set
    
    Returns:
    
    this builder
  - idcsValuePersistedInOtherAttribute
```
public SchemaSubAttributes.Builder idcsValuePersistedInOtherAttribute(Boolean idcsValuePersistedInOtherAttribute)
```
    If true, ARM should not validate the value of the attribute since it will be converted/migrated to another attribute internally by the manager which will build valid post, put, or patch payload, depending on the client requested operation
    
    *Added In:** 18.2.2
    *SCIM++ Properties:** - multiValued: false - mutability: readWrite - required: false - returned: default - type: boolean
    
    Parameters:
    
    idcsValuePersistedInOtherAttribute - the value to set
    
    Returns:
    
    this builder
  - idcsPii
```
public SchemaSubAttributes.Builder idcsPii(Boolean idcsPii)
```
    Specifies whether the attribute is PII (personal information). False by default for all attributes. If attribute with idcsPii = true, it’s value must be obfuscated before it’s written to the Oracle Identity Cloud Service system logs.
    
    *Added In:** 18.3.6
    *SCIM++ Properties:** - multiValued: false - mutability: readOnly - required: false - returned: default - type: boolean
    
    Parameters:
    
    idcsPii - the value to set
    
    Returns:
    
    this builder
  - idcsSanitize
```
public SchemaSubAttributes.Builder idcsSanitize(Boolean idcsSanitize)
```
    Specifies if the value of the attribute should be sanitized using OWASP library for HTML content
    
    *Added In:** 20.1.3
    *SCIM++ Properties:** - caseExact: true - multiValued: false - mutability: readWrite - required: false - returned: default - type: boolean - uniqueness: none
    
    Parameters:
    
    idcsSanitize - the value to set
    
    Returns:
    
    this builder
  - idcsExcludeFromUpgradePatch
```
public SchemaSubAttributes.Builder idcsExcludeFromUpgradePatch(Boolean idcsExcludeFromUpgradePatch)
```
    Specifies whether the attribute should be excluded from the BulkApi patch generated by gradle task for upgrading OOTB resources.
    
    *Added In:** 2104150946
    *SCIM++ Properties:** - multiValued: false - mutability: readWrite - required: false - returned: never - type: boolean
    
    Parameters:
    
    idcsExcludeFromUpgradePatch - the value to set
    
    Returns:
    
    this builder
  - build
```
public SchemaSubAttributes build()
```
  - copy
```
public SchemaSubAttributes.Builder copy(SchemaSubAttributes model)
```

Class SchemaSubAttributes.Builder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Builder

Method Detail

name

idcsRequiresImmediateReadAfterWriteForAccessFlows

idcsRequiresWriteForAccessFlows

idcsDisplayNameMessageId

idcsRtsaHideAttribute

idcsInternal

type

multiValued

description

required

idcsReturnEmptyWhenNull

canonicalValues

idcsDefaultValue

caseExact

mutability

returned

idcsCsvAttributeName

uniqueness

referenceTypes

idcsDeprecatedSinceVersion

idcsAddedSinceVersion

idcsDeprecatedSinceReleaseNumber

idcsAddedSinceReleaseNumber

idcsMinLength

idcsMaxLength

idcsMinValue

idcsMaxValue

idcsOnlyOneValueCanBeTrue

idcsMaxValuesReturned

idcsOneValueMustBeTrue

idcsRefResourceAttributes

idcsIndirectRefResourceAttributes

idcsValuePersisted

idcsSensitive

idcsTrimStringValue

idcsSearchable

idcsGenerated

idcsAuditable

idcsTargetAttributeName

idcsTargetNormAttributeName

idcsTargetAttributeNameToMigrateFrom

idcsTargetUniqueConstraintName

idcsToTargetMapper

idcsFromTargetMapper

idcsDisplayName

idcsCanonicalValueSourceResourceType

idcsCanonicalValueSourceFilter

idcsCanonicalValueSourceResourceTypeID

idcsCanonicalValueSourceDisplayAttrName

idcsCanonicalValueSourceKeyAttrName

idcsValidateReference

idcsScimCompliant

idcsAttributeMappable

idcsAttributeCacheable

idcsuiOrder

idcsuiRegexp

idcsuiVisible

idcsuiWidget

idcsValuePersistedInOtherAttribute

idcsPii

idcsSanitize

idcsExcludeFromUpgradePatch

build

copy