AWS SDK for Go (PILOT)
API Reference

PREVIEW DOCUMENTATION - This is a preview of a new format for the AWS SDK for Go API Reference documentation. For the current AWS SDK for Go API Reference, see https://docs.aws.amazon.com/sdk-for-go/api/.

We welcome your feedback on this new version of the documentation. Send your comments to aws-sdkdocs-feedback@amazon.com.

DocumentationPartLocation

import "github.com/aws/aws-sdk-go/service/apigateway"

type DocumentationPartLocation struct { Method *string `locationName:"method" type:"string"` Name *string `locationName:"name" type:"string"` Path *string `locationName:"path" type:"string"` StatusCode *string `locationName:"statusCode" type:"string"` Type *string `locationName:"type" type:"string" required:"true" enum:"DocumentationPartType"` }

Specifies the target API entity to which the documentation applies.

Method

Type: *string

The HTTP verb of a method. It is a valid field for the API entity types of METHOD, PATH_PARAMETER, QUERY_PARAMETER, REQUEST_HEADER, REQUEST_BODY, RESPONSE, RESPONSE_HEADER, and RESPONSE_BODY. The default value is * for any method. When an applicable child entity inherits the content of an entity of the same type with more general specifications of the other location attributes, the child entity's method attribute must match that of the parent entity exactly.

Name

Type: *string

The name of the targeted API entity. It is a valid and required field for the API entity types of AUTHORIZER, MODEL, PATH_PARAMETER, QUERY_PARAMETER, REQUEST_HEADER, REQUEST_BODY and RESPONSE_HEADER. It is an invalid field for any other entity type.

Path

Type: *string

The URL path of the target. It is a valid field for the API entity types of RESOURCE, METHOD, PATH_PARAMETER, QUERY_PARAMETER, REQUEST_HEADER, REQUEST_BODY, RESPONSE, RESPONSE_HEADER, and RESPONSE_BODY. The default value is / for the root resource. When an applicable child entity inherits the content of another entity of the same type with more general specifications of the other location attributes, the child entity's path attribute must match that of the parent entity as a prefix.

StatusCode

Type: *string

The HTTP status code of a response. It is a valid field for the API entity types of RESPONSE, RESPONSE_HEADER, and RESPONSE_BODY. The default value is * for any status code. When an applicable child entity inherits the content of an entity of the same type with more general specifications of the other location attributes, the child entity's statusCode attribute must match that of the parent entity exactly.

Type

Type: *string

[Required] The type of API entity to which the documentation content applies. Valid values are API, AUTHORIZER, MODEL, RESOURCE, METHOD, PATH_PARAMETER, QUERY_PARAMETER, REQUEST_HEADER, REQUEST_BODY, RESPONSE, RESPONSE_HEADER, and RESPONSE_BODY. Content inheritance does not apply to any entity of the API, AUTHORIZER, METHOD, MODEL, REQUEST_BODY, or RESOURCE type.

Type is a required field

Method

GoString

func (s DocumentationPartLocation) GoString() string

GoString returns the string representation

SetMethod

func (s *DocumentationPartLocation) SetMethod(v string) *DocumentationPartLocation

SetMethod sets the Method field's value.

SetName

func (s *DocumentationPartLocation) SetName(v string) *DocumentationPartLocation

SetName sets the Name field's value.

SetPath

func (s *DocumentationPartLocation) SetPath(v string) *DocumentationPartLocation

SetPath sets the Path field's value.

SetStatusCode

func (s *DocumentationPartLocation) SetStatusCode(v string) *DocumentationPartLocation

SetStatusCode sets the StatusCode field's value.

SetType

func (s *DocumentationPartLocation) SetType(v string) *DocumentationPartLocation

SetType sets the Type field's value.

String

func (s DocumentationPartLocation) String() string

String returns the string representation

Validate

func (s *DocumentationPartLocation) Validate() error

Validate inspects the fields of the type to determine if they are valid.

On this page: