software.amazon.smithy.model.traits

Class HttpChecksumTrait

java.lang.Object

software.amazon.smithy.model.traits.AbstractTrait

software.amazon.smithy.model.traits.HttpChecksumTrait

All Implemented Interfaces:

FromSourceLocation, ToNode, ToShapeId, Trait, software.amazon.smithy.utils.ToSmithyBuilder<HttpChecksumTrait>

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

Indicates that an operation supports checksum validation. Contains request and response members that define the checksum behavior for operations HTTP Request and HTTP Response respectively.

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
static ShapeId	ID

Method Summary

Modifier and Type	Method and Description
static HttpChecksumTrait.Builder	builder()
protected Node	createNode() The result of toNode is used for hashCodes and equality.
java.util.Set<java.lang.String>	getRequestAlgorithms() Gets supported algorithms for request property defined within the HttpChecksum trait.
java.util.List<HttpChecksumProperty>	getRequestProperties() Gets request property defined within the HttpChecksum trait.
java.util.List<HttpChecksumProperty>	getRequestPropertiesForAlgorithm(java.lang.String algorithm) Gets checksum properties associated with the provided algorithm on request.
java.util.Set<java.lang.String>	getResponseAlgorithms() Gets supported algorithms for response property defined within the HttpChecksum trait.
java.util.List<HttpChecksumProperty>	getResponseProperties() Gets response property defined within the HttpChecksum trait.
java.util.List<HttpChecksumProperty>	getResponsePropertiesForAlgorithm(java.lang.String algorithm) Gets checksum properties associated with the provided algorithm on response.
software.amazon.smithy.utils.SmithyBuilder<HttpChecksumTrait>	toBuilder()

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

equals, getSourceLocation, hashCode, 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

flatMapStream, getIdiomaticTraitName, getIdiomaticTraitName, makeAbsoluteName, makeAbsoluteName

Field Detail

ID

public static final ShapeId ID

Method Detail

builder

public static HttpChecksumTrait.Builder builder()

toBuilder

public software.amazon.smithy.utils.SmithyBuilder<HttpChecksumTrait> toBuilder()

Specified by:

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

getRequestProperties

public java.util.List<HttpChecksumProperty> getRequestProperties()

Gets request property defined within the HttpChecksum trait.

Returns:

Returns checksum properties for request.

getRequestAlgorithms

public java.util.Set<java.lang.String> getRequestAlgorithms()

Gets supported algorithms for request property defined within the HttpChecksum trait.

Returns:

Returns all supported algorithms for request.

getRequestPropertiesForAlgorithm

public java.util.List<HttpChecksumProperty> getRequestPropertiesForAlgorithm(java.lang.String algorithm)

Gets checksum properties associated with the provided algorithm on request. Returns an empty list if algorithm is not supported on request.

Parameters:

algorithm - the algorithm on request property.

Returns:

Returns an ordered list of HttpChecksumProperties.

getResponseProperties

public java.util.List<HttpChecksumProperty> getResponseProperties()

Gets response property defined within the HttpChecksum trait.

Returns:

Returns checksum properties for response.

getResponseAlgorithms

public java.util.Set<java.lang.String> getResponseAlgorithms()

Gets supported algorithms for response property defined within the HttpChecksum trait.

Returns:

Returns all supported algorithms for response.

getResponsePropertiesForAlgorithm

public java.util.List<HttpChecksumProperty> getResponsePropertiesForAlgorithm(java.lang.String algorithm)

Gets checksum properties associated with the provided algorithm on response. Returns an empty list if algorithm is not supported on response.

Parameters:

algorithm - the supported algorithm on response.

Returns:

Returns an ordered list of HttpChecksumProperties.

createNode

protected Node createNode()

Description copied from class: AbstractTrait

The result of toNode is used for hashCodes and equality. Subclasses must implement createNode to turn the trait into a Node. This is then cached for subsequent retrievals.

Specified by:

createNode in class AbstractTrait

Returns:

Returns the trait as a node.