@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class CreateDocumentationPartResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable, Cloneable
A documentation part for a targeted API entity.
| Constructor and Description |
|---|
CreateDocumentationPartResult() |
| Modifier and Type | Method and Description |
|---|---|
CreateDocumentationPartResult |
clone() |
boolean |
equals(Object obj) |
String |
getId()
The DocumentationPart identifier, generated by 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 |
setId(String id)
The DocumentationPart identifier, generated by 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.
|
CreateDocumentationPartResult |
withId(String id)
The DocumentationPart identifier, generated by API Gateway when the
DocumentationPart is created. |
CreateDocumentationPartResult |
withLocation(DocumentationPartLocation location)
The location of the API entity to which the documentation applies.
|
CreateDocumentationPartResult |
withProperties(String properties)
A content map of API-specific key-value pairs describing the targeted API entity.
|
getSdkHttpMetadata, getSdkResponseMetadata, setSdkHttpMetadata, setSdkResponseMetadatapublic void setId(String id)
The DocumentationPart identifier, generated by API Gateway when the DocumentationPart is created.
id - The DocumentationPart identifier, generated by API Gateway when the DocumentationPart is
created.public String getId()
The DocumentationPart identifier, generated by API Gateway when the DocumentationPart is created.
DocumentationPart is
created.public CreateDocumentationPartResult withId(String id)
The DocumentationPart identifier, generated by API Gateway when the DocumentationPart is created.
id - The DocumentationPart identifier, generated by API Gateway when the DocumentationPart is
created.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.
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.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.
public CreateDocumentationPartResult 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.
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.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 OpenAPI-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 OpenAPI extension of
x-amazon-apigateway-documentation.
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 OpenAPI-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 OpenAPI extension of
x-amazon-apigateway-documentation.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 OpenAPI-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 OpenAPI extension of
x-amazon-apigateway-documentation.
"{ \"description\": \"The API does ...\" }". Only OpenAPI-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 OpenAPI extension of
x-amazon-apigateway-documentation.public CreateDocumentationPartResult 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 OpenAPI-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 OpenAPI extension of
x-amazon-apigateway-documentation.
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 OpenAPI-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 OpenAPI extension of
x-amazon-apigateway-documentation.public String toString()
toString in class ObjectObject.toString()public CreateDocumentationPartResult clone()