com.oracle.bmc.functions.model

Class CreateFunctionDetails

java.lang.Object

com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

com.oracle.bmc.functions.model.CreateFunctionDetails

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20181201")
public final class CreateFunctionDetails
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

Properties to create a new function.
Note: Objects should always be created or deserialized using the CreateFunctionDetails.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 CreateFunctionDetails.Builder, which maintain a set of all explicitly set fields called CreateFunctionDetails.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).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CreateFunctionDetails.Builder

Field Summary

Fields inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME

Constructor Summary

Constructors

Constructor and Description
CreateFunctionDetails(String displayName, String applicationId, String image, String imageDigest, FunctionSourceDetails sourceDetails, Long memoryInMBs, Map<String,String> config, Integer timeoutInSeconds, FunctionProvisionedConcurrencyConfig provisionedConcurrencyConfig, FunctionTraceConfig traceConfig, Map<String,String> freeformTags, Map<String,Map<String,Object>> definedTags) Deprecated.

Method Summary

Modifier and Type	Method and Description
static CreateFunctionDetails.Builder	builder() Create a new builder.
boolean	equals(Object o)
String	getApplicationId() The OCID of the application this function belongs to.
Map<String,String>	getConfig() Function configuration.
Map<String,Map<String,Object>>	getDefinedTags() Defined tags for this resource.
String	getDisplayName() The display name of the function.
Map<String,String>	getFreeformTags() Free-form tags for this resource.
String	getImage() The qualified name of the Docker image to use in the function, including the image tag.
String	getImageDigest() The image digest for the version of the image that will be pulled when invoking this function.
Long	getMemoryInMBs() Maximum usable memory for the function (MiB).
FunctionProvisionedConcurrencyConfig	getProvisionedConcurrencyConfig()
FunctionSourceDetails	getSourceDetails()
Integer	getTimeoutInSeconds() Timeout for executions of the function.
FunctionTraceConfig	getTraceConfig()
int	hashCode()
CreateFunctionDetails.Builder	toBuilder()
String	toString()
String	toString(boolean includeByteArrayContents) Return a string representation of the object.

Methods inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

markPropertyAsExplicitlySet, wasPropertyExplicitlySet

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateFunctionDetails

@Deprecated
 @ConstructorProperties(value={"displayName","applicationId","image","imageDigest","sourceDetails","memoryInMBs","config","timeoutInSeconds","provisionedConcurrencyConfig","traceConfig","freeformTags","definedTags"})
public CreateFunctionDetails(String displayName,
                                                                                                                                                                                                                                                                  String applicationId,
                                                                                                                                                                                                                                                                  String image,
                                                                                                                                                                                                                                                                  String imageDigest,
                                                                                                                                                                                                                                                                  FunctionSourceDetails sourceDetails,
                                                                                                                                                                                                                                                                  Long memoryInMBs,
                                                                                                                                                                                                                                                                  Map<String,String> config,
                                                                                                                                                                                                                                                                  Integer timeoutInSeconds,
                                                                                                                                                                                                                                                                  FunctionProvisionedConcurrencyConfig provisionedConcurrencyConfig,
                                                                                                                                                                                                                                                                  FunctionTraceConfig traceConfig,
                                                                                                                                                                                                                                                                  Map<String,String> freeformTags,
                                                                                                                                                                                                                                                                  Map<String,Map<String,Object>> definedTags)

Deprecated.

Method Detail

builder

public static CreateFunctionDetails.Builder builder()

Create a new builder.

toBuilder

public CreateFunctionDetails.Builder toBuilder()

getDisplayName

public String getDisplayName()

The display name of the function. The display name must be unique within the application containing the function. Avoid entering confidential information.

Returns:

the value

getApplicationId

public String getApplicationId()

The OCID of the application this function belongs to.

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

getSourceDetails

public FunctionSourceDetails getSourceDetails()

getMemoryInMBs

public Long getMemoryInMBs()

Maximum usable memory for the function (MiB).

Returns:

the value

getConfig

public Map<String,String> getConfig()

Function configuration. These values are passed on to the function as environment variables, this overrides application configuration values. 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

getProvisionedConcurrencyConfig

public FunctionProvisionedConcurrencyConfig getProvisionedConcurrencyConfig()

getTraceConfig

public FunctionTraceConfig getTraceConfig()

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

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

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