traits

Documentation

Overview

Package traits defines representations of Smithy IDL traits that appear in code-generated schemas.

Index

• type AWSQueryCompatible
  • func (*AWSQueryCompatible) TraitID() smithy.ShapeID
• type AWSQueryError
  • func (*AWSQueryError) TraitID() smithy.ShapeID
  • func (*AWSQueryError) TraitIndex() int
• type ContextParam
  • func (*ContextParam) TraitID() smithy.ShapeID
  • func (*ContextParam) TraitIndex() int
• type EC2QueryName
  • func (*EC2QueryName) TraitID() smithy.ShapeID
  • func (*EC2QueryName) TraitIndex() int
• type EventHeader
  • func (*EventHeader) TraitID() smithy.ShapeID
  • func (*EventHeader) TraitIndex() int
• type EventPayload
  • func (*EventPayload) TraitID() smithy.ShapeID
  • func (*EventPayload) TraitIndex() int
• type HTTP
  • func (*HTTP) TraitID() smithy.ShapeID
  • func (*HTTP) TraitIndex() int
• type HTTPError
  • func (*HTTPError) TraitID() smithy.ShapeID
  • func (*HTTPError) TraitIndex() int
• type HTTPHeader
  • func (*HTTPHeader) TraitID() smithy.ShapeID
  • func (*HTTPHeader) TraitIndex() int
• type HTTPLabel
  • func (*HTTPLabel) TraitID() smithy.ShapeID
  • func (*HTTPLabel) TraitIndex() int
• type HTTPPayload
  • func (*HTTPPayload) TraitID() smithy.ShapeID
  • func (*HTTPPayload) TraitIndex() int
• type HTTPPrefixHeaders
  • func (*HTTPPrefixHeaders) TraitID() smithy.ShapeID
  • func (*HTTPPrefixHeaders) TraitIndex() int
• type HTTPQuery
  • func (*HTTPQuery) TraitID() smithy.ShapeID
  • func (*HTTPQuery) TraitIndex() int
• type HTTPQueryParams
  • func (*HTTPQueryParams) TraitID() smithy.ShapeID
  • func (*HTTPQueryParams) TraitIndex() int
• type HTTPResponseCode
  • func (*HTTPResponseCode) TraitID() smithy.ShapeID
  • func (*HTTPResponseCode) TraitIndex() int
• type HostLabel
  • func (*HostLabel) TraitID() smithy.ShapeID
  • func (*HostLabel) TraitIndex() int
• type JSONName
  • func (*JSONName) TraitID() smithy.ShapeID
  • func (*JSONName) TraitIndex() int
• type MediaType
  • func (*MediaType) TraitID() smithy.ShapeID
  • func (*MediaType) TraitIndex() int
• type Sensitive
  • func (*Sensitive) TraitID() smithy.ShapeID
  • func (*Sensitive) TraitIndex() int
• type Streaming
  • func (*Streaming) TraitID() smithy.ShapeID
  • func (*Streaming) TraitIndex() int
• type TimestampFormat
  • func (*TimestampFormat) TraitID() smithy.ShapeID
  • func (*TimestampFormat) TraitIndex() int
• type UnitShape
  • func (*UnitShape) TraitID() smithy.ShapeID
  • func (*UnitShape) TraitIndex() int
• type XMLAttribute
  • func (*XMLAttribute) TraitID() smithy.ShapeID
  • func (*XMLAttribute) TraitIndex() int
• type XMLFlattened
  • func (*XMLFlattened) TraitID() smithy.ShapeID
  • func (*XMLFlattened) TraitIndex() int
• type XMLName
  • func (*XMLName) TraitID() smithy.ShapeID
  • func (*XMLName) TraitIndex() int
• type XMLNamespace
  • func (*XMLNamespace) TraitID() smithy.ShapeID
  • func (*XMLNamespace) TraitIndex() int

Types

type AWSQueryCompatible

type AWSQueryCompatible struct{}

AWSQueryCompatible represents aws.protocols#awsQueryCompatible.

func (*AWSQueryCompatible) TraitID

func (*AWSQueryCompatible) TraitID() smithy.ShapeID

TraitID identifies the trait.

type AWSQueryError

type AWSQueryError struct {
	ErrorCode  string
	StatusCode int
}

AWSQueryError represents aws.protocols#awsQueryError.

func (*AWSQueryError) TraitID

func (*AWSQueryError) TraitID() smithy.ShapeID

TraitID identifies the trait.

func (*AWSQueryError) TraitIndex

func (*AWSQueryError) TraitIndex() int

TraitIndex implements smithy.IndexableTrait.

type ContextParam

type ContextParam struct{}

ContextParam represents smithy.rules#contextParam.

