software.amazon.awssdk.services.apigateway.model

Class GetDocumentationPartsRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.apigateway.model.APIGatewayRequest

software.amazon.awssdk.services.apigateway.model.GetDocumentationPartsRequest

All Implemented Interfaces:

ToCopyableBuilder<GetDocumentationPartsRequest.Builder,GetDocumentationPartsRequest>

@Generated(value="software.amazon.awssdk:codegen")
public class GetDocumentationPartsRequest
extends APIGatewayRequest
implements ToCopyableBuilder<GetDocumentationPartsRequest.Builder,GetDocumentationPartsRequest>

Gets the documentation parts of an API. The result may be filtered by the type, name, or path of API entities (targets).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GetDocumentationPartsRequest.Builder

Method Summary

Modifier and Type	Method and Description
static GetDocumentationPartsRequest.Builder	builder()
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
int	hashCode()
Integer	limit() The maximum number of returned results per page.
LocationStatusType	locationStatus() The status of the API documentation parts to retrieve.
String	locationStatusAsString() The status of the API documentation parts to retrieve.
String	nameQuery() The name of API entities of the to-be-retrieved documentation parts.
String	path() The path of API entities of the to-be-retrieved documentation parts.
String	position() The current pagination position in the paged result set.
String	restApiId() [Required] The string identifier of the associated RestApi.
static Class<? extends GetDocumentationPartsRequest.Builder>	serializableBuilderClass()
GetDocumentationPartsRequest.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 entities of the to-be-retrieved documentation parts.
String	typeAsString() The type of API entities of the to-be-retrieved documentation parts.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

requestOverrideConfig

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

restApiId

public String restApiId()

[Required] The string identifier of the associated RestApi.

Returns:

[Required] The string identifier of the associated RestApi.

type

public DocumentationPartType type()

The type of API entities of the to-be-retrieved documentation parts.

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 typeAsString().

Returns:

The type of API entities of the to-be-retrieved documentation parts.

See Also:

DocumentationPartType

typeAsString

public String typeAsString()

The type of API entities of the to-be-retrieved documentation parts.

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 typeAsString().

Returns:

The type of API entities of the to-be-retrieved documentation parts.

See Also:

DocumentationPartType

nameQuery

public String nameQuery()

The name of API entities of the to-be-retrieved documentation parts.

Returns:

The name of API entities of the to-be-retrieved documentation parts.

path

public String path()

The path of API entities of the to-be-retrieved documentation parts.

Returns:

The path of API entities of the to-be-retrieved documentation parts.

position

public String position()

The current pagination position in the paged result set.

Returns:

The current pagination position in the paged result set.

limit

public Integer limit()

The maximum number of returned results per page.

Returns:

The maximum number of returned results per page.

locationStatus

public LocationStatusType locationStatus()

The status of the API documentation parts to retrieve. Valid values are DOCUMENTED for retrieving DocumentationPart resources with content and UNDOCUMENTED for DocumentationPart resources without content.

If the service returns an enum value that is not available in the current SDK version, locationStatus will return LocationStatusType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from locationStatusAsString().

Returns:

The status of the API documentation parts to retrieve. Valid values are DOCUMENTED for retrieving DocumentationPart resources with content and UNDOCUMENTED for DocumentationPart resources without content.

See Also:

LocationStatusType

locationStatusAsString

public String locationStatusAsString()

The status of the API documentation parts to retrieve. Valid values are DOCUMENTED for retrieving DocumentationPart resources with content and UNDOCUMENTED for DocumentationPart resources without content.

If the service returns an enum value that is not available in the current SDK version, locationStatus will return LocationStatusType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from locationStatusAsString().

Returns:

The status of the API documentation parts to retrieve. Valid values are DOCUMENTED for retrieving DocumentationPart resources with content and UNDOCUMENTED for DocumentationPart resources without content.

See Also:

LocationStatusType

toBuilder

public GetDocumentationPartsRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<GetDocumentationPartsRequest.Builder,GetDocumentationPartsRequest>

Specified by:

toBuilder in class APIGatewayRequest

Returns:

a builder for type T

builder

public static GetDocumentationPartsRequest.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

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

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value