Class FunctionSummary
- java.lang.Object
-
- com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
-
- com.oracle.bmc.functions.model.FunctionSummary
-
@Generated(value="OracleSDKGenerator", comments="API Version: 20181201") public final class FunctionSummary extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
Summary of a function.
Note: Objects should always be created or deserialized using theFunctionSummary.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 theFunctionSummary.Builder
, which maintain a set of all explicitly set fields calledFunctionSummary.Builder.__explicitlySet__
. ThehashCode()
andequals(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 Description static class
FunctionSummary.Builder
static class
FunctionSummary.Shape
The processor shape (GENERIC_X86/GENERIC_ARM) on which to run functions in the application, extracted from the image manifest.
-
Constructor Summary
Constructors Constructor Description FunctionSummary(String id, String displayName, String applicationId, String compartmentId, Function.LifecycleState lifecycleState, String image, String imageDigest, FunctionSourceDetails sourceDetails, FunctionSummary.Shape shape, Long memoryInMBs, Integer timeoutInSeconds, FunctionProvisionedConcurrencyConfig provisionedConcurrencyConfig, FunctionTraceConfig traceConfig, Map<String,String> freeformTags, String invokeEndpoint, Map<String,Map<String,Object>> definedTags, Date timeCreated, Date timeUpdated)
Deprecated.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static FunctionSummary.Builder
builder()
Create a new builder.boolean
equals(Object o)
String
getApplicationId()
The OCID of the application the function belongs to.String
getCompartmentId()
The OCID of the compartment that contains the function.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
getId()
The OCID of the function.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.String
getInvokeEndpoint()
The base https invoke URL to set on a client in order to invoke a function.Function.LifecycleState
getLifecycleState()
The current state of the function.Long
getMemoryInMBs()
Maximum usable memory for the function (MiB).FunctionProvisionedConcurrencyConfig
getProvisionedConcurrencyConfig()
FunctionSummary.Shape
getShape()
The processor shape (GENERIC_X86/GENERIC_ARM) on which to run functions in the application, extracted from the image manifest.FunctionSourceDetails
getSourceDetails()
Date
getTimeCreated()
The time the function was created, expressed in RFC 3339 timestamp format.Integer
getTimeoutInSeconds()
Timeout for executions of the function.Date
getTimeUpdated()
The time the function was updated, expressed in RFC 3339 timestamp format.FunctionTraceConfig
getTraceConfig()
int
hashCode()
FunctionSummary.Builder
toBuilder()
String
toString()
String
toString(boolean includeByteArrayContents)
Return a string representation of the object.
-
-
-
Constructor Detail
-
FunctionSummary
@Deprecated @ConstructorProperties({"id","displayName","applicationId","compartmentId","lifecycleState","image","imageDigest","sourceDetails","shape","memoryInMBs","timeoutInSeconds","provisionedConcurrencyConfig","traceConfig","freeformTags","invokeEndpoint","definedTags","timeCreated","timeUpdated"}) public FunctionSummary(String id, String displayName, String applicationId, String compartmentId, Function.LifecycleState lifecycleState, String image, String imageDigest, FunctionSourceDetails sourceDetails, FunctionSummary.Shape shape, Long memoryInMBs, Integer timeoutInSeconds, FunctionProvisionedConcurrencyConfig provisionedConcurrencyConfig, FunctionTraceConfig traceConfig, Map<String,String> freeformTags, String invokeEndpoint, Map<String,Map<String,Object>> definedTags, Date timeCreated, Date timeUpdated)
Deprecated.
-
-
Method Detail
-
builder
public static FunctionSummary.Builder builder()
Create a new builder.
-
toBuilder
public FunctionSummary.Builder toBuilder()
-
getDisplayName
public String getDisplayName()
The display name of the function.The display name is unique within the application containing 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
-
getLifecycleState
public Function.LifecycleState getLifecycleState()
The current state of 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
-
getSourceDetails
public FunctionSourceDetails getSourceDetails()
-
getShape
public FunctionSummary.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
-
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
-
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 classcom.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 classcom.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classcom.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
-
-