Class ApiKey.Builder

  • Enclosing class:
    ApiKey

    public static class ApiKey.Builder
    extends Object
    • Constructor Detail

      • Builder

        public Builder()
    • Method Detail

      • keyId

        public ApiKey.Builder keyId​(String keyId)
        An Oracle-assigned identifier for the key, in this format: TENANCY_OCID/USER_OCID/KEY_FINGERPRINT.
        Parameters:
        keyId - the value to set
        Returns:
        this builder
      • keyValue

        public ApiKey.Builder keyValue​(String keyValue)
        The key’s value.
        Parameters:
        keyValue - the value to set
        Returns:
        this builder
      • fingerprint

        public ApiKey.Builder fingerprint​(String fingerprint)
        The key’s fingerprint (e.g., 12:34:56:78:90:ab:cd:ef:12:34:56:78:90:ab:cd:ef).
        Parameters:
        fingerprint - the value to set
        Returns:
        this builder
      • userId

        public ApiKey.Builder userId​(String userId)
        The OCID of the user the key belongs to.
        Parameters:
        userId - the value to set
        Returns:
        this builder
      • timeCreated

        public ApiKey.Builder timeCreated​(Date timeCreated)
        Date and time the ApiKey object was created, in the format defined by RFC3339.

        Example: 2016-08-25T21:10:29.600Z

        Parameters:
        timeCreated - the value to set
        Returns:
        this builder
      • lifecycleState

        public ApiKey.Builder lifecycleState​(ApiKey.LifecycleState lifecycleState)
        The API key’s current state.

        After creating an ApiKey object, make sure its lifecycleState changes from CREATING to ACTIVE before using it.

        Parameters:
        lifecycleState - the value to set
        Returns:
        this builder
      • inactiveStatus

        public ApiKey.Builder inactiveStatus​(Long inactiveStatus)
        The detailed status of INACTIVE lifecycleState.
        Parameters:
        inactiveStatus - the value to set
        Returns:
        this builder
      • build

        public ApiKey build()