software.amazon.smithy.aws.traits.clientendpointdiscovery

Class ClientEndpointDiscoveryTrait

java.lang.Object

software.amazon.smithy.model.traits.AbstractTrait

software.amazon.smithy.aws.traits.clientendpointdiscovery.ClientEndpointDiscoveryTrait

All Implemented Interfaces:

FromSourceLocation, ToNode, ToShapeId, Trait, ToSmithyBuilder<ClientEndpointDiscoveryTrait>

public final class ClientEndpointDiscoveryTrait
extends AbstractTrait
implements ToSmithyBuilder<ClientEndpointDiscoveryTrait>

Configures endpoint discovery for the targeted service.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ClientEndpointDiscoveryTrait.Builder Builder for ClientEndpointDiscoveryTrait.
static class	ClientEndpointDiscoveryTrait.Provider

Field Summary

Fields

Modifier and Type	Field and Description
static ShapeId	ID

Constructor Summary

Constructors

Constructor and Description
ClientEndpointDiscoveryTrait(ClientEndpointDiscoveryTrait.Builder builder)

Method Summary

Modifier and Type	Method and Description
static ClientEndpointDiscoveryTrait.Builder	builder()
protected Node	createNode() The result of toNode is used for hashCodes and equality.
ShapeId	getError() Deprecated.
ShapeId	getOperation() The operation used to discover endpoints for the service.
java.util.Optional<ShapeId>	getOptionalError() The error shape which indicates to a client that an endpoint they are using is no longer valid.
ClientEndpointDiscoveryTrait.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.

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

flatMapStream, getIdiomaticTraitName, getIdiomaticTraitName, isSynthetic, makeAbsoluteName, makeAbsoluteName

Field Detail

ID

public static final ShapeId ID

Constructor Detail

ClientEndpointDiscoveryTrait

public ClientEndpointDiscoveryTrait(ClientEndpointDiscoveryTrait.Builder builder)

Method Detail

builder

public static ClientEndpointDiscoveryTrait.Builder builder()

Returns:

Returns a builder used to create ClientEndpointDiscoveryTrait

getOperation

public ShapeId getOperation()

The operation used to discover endpoints for the service.

The operation MUST be bound to the service.

Returns:

The ShapeId of the operation used to discover endpoints.

getOptionalError

public java.util.Optional<ShapeId> getOptionalError()

The error shape which indicates to a client that an endpoint they are using is no longer valid.

This error MUST be bound to every operation bound to the service which is marked with an ClientDiscoveredEndpointTrait.

Returns:

The ShapeId of the invalid endpoint error.

getError

@Deprecated
public ShapeId getError()

Deprecated.

Deprecated in favor of getOptionalError().

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.

toBuilder

public ClientEndpointDiscoveryTrait.Builder toBuilder()

Description copied from interface: ToSmithyBuilder

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

Specified by:

toBuilder in interface ToSmithyBuilder<ClientEndpointDiscoveryTrait>

Returns:

a builder for type T