Package com.oracle.bmc.functions.model

Class Function

  • @Generated(value="OracleSDKGenerator",
           comments="API Version: 20181201")
public final class Function
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
    A function resource defines the code (Docker image) and configuration for a specific function.

    Functions are defined in applications. Avoid entering confidential information.
    Note: Objects should always be created or deserialized using the Function.Builder. This model distinguishes fields that are null because they are unset from fields that are explicitly set to null. This is done in the setter methods of the Function.Builder, which maintain a set of all explicitly set fields called Function.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set fields into account. The constructor, on the other hand, does not take the explicitly set fields into account (since the constructor cannot distinguish explicit null from unset null).

    • Method Detail

      • getId

        public String getId()
        The OCID of the function.
        Returns:
        the value

      • getDisplayName

        public String getDisplayName()
        The display name of the function.

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

        Returns:
        the value

      • getLifecycleState

        public Function.LifecycleState getLifecycleState()
        The current state of the function.
        Returns:
        the value

      • getApplicationId

        public String getApplicationId()
        The OCID of the application the function belongs to.
        Returns:
        the value

      • getCompartmentId

        public String getCompartmentId()
        The OCID of the compartment that contains the function.
        Returns:
        the value

      • getImage

        public String getImage()
        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

        Returns:
        the value

      • getImageDigest

        public String getImageDigest()
        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

        Returns:
        the value

      • getShape

        public Function.Shape getShape()
        The processor shape (GENERIC_X86/GENERIC_ARM) on which to run functions in the application, extracted from the image manifest.
        Returns:
        the value

      • getMemoryInMBs

        public Long getMemoryInMBs()
        Maximum usable memory for the function (MiB).
        Returns:
        the value

      • getConfig

        public Map<String,​String> getConfig()
        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.

        Returns:
        the value

      • getTimeoutInSeconds

        public Integer getTimeoutInSeconds()
        Timeout for executions of the function.

        Value in seconds.

        Returns:
        the value

      • getFreeformTags

        public Map<String,​String> getFreeformTags()
        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"}

        Returns:
        the value

      • getInvokeEndpoint

        public String getInvokeEndpoint()
        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.

        Returns:
        the value

      • getDefinedTags

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

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

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

        Returns:
        the value

      • getTimeCreated

        public Date getTimeCreated()
        The time the function was created, expressed in RFC 3339 timestamp format.

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

        Returns:
        the value

      • getTimeUpdated

        public Date getTimeUpdated()
        The time the function was updated, expressed in RFC 3339 timestamp format.

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

        Returns:
        the value

      • toString

        public String toString()
        Overrides:
        toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

      • toString

        public String toString​(boolean includeByteArrayContents)
        Return a string representation of the object.
        Parameters:
        includeByteArrayContents - true to include the full contents of byte arrays
        Returns:
        string representation

      • equals

        public boolean equals​(Object o)
        Overrides:
        equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel