public static interface DocumentationPartLocation.Builder extends CopyableBuilder<DocumentationPartLocation.Builder,DocumentationPartLocation>
Modifier and Type | Method and Description |
---|---|
DocumentationPartLocation.Builder |
method(String method)
The HTTP verb of a method.
|
DocumentationPartLocation.Builder |
name(String name)
The name of the targeted API entity.
|
DocumentationPartLocation.Builder |
path(String path)
The URL path of the target.
|
DocumentationPartLocation.Builder |
statusCode(String statusCode)
The HTTP status code of a response.
|
DocumentationPartLocation.Builder |
type(DocumentationPartType type)
The type of API entity to which the documentation content applies.
|
DocumentationPartLocation.Builder |
type(String type)
The type of API entity to which the documentation content applies.
|
copy
apply, build
DocumentationPartLocation.Builder type(String type)
The type of API entity to which the documentation content applies. It is a valid and required field for API
entity types of 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
- The type of API entity to which the documentation content applies. It is a valid and required field
for API entity types of 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.DocumentationPartType
,
DocumentationPartType
DocumentationPartLocation.Builder type(DocumentationPartType type)
The type of API entity to which the documentation content applies. It is a valid and required field for API
entity types of 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
- The type of API entity to which the documentation content applies. It is a valid and required field
for API entity types of 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.DocumentationPartType
,
DocumentationPartType
DocumentationPartLocation.Builder path(String path)
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.
path
- 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.DocumentationPartLocation.Builder method(String method)
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.
method
- 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.DocumentationPartLocation.Builder statusCode(String statusCode)
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.
statusCode
- 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.DocumentationPartLocation.Builder name(String name)
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.
name
- 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.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.