func (*ContextParam) TraitID

func (*ContextParam) TraitID() smithy.ShapeID

TraitID identifies the trait.

func (*ContextParam) TraitIndex

func (*ContextParam) TraitIndex() int

TraitIndex implements smithy.IndexableTrait.

type EC2QueryName

type EC2QueryName struct {
	Name string
}

EC2QueryName represents aws.protocols#ec2QueryName.

func (*EC2QueryName) TraitID

func (*EC2QueryName) TraitID() smithy.ShapeID

TraitID identifies the trait.

func (*EC2QueryName) TraitIndex

func (*EC2QueryName) TraitIndex() int

TraitIndex implements smithy.IndexableTrait.

type EventHeader

type EventHeader struct{}

EventHeader represents smithy.api#eventHeader.

func (*EventHeader) TraitID

func (*EventHeader) TraitID() smithy.ShapeID

TraitID identifies the trait.

func (*EventHeader) TraitIndex

func (*EventHeader) TraitIndex() int

TraitIndex implements smithy.IndexableTrait.

type EventPayload

type EventPayload struct{}

EventPayload represents smithy.api#eventPayload.

func (*EventPayload) TraitID

func (*EventPayload) TraitID() smithy.ShapeID

TraitID identifies the trait.

func (*EventPayload) TraitIndex

func (*EventPayload) TraitIndex() int

TraitIndex implements smithy.IndexableTrait.

type HTTP

type HTTP struct {
	Method string
	URI    string
	Code   int
}

HTTP represents smithy.api#http.

func (*HTTP) TraitID

func (*HTTP) TraitID() smithy.ShapeID

TraitID identifies the trait.

func (*HTTP) TraitIndex

func (*HTTP) TraitIndex() int

TraitIndex implements smithy.IndexableTrait.

type HTTPError

type HTTPError struct {
	Code int
}

HTTPError represents smithy.api#httpError.

func (*HTTPError) TraitID

func (*HTTPError) TraitID() smithy.ShapeID

TraitID identifies the trait.

func (*HTTPError) TraitIndex

func (*HTTPError) TraitIndex() int

TraitIndex implements smithy.IndexableTrait.

type HTTPHeader

type HTTPHeader struct {
	Name string
}

HTTPHeader represents smithy.api#httpHeader.

func (*HTTPHeader) TraitID

func (*HTTPHeader) TraitID() smithy.ShapeID

TraitID identifies the trait.

func (*HTTPHeader) TraitIndex

func (*HTTPHeader) TraitIndex() int

TraitIndex implements smithy.IndexableTrait.

type HTTPLabel

type HTTPLabel struct{}

HTTPLabel represents smithy.api#httpLabel.

func (*HTTPLabel) TraitID

func (*HTTPLabel) TraitID() smithy.ShapeID

TraitID identifies the trait.

func (*HTTPLabel) TraitIndex

func (*HTTPLabel) TraitIndex() int

TraitIndex implements smithy.IndexableTrait.

type HTTPPayload

type HTTPPayload struct{}

HTTPPayload represents smithy.api#httpPayload.

func (*HTTPPayload) TraitID

func (*HTTPPayload) TraitID() smithy.ShapeID

TraitID identifies the trait.

func (*HTTPPayload) TraitIndex

func (*HTTPPayload) TraitIndex() int

TraitIndex implements smithy.IndexableTrait.

type HTTPPrefixHeaders

type HTTPPrefixHeaders struct {
	Prefix string
}

HTTPPrefixHeaders represents smithy.api#httpPrefixHeaders.

func (*HTTPPrefixHeaders) TraitID

func (*HTTPPrefixHeaders) TraitID() smithy.ShapeID

TraitID identifies the trait.

func (*HTTPPrefixHeaders) TraitIndex

func (*HTTPPrefixHeaders) TraitIndex() int

TraitIndex implements smithy.IndexableTrait.

type HTTPQuery

type HTTPQuery struct {
	Name string
}

HTTPQuery represents smithy.api#httpQuery.

func (*HTTPQuery) TraitID

func (*HTTPQuery) TraitID() smithy.ShapeID

TraitID identifies the trait.

func (*HTTPQuery) TraitIndex

func (*HTTPQuery) TraitIndex() int

TraitIndex implements smithy.IndexableTrait.

type HTTPQueryParams

type HTTPQueryParams struct{}

HTTPQueryParams represents smithy.api#httpQueryParams.

func (*HTTPQueryParams) TraitID

func (*HTTPQueryParams) TraitID() smithy.ShapeID

TraitID identifies the trait.

func (*HTTPQueryParams) TraitIndex

func (*HTTPQueryParams) TraitIndex() int

TraitIndex implements smithy.IndexableTrait.

