Package com.oracle.bmc.generativeai.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)
        the ApiKey id.
        Parameters:
        id - the value to set
        Returns:
        this builder

      • displayName

        public ApiKey.Builder displayName​(String displayName)
        A user-friendly name.

        Does not have to be unique, and it’s changeable.

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

      • description

        public ApiKey.Builder description​(String description)
        An optional description of the Api key.
        Parameters:
        description - the value to set
        Returns:
        this builder

      • compartmentId

        public ApiKey.Builder compartmentId​(String compartmentId)
        The compartment OCID to create the apiKey in.
        Parameters:
        compartmentId - the value to set
        Returns:
        this builder

      • timeCreated

        public ApiKey.Builder timeCreated​(Date timeCreated)
        The date and time that the ApiKey was created in the format of an RFC3339 datetime string.
        Parameters:
        timeCreated - the value to set
        Returns:
        this builder

      • timeUpdated

        public ApiKey.Builder timeUpdated​(Date timeUpdated)
        The date and time the ApiKey was updated, in the format defined by RFC 3339.
        Parameters:
        timeUpdated - the value to set
        Returns:
        this builder

      • lifecycleState

        public ApiKey.Builder lifecycleState​(ApiKey.LifecycleState lifecycleState)
        The current state of the API key.
        Parameters:
        lifecycleState - the value to set
        Returns:
        this builder

      • lifecycleDetails

        public ApiKey.Builder lifecycleDetails​(String lifecycleDetails)
        A message describing the current state with detail that can provide actionable information.
        Parameters:
        lifecycleDetails - the value to set
        Returns:
        this builder

      • freeformTags

        public ApiKey.Builder freeformTags​(Map<String,​String> freeformTags)
        Free-form tags for this resource.

        Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.

        Example: {"Department": "Finance"}

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

      • definedTags

        public ApiKey.Builder definedTags​(Map<String,​Map<String,​Object>> definedTags)
        Defined tags for this resource.

        Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

        Example: {"Operations": {"CostCenter": "42"}}

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

      • systemTags

        public ApiKey.Builder systemTags​(Map<String,​Map<String,​Object>> systemTags)
        System tags for this resource.

        Each key is predefined and scoped to a namespace.

        Example: {"orcl-cloud": {"free-tier-retained": "true"}}

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

      • build

        public ApiKey build()