Package software.amazon.smithy.aws.traits

Class HttpChecksumTrait

java.lang.Object

software.amazon.smithy.model.traits.AbstractTrait

software.amazon.smithy.aws.traits.HttpChecksumTrait

All Implemented Interfaces:

software.amazon.smithy.model.FromSourceLocation, software.amazon.smithy.model.node.ToNode, software.amazon.smithy.model.shapes.ToShapeId, software.amazon.smithy.model.traits.Trait, software.amazon.smithy.utils.ToSmithyBuilder<HttpChecksumTrait>

public final class HttpChecksumTrait
extends software.amazon.smithy.model.traits.AbstractTrait
implements software.amazon.smithy.utils.ToSmithyBuilder<HttpChecksumTrait>

Indicates that an operation supports checksum validation.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	HttpChecksumTrait.Builder
static final class	HttpChecksumTrait.Provider

Field Summary

Fields

Modifier and Type	Field	Description
static final List<String>	CHECKSUM_ALGORITHMS
static final String	CHECKSUM_PREFIX
static final software.amazon.smithy.model.shapes.ShapeId	ID
static final String	REQUEST_ALGORITHM_MEMBER
static final String	REQUEST_CHECKSUM_REQUIRED
static final String	REQUEST_VALIDATION_MODE_MEMBER
static final String	RESPONSE_ALGORITHMS
static final List<String>	VALIDATION_MODES

Method Summary

Modifier and Type	Method	Description
static HttpChecksumTrait.Builder	builder()
protected software.amazon.smithy.model.node.Node	createNode()
static String	getChecksumLocationName(String checksumAlgorithm)	Gets the normalized location name for a checksum algorithm.
Optional<String>	getRequestAlgorithmMember()	Optionally gets name of the input member used to specify which request checksum to send.
Optional<String>	getRequestValidationModeMember()	Optionally gets name of the input member used to specify opt-in behavior for response checksum validation.
List<String>	getResponseAlgorithms()	Gets list of checksum algorithms for which checksum values when present in HTTP response should be validated.
boolean	isRequestChecksumRequired()	Returns true if request requires checksum to be present.
HttpChecksumTrait.Builder	toBuilder()

Methods inherited from class software.amazon.smithy.model.traits.AbstractTrait

equals, getSourceLocation, hashCode, setNodeCache, toNode, toShapeId, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.smithy.model.traits.Trait

isSynthetic

Field Details

ID

public static final software.amazon.smithy.model.shapes.ShapeId ID

CHECKSUM_PREFIX

public static final String CHECKSUM_PREFIX

See Also:

• Constant Field Values

CHECKSUM_ALGORITHMS

public static final List<String> CHECKSUM_ALGORITHMS

VALIDATION_MODES

public static final List<String> VALIDATION_MODES

REQUEST_CHECKSUM_REQUIRED

public static final String REQUEST_CHECKSUM_REQUIRED

See Also:

• Constant Field Values

REQUEST_ALGORITHM_MEMBER

public static final String REQUEST_ALGORITHM_MEMBER

See Also:

• Constant Field Values

REQUEST_VALIDATION_MODE_MEMBER

public static final String REQUEST_VALIDATION_MODE_MEMBER

See Also:

• Constant Field Values

RESPONSE_ALGORITHMS

public static final String RESPONSE_ALGORITHMS

See Also:

• Constant Field Values

Method Details

builder

public static HttpChecksumTrait.Builder builder()

toBuilder

public HttpChecksumTrait.Builder toBuilder()

Specified by:

toBuilder in interface software.amazon.smithy.utils.ToSmithyBuilder<HttpChecksumTrait>

isRequestChecksumRequired

public boolean isRequestChecksumRequired()

Returns true if request requires checksum to be present.

Returns:

Returns if checksum is required.

getRequestAlgorithmMember

public Optional<String> getRequestAlgorithmMember()

Optionally gets name of the input member used to specify which request checksum to send.

Returns:

Returns optional input member name.

getResponseAlgorithms

public List<String> getResponseAlgorithms()

Gets list of checksum algorithms for which checksum values when present in HTTP response should be validated.

Returns:

Returns checksum properties for response.

getRequestValidationModeMember

public Optional<String> getRequestValidationModeMember()

Optionally gets name of the input member used to specify opt-in behavior for response checksum validation.

Returns:

Returns optional input member name.

getChecksumLocationName

public static String getChecksumLocationName(String checksumAlgorithm)

Gets the normalized location name for a checksum algorithm.

Parameters:

checksumAlgorithm - The algorithm to get a location name of.

Returns:

The normalized location name.

createNode

protected software.amazon.smithy.model.node.Node createNode()

Specified by:

createNode in class software.amazon.smithy.model.traits.AbstractTrait