software.amazon.awssdk.services.apigateway.model

Class DocumentationPart

java.lang.Object

software.amazon.awssdk.services.apigateway.model.DocumentationPart

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<DocumentationPart.Builder,DocumentationPart>

@Generated(value="software.amazon.awssdk:codegen")
public final class DocumentationPart
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<DocumentationPart.Builder,DocumentationPart>

A documentation part for a targeted API entity.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DocumentationPart.Builder

Method Summary

Modifier and Type	Method and Description
static DocumentationPart.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	id() The DocumentationPart identifier, generated by API Gateway when the DocumentationPart is created.
DocumentationPartLocation	location() The location of the API entity to which the documentation applies.
String	properties() A content map of API-specific key-value pairs describing the targeted API entity.
List<SdkField<?>>	sdkFields()
static Class<? extends DocumentationPart.Builder>	serializableBuilderClass()
DocumentationPart.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

id

public final String id()

The DocumentationPart identifier, generated by API Gateway when the DocumentationPart is created.

Returns:

The DocumentationPart identifier, generated by API Gateway when the DocumentationPart is created.

location

public final 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.

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.

properties

public final 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.

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 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.

toBuilder

public DocumentationPart.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DocumentationPart.Builder,DocumentationPart>

builder

public static DocumentationPart.Builder builder()

serializableBuilderClass

public static Class<? extends DocumentationPart.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo