@Generated(value="software.amazon.awssdk:codegen") public class DocumentationPartLocation extends Object implements StructuredPojo, ToCopyableBuilder<DocumentationPartLocation.Builder,DocumentationPartLocation>
Specifies the target API entity to which the documentation applies.
Modifier and Type | Class and Description |
---|---|
static interface |
DocumentationPartLocation.Builder |
Modifier and Type | Method and Description |
---|---|
static DocumentationPartLocation.Builder |
builder() |
boolean |
equals(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
String |
method()
The HTTP verb of a method.
|
String |
name()
The name of the targeted API entity.
|
String |
path()
The URL path of the target.
|
static Class<? extends DocumentationPartLocation.Builder> |
serializableBuilderClass() |
String |
statusCode()
The HTTP status code of a response.
|
DocumentationPartLocation.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
DocumentationPartType |
type()
The type of API entity to which the documentation content applies.
|
String |
typeString()
The type of API entity to which the documentation content applies.
|
copy
public 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.
If the service returns an enum value that is not available in the current SDK version, type
will return
DocumentationPartType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
typeString()
.
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
public String typeString()
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.
If the service returns an enum value that is not available in the current SDK version, type
will return
DocumentationPartType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
typeString()
.
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
public 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.
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.public 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
,
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.public 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.
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.public 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.
AUTHORIZER
, MODEL
, PATH_PARAMETER
, QUERY_PARAMETER
,
REQUEST_HEADER
, REQUEST_BODY
and RESPONSE_HEADER
. It is an invalid
field for any other entity type.public DocumentationPartLocation.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<DocumentationPartLocation.Builder,DocumentationPartLocation>
public static DocumentationPartLocation.Builder builder()
public static Class<? extends DocumentationPartLocation.Builder> serializableBuilderClass()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.