type HTTPResponseCode

type HTTPResponseCode struct{}

HTTPResponseCode represents smithy.api#httpResponseCode.

func (*HTTPResponseCode) TraitID

func (*HTTPResponseCode) TraitID() smithy.ShapeID

TraitID identifies the trait.

func (*HTTPResponseCode) TraitIndex

func (*HTTPResponseCode) TraitIndex() int

TraitIndex implements smithy.IndexableTrait.

type HostLabel

type HostLabel struct{}

HostLabel represents smithy.api#hostLabel.

func (*HostLabel) TraitID

func (*HostLabel) TraitID() smithy.ShapeID

TraitID identifies the trait.

func (*HostLabel) TraitIndex

func (*HostLabel) TraitIndex() int

TraitIndex implements smithy.IndexableTrait.

type JSONName

type JSONName struct {
	Name string
}

JSONName represents smithy.api#jsonName.

func (*JSONName) TraitID

func (*JSONName) TraitID() smithy.ShapeID

TraitID identifies the trait.

func (*JSONName) TraitIndex

func (*JSONName) TraitIndex() int

TraitIndex implements smithy.IndexableTrait.

type MediaType

type MediaType struct {
	Type string
}

MediaType represents smithy.api#mediaType.

func (*MediaType) TraitID

func (*MediaType) TraitID() smithy.ShapeID

TraitID identifies the trait.

func (*MediaType) TraitIndex

func (*MediaType) TraitIndex() int

TraitIndex implements smithy.IndexableTrait.

type Sensitive

type Sensitive struct{}

Sensitive represents smithy.api#sensitive.

func (*Sensitive) TraitID

func (*Sensitive) TraitID() smithy.ShapeID

TraitID identifies the trait.

func (*Sensitive) TraitIndex

func (*Sensitive) TraitIndex() int

TraitIndex implements smithy.IndexableTrait.

type Streaming

type Streaming struct{}

Streaming represents smithy.api#streaming.

func (*Streaming) TraitID

func (*Streaming) TraitID() smithy.ShapeID

TraitID identifies the trait.

func (*Streaming) TraitIndex

func (*Streaming) TraitIndex() int

TraitIndex implements smithy.IndexableTrait.

type TimestampFormat

type TimestampFormat struct {
	Format string
}

TimestampFormat represents smithy.api#timestampFormat.

func (*TimestampFormat) TraitID

func (*TimestampFormat) TraitID() smithy.ShapeID

TraitID identifies the trait.

func (*TimestampFormat) TraitIndex

func (*TimestampFormat) TraitIndex() int

TraitIndex implements smithy.IndexableTrait.

type UnitShape

type UnitShape struct{}

UnitShape is a synthetic trait applied to input/output shapes that were backfilled from Unit. It indicates the shape has no defined members and should be treated as absent for protocol serialization purposes.

func (*UnitShape) TraitID

func (*UnitShape) TraitID() smithy.ShapeID

TraitID identifies the trait.

func (*UnitShape) TraitIndex

func (*UnitShape) TraitIndex() int

TraitIndex implements smithy.IndexableTrait.

type XMLAttribute

type XMLAttribute struct{}

XMLAttribute represents smithy.api#xmlAttribute.

func (*XMLAttribute) TraitID

func (*XMLAttribute) TraitID() smithy.ShapeID

TraitID identifies the trait.

func (*XMLAttribute) TraitIndex

func (*XMLAttribute) TraitIndex() int

TraitIndex implements smithy.IndexableTrait.

type XMLFlattened

type XMLFlattened struct{}

XMLFlattened represents smithy.api#xmlFlattened.

func (*XMLFlattened) TraitID

func (*XMLFlattened) TraitID() smithy.ShapeID

TraitID identifies the trait.

func (*XMLFlattened) TraitIndex

func (*XMLFlattened) TraitIndex() int

TraitIndex implements smithy.IndexableTrait.

type XMLName

type XMLName struct {
	Name string
}

XMLName represents smithy.api#xmlName.

func (*XMLName) TraitID

func (*XMLName) TraitID() smithy.ShapeID

TraitID identifies the trait.

func (*XMLName) TraitIndex

func (*XMLName) TraitIndex() int

TraitIndex implements smithy.IndexableTrait.

type XMLNamespace

type XMLNamespace struct {
	URI    string
	Prefix string
}

XMLNamespace represents smithy.api#xmlNamespace.

func (*XMLNamespace) TraitID

func (*XMLNamespace) TraitID() smithy.ShapeID

TraitID identifies the trait.

func (*XMLNamespace) TraitIndex

func (*XMLNamespace) TraitIndex() int

TraitIndex implements smithy.IndexableTrait.