DocumentationPart (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.apigateway.model.DocumentationPart

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class DocumentationPart
extends Object
implements Serializable, Cloneable, StructuredPojo
```
A documentation part for a targeted API entity.

A documentation part consists of a content map (properties) and a target (location). The target specifies an API entity to which the documentation content applies. The supported API entity types are API, AUTHORIZER, MODEL, RESOURCE, METHOD, PATH_PARAMETER, QUERY_PARAMETER, REQUEST_HEADER, REQUEST_BODY, RESPONSE, RESPONSE_HEADER, and RESPONSE_BODY. Valid location fields depend on the API entity type. All valid fields are not required.

The content map is a JSON string of API-specific key-value pairs. Although an API can use any shape for the content map, only the Swagger-compliant documentation fields will be injected into the associated API entity definition in the exported Swagger definition file.

Documenting an API, DocumentationParts

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

DocumentationPart()

Constructors
Constructor and Description
`DocumentationPart()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DocumentationPart`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getId()` The DocumentationPart identifier, generated by Amazon API Gateway when the `DocumentationPart` is created.
`DocumentationPartLocation`	`getLocation()` The location of the API entity to which the documentation applies.
`String`	`getProperties()` A content map of API-specific key-value pairs describing the targeted API entity.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setId(String id)` The DocumentationPart identifier, generated by Amazon API Gateway when the `DocumentationPart` is created.
`void`	`setLocation(DocumentationPartLocation location)` The location of the API entity to which the documentation applies.
`void`	`setProperties(String properties)` A content map of API-specific key-value pairs describing the targeted API entity.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`DocumentationPart`	`withId(String id)` The DocumentationPart identifier, generated by Amazon API Gateway when the `DocumentationPart` is created.
`DocumentationPart`	`withLocation(DocumentationPartLocation location)` The location of the API entity to which the documentation applies.
`DocumentationPart`	`withProperties(String properties)` A content map of API-specific key-value pairs describing the targeted API entity.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - DocumentationPart
```
public DocumentationPart()
```
- Method Detail
  - setId
```
public void setId(String id)
```
    The DocumentationPart identifier, generated by Amazon API Gateway when the DocumentationPart is created.
    
    Parameters:
    
    id - The DocumentationPart identifier, generated by Amazon API Gateway when the DocumentationPart is created.
  - getId
```
public String getId()
```
    The DocumentationPart identifier, generated by Amazon API Gateway when the DocumentationPart is created.
    
    Returns:
    
    The DocumentationPart identifier, generated by Amazon API Gateway when the DocumentationPart is created.
  - withId
```
public DocumentationPart withId(String id)
```
    The DocumentationPart identifier, generated by Amazon API Gateway when the DocumentationPart is created.
    
    Parameters:
    
    id - The DocumentationPart identifier, generated by Amazon API Gateway when the DocumentationPart is created.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLocation
```
public void setLocation(DocumentationPartLocation location)
```
    The location of the API entity to which the documentation applies. Valid fields depend on the targeted API entity type. All the valid location fields are not required. If not explicitly specified, a valid location field is treated as a wildcard and associated documentation content may be inherited by matching entities, unless overridden.
    
    Parameters:
    
    location - The location of the API entity to which the documentation applies. Valid fields depend on the targeted API entity type. All the valid location fields are not required. If not explicitly specified, a valid location field is treated as a wildcard and associated documentation content may be inherited by matching entities, unless overridden.
  - getLocation
```
public DocumentationPartLocation getLocation()
```
    The location of the API entity to which the documentation applies. Valid fields depend on the targeted API entity type. All the valid location fields are not required. If not explicitly specified, a valid location field is treated as a wildcard and associated documentation content may be inherited by matching entities, unless overridden.
    
    Returns:
    
    The location of the API entity to which the documentation applies. Valid fields depend on the targeted API entity type. All the valid location fields are not required. If not explicitly specified, a valid location field is treated as a wildcard and associated documentation content may be inherited by matching entities, unless overridden.
  - withLocation
```
public DocumentationPart withLocation(DocumentationPartLocation location)
```
    The location of the API entity to which the documentation applies. Valid fields depend on the targeted API entity type. All the valid location fields are not required. If not explicitly specified, a valid location field is treated as a wildcard and associated documentation content may be inherited by matching entities, unless overridden.
    
    Parameters:
    
    location - The location of the API entity to which the documentation applies. Valid fields depend on the targeted API entity type. All the valid location fields are not required. If not explicitly specified, a valid location field is treated as a wildcard and associated documentation content may be inherited by matching entities, unless overridden.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setProperties
```
public void setProperties(String properties)
```
    A content map of API-specific key-value pairs describing the targeted API entity. The map must be encoded as a JSON string, e.g., "{ \"description\": \"The API does ...\" }". Only Swagger-compliant documentation-related fields from the properties map are exported and, hence, published as part of the API entity definitions, while the original documentation parts are exported in a Swagger extension of x-amazon-apigateway-documentation.
    
    Parameters:
    
    properties - A content map of API-specific key-value pairs describing the targeted API entity. The map must be encoded as a JSON string, e.g., "{ \"description\": \"The API does ...\" }". Only Swagger-compliant documentation-related fields from the properties map are exported and, hence, published as part of the API entity definitions, while the original documentation parts are exported in a Swagger extension of x-amazon-apigateway-documentation.
  - getProperties
```
public String getProperties()
```
    A content map of API-specific key-value pairs describing the targeted API entity. The map must be encoded as a JSON string, e.g., "{ \"description\": \"The API does ...\" }". Only Swagger-compliant documentation-related fields from the properties map are exported and, hence, published as part of the API entity definitions, while the original documentation parts are exported in a Swagger extension of x-amazon-apigateway-documentation.
    
    Returns:
    
    A content map of API-specific key-value pairs describing the targeted API entity. The map must be encoded as a JSON string, e.g., "{ \"description\": \"The API does ...\" }". Only Swagger-compliant documentation-related fields from the properties map are exported and, hence, published as part of the API entity definitions, while the original documentation parts are exported in a Swagger extension of x-amazon-apigateway-documentation.
  - withProperties
```
public DocumentationPart withProperties(String properties)
```
    A content map of API-specific key-value pairs describing the targeted API entity. The map must be encoded as a JSON string, e.g., "{ \"description\": \"The API does ...\" }". Only Swagger-compliant documentation-related fields from the properties map are exported and, hence, published as part of the API entity definitions, while the original documentation parts are exported in a Swagger extension of x-amazon-apigateway-documentation.
    
    Parameters:
    
    properties - A content map of API-specific key-value pairs describing the targeted API entity. The map must be encoded as a JSON string, e.g., "{ \"description\": \"The API does ...\" }". Only Swagger-compliant documentation-related fields from the properties map are exported and, hence, published as part of the API entity definitions, while the original documentation parts are exported in a Swagger extension of x-amazon-apigateway-documentation.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public DocumentationPart clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class DocumentationPart

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DocumentationPart

Method Detail

setId

getId

withId

setLocation

getLocation

withLocation

setProperties

getProperties

withProperties

toString

equals

hashCode

clone

marshall