Class ExecutionAttributes

java.lang.Object

software.amazon.awssdk.core.interceptor.ExecutionAttributes

All Implemented Interfaces:

ToCopyableBuilder<ExecutionAttributes.Builder,ExecutionAttributes>

@NotThreadSafe
public class ExecutionAttributes
extends Object
implements ToCopyableBuilder<ExecutionAttributes.Builder,ExecutionAttributes>

A mutable collection of ExecutionAttributes that can be modified by ExecutionInterceptors in order to save and retrieve information specific to the current execution. This is useful for sharing data between ExecutionInterceptor method calls specific to a particular execution.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	ExecutionAttributes.Builder	TODO: We should deprecate this builder - execution attributes are mutable - why do we need a builder? We can just use copy() if it's because of unmodifiableExecutionAttributes(ExecutionAttributes).

Constructor Summary

Constructors

Constructor	Description
ExecutionAttributes()

Method Summary

Modifier and Type	Method	Description
static ExecutionAttributes.Builder	builder()
ExecutionAttributes	copy()
boolean	equals(Object o)
<U> U	getAttribute(ExecutionAttribute<U> attribute)	Retrieve the current value of the provided attribute in this collection of attributes.
Map<ExecutionAttribute<?>,Object>	getAttributes()	Retrieve the collection of attributes.
<U> Optional<U>	getOptionalAttribute(ExecutionAttribute<U> attribute)	Retrieve the Optional current value of the provided attribute in this collection of attributes.
int	hashCode()
ExecutionAttributes	merge(ExecutionAttributes lowerPrecedenceExecutionAttributes)	Merge attributes of a higher precedence into the current lower precedence collection.
void	putAbsentAttributes(ExecutionAttributes lowerPrecedenceExecutionAttributes)	Add the provided attributes to this attribute, if the provided attribute does not exist.
<U> ExecutionAttributes	putAttribute(ExecutionAttribute<U> attribute, U value)	Update or set the provided attribute in this collection of attributes.
<U> ExecutionAttributes	putAttributeIfAbsent(ExecutionAttribute<U> attribute, U value)	Set the provided attribute in this collection of attributes if it does not already exist in the collection.
ExecutionAttributes.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
String	toString()
static ExecutionAttributes	unmodifiableExecutionAttributes(ExecutionAttributes attributes)

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Constructor Details

ExecutionAttributes

public ExecutionAttributes()

Method Details

getAttribute

public <U> U getAttribute(ExecutionAttribute<U> attribute)

Retrieve the current value of the provided attribute in this collection of attributes. This will return null if the value is not set.

getAttributes

public Map<ExecutionAttribute<?>,Object> getAttributes()

Retrieve the collection of attributes.

getOptionalAttribute

public <U> Optional<U> getOptionalAttribute(ExecutionAttribute<U> attribute)

Retrieve the Optional current value of the provided attribute in this collection of attributes. This will return Optional Value.

putAttribute

public <U> ExecutionAttributes putAttribute(ExecutionAttribute<U> attribute,
 U value)

Update or set the provided attribute in this collection of attributes.

putAttributeIfAbsent

public <U> ExecutionAttributes putAttributeIfAbsent(ExecutionAttribute<U> attribute,
 U value)

Set the provided attribute in this collection of attributes if it does not already exist in the collection.

merge

public ExecutionAttributes merge(ExecutionAttributes lowerPrecedenceExecutionAttributes)

Merge attributes of a higher precedence into the current lower precedence collection.

putAbsentAttributes

public void putAbsentAttributes(ExecutionAttributes lowerPrecedenceExecutionAttributes)

Add the provided attributes to this attribute, if the provided attribute does not exist.

builder

public static ExecutionAttributes.Builder builder()

toBuilder

public ExecutionAttributes.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<ExecutionAttributes.Builder,ExecutionAttributes>

Returns:

a builder for type T

copy

public ExecutionAttributes copy()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

unmodifiableExecutionAttributes

public static ExecutionAttributes unmodifiableExecutionAttributes(ExecutionAttributes attributes)