AppRole.Builder (Oracle Cloud Infrastructure Java SDK

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

Enclosing class:: AppRole

public static class AppRole.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
`AppRole.Builder`	`adminRole(Boolean adminRole)` If true, the role provides administrative access privileges.
`AppRole.Builder`	`app(AppRoleApp app)`
`AppRole.Builder`	`availableToClients(Boolean availableToClients)` If true, this AppRole can be granted to Apps.
`AppRole.Builder`	`availableToGroups(Boolean availableToGroups)` If true, this AppRole can be granted to Groups.
`AppRole.Builder`	`availableToUsers(Boolean availableToUsers)` If true, this AppRole can be granted to Users.
`AppRole`	`build()`
`AppRole.Builder`	`compartmentOcid(String compartmentOcid)` OCI Compartment Id (ocid) in which the resource lives.
`AppRole.Builder`	`copy(AppRole model)`
`AppRole.Builder`	`deleteInProgress(Boolean deleteInProgress)` A boolean flag indicating this resource in the process of being deleted.
`AppRole.Builder`	`description(String description)` AppRole description
`AppRole.Builder`	`displayName(String displayName)` AppRole name
`AppRole.Builder`	`domainOcid(String domainOcid)` OCI Domain Id (ocid) in which the resource lives.
`AppRole.Builder`	`id(String id)` Unique identifier for the SCIM Resource as defined by the Service Provider.
`AppRole.Builder`	`idcsCreatedBy(IdcsCreatedBy idcsCreatedBy)`
`AppRole.Builder`	`idcsLastModifiedBy(IdcsLastModifiedBy idcsLastModifiedBy)`
`AppRole.Builder`	`idcsLastUpgradedInRelease(String idcsLastUpgradedInRelease)` The release number when the resource was upgraded.
`AppRole.Builder`	`idcsPreventedOperations(List<IdcsPreventedOperations> idcsPreventedOperations)` Each value of this attribute specifies an operation that only an internal client may perform on this particular resource.
`AppRole.Builder`	`isPublic(Boolean isPublic)` If true, this AppRole is available automatically to every Oracle Identity Cloud Service User in this tenancy.
`AppRole.Builder`	`legacyGroupName(String legacyGroupName)` The name of the legacy group associated with this AppRole.
`AppRole.Builder`	`limitedToOneOrMoreGroups(Boolean limitedToOneOrMoreGroups)` If true, indicates that this Oracle Identity Cloud Service AppRole can be granted to a delegated administrator whose scope is limited to users that are members of one or more groups.
`AppRole.Builder`	`localizedDisplayName(String localizedDisplayName)` AppRole localization name
`AppRole.Builder`	`members(List<AppRoleMembers> members)` AppRole members - when requesting members attribute, it is recommended to use startIndex and count to return members in pages instead of in a single response, eg : #attributes=members[startIndex=1%26count=10]
`AppRole.Builder`	`meta(Meta meta)`
`AppRole.Builder`	`ocid(String ocid)` Unique OCI identifier for the SCIM Resource.
`AppRole.Builder`	`schemas(List<String> schemas)` REQUIRED.
`AppRole.Builder`	`tags(List<Tags> tags)` A list of tags on this resource.
`AppRole.Builder`	`tenancyOcid(String tenancyOcid)` OCI Tenant Id (ocid) in which the resource lives.
`AppRole.Builder`	`uniqueName(String uniqueName)` AppRole unique name

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
  - id
```
public AppRole.Builder id(String id)
```
    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
    
    Parameters:
    
    id - the value to set
    
    Returns:
    
    this builder
  - ocid
```
public AppRole.Builder ocid(String ocid)
```
    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
    
    Parameters:
    
    ocid - the value to set
    
    Returns:
    
    this builder
  - schemas
```
public AppRole.Builder schemas(List<String> schemas)
```
    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
    
    Parameters:
    
    schemas - the value to set
    
    Returns:
    
    this builder
  - meta
```
public AppRole.Builder meta(Meta meta)
```
  - idcsCreatedBy
```
public AppRole.Builder idcsCreatedBy(IdcsCreatedBy idcsCreatedBy)
```
  - idcsLastModifiedBy
```
public AppRole.Builder idcsLastModifiedBy(IdcsLastModifiedBy idcsLastModifiedBy)
```
  - idcsPreventedOperations
```
public AppRole.Builder idcsPreventedOperations(List<IdcsPreventedOperations> idcsPreventedOperations)
```
    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
    
    Parameters:
    
    idcsPreventedOperations - the value to set
    
    Returns:
    
    this builder
  - tags
```
public AppRole.Builder tags(List<Tags> 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
    
    Parameters:
    
    tags - the value to set
    
    Returns:
    
    this builder
  - deleteInProgress
```
public AppRole.Builder deleteInProgress(Boolean deleteInProgress)
```
    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
    
    Parameters:
    
    deleteInProgress - the value to set
    
    Returns:
    
    this builder
  - idcsLastUpgradedInRelease
```
public AppRole.Builder idcsLastUpgradedInRelease(String idcsLastUpgradedInRelease)
```
    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
    
    Parameters:
    
    idcsLastUpgradedInRelease - the value to set
    
    Returns:
    
    this builder
  - domainOcid
```
public AppRole.Builder domainOcid(String domainOcid)
```
    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
    
    Parameters:
    
    domainOcid - the value to set
    
    Returns:
    
    this builder
  - compartmentOcid
```
public AppRole.Builder compartmentOcid(String compartmentOcid)
```
    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
    
    Parameters:
    
    compartmentOcid - the value to set
    
    Returns:
    
    this builder
  - tenancyOcid
```
public AppRole.Builder tenancyOcid(String tenancyOcid)
```
    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
    
    Parameters:
    
    tenancyOcid - the value to set
    
    Returns:
    
    this builder
  - displayName
```
public AppRole.Builder displayName(String displayName)
```
    AppRole name
    
    *SCIM++ Properties:** - caseExact: false - idcsCsvAttributeName: Display Name - idcsCsvAttributeNameMappings: [[columnHeaderName:Entitlement Value]] - idcsSearchable: true - multiValued: false - mutability: immutable - required: true - returned: always - type: string - uniqueness: none
    
    Parameters:
    
    displayName - the value to set
    
    Returns:
    
    this builder
  - uniqueName
```
public AppRole.Builder uniqueName(String uniqueName)
```
    AppRole unique name
    
    *SCIM++ Properties:** - idcsSearchable: false - multiValued: false - mutability: readOnly - required: false - returned: always - type: string - uniqueness: server
    
    Parameters:
    
    uniqueName - the value to set
    
    Returns:
    
    this builder
  - description
```
public AppRole.Builder description(String description)
```
    AppRole description
    
    *SCIM++ Properties:** - caseExact: false - idcsSearchable: true - multiValued: false - mutability: readWrite - required: false - returned: default - type: string - uniqueness: none
    
    Parameters:
    
    description - the value to set
    
    Returns:
    
    this builder
  - legacyGroupName
```
public AppRole.Builder legacyGroupName(String legacyGroupName)
```
    The name of the legacy group associated with this AppRole.
    
    *SCIM++ Properties:** - caseExact: false - idcsSearchable: true - multiValued: false - mutability: immutable - required: false - returned: default - type: string - uniqueness: server
    
    Parameters:
    
    legacyGroupName - the value to set
    
    Returns:
    
    this builder
  - adminRole
```
public AppRole.Builder adminRole(Boolean adminRole)
```
    If true, the role provides administrative access privileges.
    
    *SCIM++ Properties:** - idcsSearchable: true - multiValued: false - mutability: immutable - required: false - returned: default - type: boolean - uniqueness: none
    
    Parameters:
    
    adminRole - the value to set
    
    Returns:
    
    this builder
  - limitedToOneOrMoreGroups
```
public AppRole.Builder limitedToOneOrMoreGroups(Boolean limitedToOneOrMoreGroups)
```
    If true, indicates that this Oracle Identity Cloud Service AppRole can be granted to a delegated administrator whose scope is limited to users that are members of one or more groups.
    
    *Added In:** 19.2.1
    *SCIM++ Properties:** - idcsSearchable: false - multiValued: false - mutability: readOnly - required: false - returned: default - type: boolean - uniqueness: none
    
    Parameters:
    
    limitedToOneOrMoreGroups - the value to set
    
    Returns:
    
    this builder
  - availableToUsers
```
public AppRole.Builder availableToUsers(Boolean availableToUsers)
```
    If true, this AppRole can be granted to Users.
    
    *SCIM++ Properties:** - idcsSearchable: true - multiValued: false - mutability: immutable - required: false - returned: default - type: boolean - uniqueness: none
    
    Parameters:
    
    availableToUsers - the value to set
    
    Returns:
    
    this builder
  - availableToGroups
```
public AppRole.Builder availableToGroups(Boolean availableToGroups)
```
    If true, this AppRole can be granted to Groups.
    
    *SCIM++ Properties:** - idcsSearchable: true - multiValued: false - mutability: immutable - required: false - returned: default - type: boolean - uniqueness: none
    
    Parameters:
    
    availableToGroups - the value to set
    
    Returns:
    
    this builder
  - availableToClients
```
public AppRole.Builder availableToClients(Boolean availableToClients)
```
    If true, this AppRole can be granted to Apps.
    
    *SCIM++ Properties:** - idcsSearchable: true - multiValued: false - mutability: immutable - required: false - returned: default - type: boolean - uniqueness: none
    
    Parameters:
    
    availableToClients - the value to set
    
    Returns:
    
    this builder
  - isPublic
```
public AppRole.Builder isPublic(Boolean isPublic)
```
    If true, this AppRole is available automatically to every Oracle Identity Cloud Service User in this tenancy. There is no need to grant it to individual Users or Groups.
    
    *SCIM++ Properties:** - idcsSearchable: true - multiValued: false - mutability: readWrite - required: false - returned: default - type: boolean - uniqueness: none
    
    Parameters:
    
    isPublic - the value to set
    
    Returns:
    
    this builder
  - localizedDisplayName
```
public AppRole.Builder localizedDisplayName(String localizedDisplayName)
```
    AppRole localization name
    
    *Added In:** 2109090424
    *SCIM++ Properties:** - caseExact: false - idcsSearchable: false - multiValued: false - mutability: readOnly - required: false - returned: request - type: string - uniqueness: none
    
    Parameters:
    
    localizedDisplayName - the value to set
    
    Returns:
    
    this builder
  - app
```
public AppRole.Builder app(AppRoleApp app)
```
  - members
```
public AppRole.Builder members(List<AppRoleMembers> members)
```
    AppRole members - when requesting members attribute, it is recommended to use startIndex and count to return members in pages instead of in a single response, eg : #attributes=members[startIndex=1%26count=10]
    
    *SCIM++ Properties:** - idcsCompositeKey: [value, type] - idcsCsvAttributeNameMappings: [[columnHeaderName:Grantee Name, mapsTo:members.value], [columnHeaderName:Grantee Type, mapsTo:members.type]] - idcsSearchable: true - multiValued: true - mutability: readOnly - required: false - returned: request - idcsPaginateResponse: true - type: complex - uniqueness: none
    
    Parameters:
    
    members - the value to set
    
    Returns:
    
    this builder
  - build
```
public AppRole build()
```
  - copy
```
public AppRole.Builder copy(AppRole model)
```

Class AppRole.Builder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Builder

Method Detail

id

ocid

schemas

meta

idcsCreatedBy

idcsLastModifiedBy

idcsPreventedOperations

tags

deleteInProgress

idcsLastUpgradedInRelease

domainOcid

compartmentOcid

tenancyOcid

displayName

uniqueName

description

legacyGroupName

adminRole

limitedToOneOrMoreGroups

availableToUsers

availableToGroups

availableToClients

isPublic

localizedDisplayName

app

members

build

copy