Package software.amazon.smithy.model.shapes

Class OperationShape

java.lang.Object

software.amazon.smithy.model.shapes.Shape

software.amazon.smithy.model.shapes.OperationShape

All Implemented Interfaces:

java.lang.Comparable<Shape>, FromSourceLocation, ToShapeId, software.amazon.smithy.utils.Tagged, software.amazon.smithy.utils.ToSmithyBuilder<OperationShape>

public final class OperationShape
extends Shape
implements software.amazon.smithy.utils.ToSmithyBuilder<OperationShape>

Represents an API operation.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	OperationShape.Builder	Builder used to create a OperationShape.

Method Summary

Modifier and Type	Method	Description
<R> R	accept(ShapeVisitor<R> cases)	Dispatches the shape to the appropriate ShapeVisitor method.
java.util.Optional<OperationShape>	asOperationShape()
static OperationShape.Builder	builder()
boolean	equals(java.lang.Object other)
java.util.List<ShapeId>	getErrors()	Gets a list of the error shape IDs that can be encountered.
java.util.Optional<ShapeId>	getInput()	Gets the optional shape ID of the input of the operation.
java.util.Optional<ShapeId>	getOutput()	Gets the optional shape ID of the output of the operation.
OperationShape.Builder	toBuilder()

Methods inherited from class software.amazon.smithy.model.shapes.Shape

asBigDecimalShape, asBigIntegerShape, asBlobShape, asBooleanShape, asByteShape, asDocumentShape, asDoubleShape, asFloatShape, asIntegerShape, asListShape, asLongShape, asMapShape, asMemberShape, asResourceShape, asServiceShape, asSetShape, asShortShape, asStringShape, asStructureShape, asTimestampShape, asUnionShape, compareTo, expectTrait, findMemberTrait, findMemberTrait, findTrait, findTrait, getAllTraits, getId, getMemberTrait, getMemberTrait, getSourceLocation, getTags, getTrait, getType, hashCode, hasTrait, hasTrait, hasTrait, isBigDecimalShape, isBigIntegerShape, isBlobShape, isBooleanShape, isByteShape, isDocumentShape, isDoubleShape, isFloatShape, isIntegerShape, isListShape, isLongShape, isMapShape, isMemberShape, isOperationShape, isResourceShape, isServiceShape, isSetShape, isShortShape, isStringShape, isStructureShape, isTimestampShape, isUnionShape, members, shapeToBuilder, toShapeId, toString, visitor

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.smithy.utils.Tagged

hasTag

Method Detail

builder

public static OperationShape.Builder builder()

toBuilder

public OperationShape.Builder toBuilder()

Specified by:

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

accept

public <R> R accept(ShapeVisitor<R> cases)

Description copied from class: Shape

Dispatches the shape to the appropriate ShapeVisitor method.

Specified by:

accept in class Shape

Type Parameters:

R - Return type of the accept.

Parameters:

cases - NeighborVisitor to use.

Returns:

Returns the result.

asOperationShape

public java.util.Optional<OperationShape> asOperationShape()

Overrides:

asOperationShape in class Shape

Returns:

Optionally returns the shape as an OperationShape.

getInput

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

Gets the optional shape ID of the input of the operation.

Returns:

Returns the optional shape ID.

getOutput

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

Gets the optional shape ID of the output of the operation.

Returns:

Returns the optional shape ID.

getErrors

public java.util.List<ShapeId> getErrors()

Gets a list of the error shape IDs that can be encountered.

Each returned ShapeId must resolve to a StructureShape that is targeted by an error trait; however, this is only guaranteed after a model is validated.

Returns:

Returns the errors.

equals

public boolean equals(java.lang.Object other)

Overrides:

equals in class Shape