Package software.amazon.awssdk.services.bedrockagentruntime.model

Class CodeInterpreterInvocationOutput

java.lang.Object

software.amazon.awssdk.services.bedrockagentruntime.model.CodeInterpreterInvocationOutput

All Implemented Interfaces:

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

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

Contains the JSON-formatted string returned by the API invoked by the code interpreter.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CodeInterpreterInvocationOutput.Builder

Method Summary

Modifier and Type	Method	Description
static CodeInterpreterInvocationOutput.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	executionError()	Contains the error returned from code execution.
String	executionOutput()	Contains the successful output returned from code execution
Boolean	executionTimeout()	Indicates if the execution of the code timed out.
List<String>	files()	Contains output files, if generated by code execution.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasFiles()	For responses, this returns true if the service returned a value for the Files property.
int	hashCode()
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends CodeInterpreterInvocationOutput.Builder>	serializableBuilderClass()
CodeInterpreterInvocationOutput.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

executionError

public final String executionError()

Contains the error returned from code execution.

Returns:

Contains the error returned from code execution.

executionOutput

public final String executionOutput()

Contains the successful output returned from code execution

Returns:

Contains the successful output returned from code execution

executionTimeout

public final Boolean executionTimeout()

Indicates if the execution of the code timed out.

Returns:

Indicates if the execution of the code timed out.

hasFiles

public final boolean hasFiles()

For responses, this returns true if the service returned a value for the Files 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.

files

public final List<String> files()

Contains output files, if generated by code execution.

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 hasFiles() method.

Returns:

Contains output files, if generated by code execution.

toBuilder

public CodeInterpreterInvocationOutput.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CodeInterpreterInvocationOutput.Builder,CodeInterpreterInvocationOutput>

builder

public static CodeInterpreterInvocationOutput.Builder builder()

serializableBuilderClass

public static Class<? extends CodeInterpreterInvocationOutput.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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo