Package software.amazon.awssdk.services.cloudfront.model

Class TestResult

java.lang.Object

software.amazon.awssdk.services.cloudfront.model.TestResult

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<TestResult.Builder,TestResult>

@Generated("software.amazon.awssdk:codegen")
public final class TestResult
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<TestResult.Builder,TestResult>

Contains the result of testing a CloudFront function with TestFunction.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	TestResult.Builder

Method Summary

Modifier and Type	Method	Description
static TestResult.Builder	builder()
String	computeUtilization()	The amount of time that the function took to run as a percentage of the maximum allowed time.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	functionErrorMessage()	If the result of testing the function was an error, this field contains the error message.
List<String>	functionExecutionLogs()	Contains the log lines that the function wrote (if any) when running the test.
String	functionOutput()	The event object returned by the function.
FunctionSummary	functionSummary()	Contains configuration information and metadata about the CloudFront function that was tested.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasFunctionExecutionLogs()	For responses, this returns true if the service returned a value for the FunctionExecutionLogs property.
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends TestResult.Builder>	serializableBuilderClass()
TestResult.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

functionSummary

public final FunctionSummary functionSummary()

Contains configuration information and metadata about the CloudFront function that was tested.

Returns:

Contains configuration information and metadata about the CloudFront function that was tested.

computeUtilization

public final String computeUtilization()

The amount of time that the function took to run as a percentage of the maximum allowed time. For example, a compute utilization of 35 means that the function completed in 35% of the maximum allowed time.

Returns:

The amount of time that the function took to run as a percentage of the maximum allowed time. For example, a compute utilization of 35 means that the function completed in 35% of the maximum allowed time.

hasFunctionExecutionLogs

public final boolean hasFunctionExecutionLogs()

For responses, this returns true if the service returned a value for the FunctionExecutionLogs property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

functionExecutionLogs

public final List<String> functionExecutionLogs()

Contains the log lines that the function wrote (if any) when running the test.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasFunctionExecutionLogs() method.

Returns:

Contains the log lines that the function wrote (if any) when running the test.

functionErrorMessage

public final String functionErrorMessage()

If the result of testing the function was an error, this field contains the error message.

Returns:

If the result of testing the function was an error, this field contains the error message.

functionOutput

public final String functionOutput()

The event object returned by the function. For more information about the structure of the event object, see Event object structure in the Amazon CloudFront Developer Guide.

Returns:

The event object returned by the function. For more information about the structure of the event object, see Event object structure in the Amazon CloudFront Developer Guide.

toBuilder

public TestResult.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<TestResult.Builder,TestResult>

builder

public static TestResult.Builder builder()

serializableBuilderClass

public static Class<? extends TestResult.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo