Package com.oracle.bmc.functions.model

Class Function.Builder

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

    • Constructor Detail

      • Builder

        public Builder()

    • Method Detail

      • id

        public Function.Builder id​(String id)
        The OCID of the function.
        Parameters:
        id - the value to set
        Returns:
        this builder

      • displayName

        public Function.Builder displayName​(String displayName)
        The display name of the function.

        The display name is unique within the application containing the function.

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

      • lifecycleState

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

      • applicationId

        public Function.Builder applicationId​(String applicationId)
        The OCID of the application the function belongs to.
        Parameters:
        applicationId - the value to set
        Returns:
        this builder

      • compartmentId

        public Function.Builder compartmentId​(String compartmentId)
        The OCID of the compartment that contains the function.
        Parameters:
        compartmentId - the value to set
        Returns:
        this builder

      • image

        public Function.Builder image​(String image)
        The qualified name of the Docker image to use in the function, including the image tag.

        The image should be in the OCI Registry that is in the same region as the function itself. Example: phx.ocir.io/ten/functions/function:0.0.1

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

      • imageDigest

        public Function.Builder imageDigest​(String imageDigest)
        The image digest for the version of the image that will be pulled when invoking this function.

        If no value is specified, the digest currently associated with the image in the OCI Registry will be used. Example: sha256:ca0eeb6fb05351dfc8759c20733c91def84cb8007aa89a5bf606bc8b315b9fc7

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

      • shape

        public Function.Builder shape​(Function.Shape shape)
        The processor shape (GENERIC_X86/GENERIC_ARM) on which to run functions in the application, extracted from the image manifest.
        Parameters:
        shape - the value to set
        Returns:
        this builder

      • memoryInMBs

        public Function.Builder memoryInMBs​(Long memoryInMBs)
        Maximum usable memory for the function (MiB).
        Parameters:
        memoryInMBs - the value to set
        Returns:
        this builder

      • config

        public Function.Builder config​(Map<String,​String> config)
        Function configuration.

        Overrides application configuration. Keys must be ASCII strings consisting solely of letters, digits, and the ‘_’ (underscore) character, and must not begin with a digit. Values should be limited to printable unicode characters.

        Example: {"MY_FUNCTION_CONFIG": "ConfVal"}

        The maximum size for all configuration keys and values is limited to 4KB. This is measured as the sum of octets necessary to represent each key and value in UTF-8.

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

      • timeoutInSeconds

        public Function.Builder timeoutInSeconds​(Integer timeoutInSeconds)
        Timeout for executions of the function.

        Value in seconds.

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

      • detachedModeTimeoutInSeconds

        public Function.Builder detachedModeTimeoutInSeconds​(Integer detachedModeTimeoutInSeconds)
        Timeout for detached function invocations.

        Value in seconds.

        Example: {"detachedModeTimeoutInSeconds": 900}

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

      • freeformTags

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

      • invokeEndpoint

        public Function.Builder invokeEndpoint​(String invokeEndpoint)
        The base https invoke URL to set on a client in order to invoke a function.

        This URL will never change over the lifetime of the function and can be cached.

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

      • definedTags

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

      • timeCreated

        public Function.Builder timeCreated​(Date timeCreated)
        The time the function was created, expressed in RFC 3339 timestamp format.

        Example: 2018-09-12T22:47:12.613Z

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

      • timeUpdated

        public Function.Builder timeUpdated​(Date timeUpdated)
        The time the function was updated, expressed in RFC 3339 timestamp format.

        Example: 2018-09-12T22:47:12.613Z

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