Package software.amazon.smithy.openapi.model

Class ExternalDocumentation

java.lang.Object

software.amazon.smithy.openapi.model.Component

software.amazon.smithy.openapi.model.ExternalDocumentation

All Implemented Interfaces:

Comparable<ExternalDocumentation>, ToNode, ToSmithyBuilder<ExternalDocumentation>

public final class ExternalDocumentation
extends Component
implements ToSmithyBuilder<ExternalDocumentation>, Comparable<ExternalDocumentation>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	ExternalDocumentation.Builder

Method Summary

Modifier and Type	Method	Description
static ExternalDocumentation.Builder	builder()
int	compareTo(ExternalDocumentation that)
protected ObjectNode.Builder	createNodeBuilder()
Optional<String>	getDescription()
String	getUrl()
ExternalDocumentation.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.openapi.model.Component

equals, getExtension, getExtensions, hashCode, toNode

Methods inherited from class java.lang.Object

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

Method Details

builder

public static ExternalDocumentation.Builder builder()

getDescription

public Optional<String> getDescription()

getUrl

public String getUrl()

toBuilder

public ExternalDocumentation.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<ExternalDocumentation>

Returns:

a builder for type T

createNodeBuilder

protected ObjectNode.Builder createNodeBuilder()

Specified by:

createNodeBuilder in class Component

compareTo

public int compareTo(ExternalDocumentation that)

Specified by:

compareTo in interface Comparable<ExternalDocumentation>