Package com.oracle.bmc.identitydomains.model

Class ApiKey.Builder

  • Enclosing class:
    ApiKey
    public static class ApiKey.Builder
extends Object

    • Constructor Detail

      • Builder

        public Builder()

    • Method Detail

      • id

        public ApiKey.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 ApiKey.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 ApiKey.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

      • idcsPreventedOperations

        public ApiKey.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 ApiKey.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 ApiKey.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 ApiKey.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 ApiKey.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 ApiKey.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 ApiKey.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

      • description

        public ApiKey.Builder description​(String description)
        Description

        *Added In:** 2101262133

        *SCIM++ Properties:** - caseExact: false - type: string - mutability: readWrite - required: false - returned: default

        Parameters:
        description - the value to set
        Returns:
        this builder

      • fingerprint

        public ApiKey.Builder fingerprint​(String fingerprint)
        Fingerprint

        *Added In:** 2010242156

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

        Parameters:
        fingerprint - the value to set
        Returns:
        this builder

      • key

        public ApiKey.Builder key​(String key)
        Key

        *Added In:** 2010242156

        *SCIM++ Properties:** - caseExact: true - idcsPii: true - type: string - mutability: immutable - required: true - returned: default

        Parameters:
        key - the value to set
        Returns:
        this builder

      • urnIetfParamsScimSchemasOracleIdcsExtensionSelfChangeUser

        public ApiKey.Builder urnIetfParamsScimSchemasOracleIdcsExtensionSelfChangeUser​(ExtensionSelfChangeUser urnIetfParamsScimSchemasOracleIdcsExtensionSelfChangeUser)

      • build

        public ApiKey build()