Package software.amazon.smithy.aws.traits.clientendpointdiscovery

Class ClientEndpointDiscoveryTrait.Builder

java.lang.Object

software.amazon.smithy.model.traits.AbstractTraitBuilder<ClientEndpointDiscoveryTrait,ClientEndpointDiscoveryTrait.Builder>

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

All Implemented Interfaces:

software.amazon.smithy.utils.SmithyBuilder<ClientEndpointDiscoveryTrait>

Enclosing class:

ClientEndpointDiscoveryTrait

public static final class ClientEndpointDiscoveryTrait.Builder
extends software.amazon.smithy.model.traits.AbstractTraitBuilder<ClientEndpointDiscoveryTrait,ClientEndpointDiscoveryTrait.Builder>

Builder for ClientEndpointDiscoveryTrait.

Method Summary

Modifier and Type	Method	Description
ClientEndpointDiscoveryTrait	build()
ClientEndpointDiscoveryTrait.Builder	error(software.amazon.smithy.model.shapes.ShapeId error)	Set the error shape which indicates to a client that an endpoint they are using is no longer valid.
ClientEndpointDiscoveryTrait.Builder	operation(software.amazon.smithy.model.shapes.ShapeId operation)	Set the operation used to discover endpoints for the service.

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

getSourceLocation, sourceLocation

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

build

public ClientEndpointDiscoveryTrait build()

operation

public ClientEndpointDiscoveryTrait.Builder operation(software.amazon.smithy.model.shapes.ShapeId operation)

Set the operation used to discover endpoints for the service.

The operation MUST be bound to the service.

Parameters:

operation - The ShapeId of the operation used to discover endpoints.

Returns:

Returns the builder.

error

public ClientEndpointDiscoveryTrait.Builder error(software.amazon.smithy.model.shapes.ShapeId error)

Set 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.

Parameters:

error - The ShapeId of the invalid endpoint error.

Returns:

Returns the builder.