Package software.amazon.awssdk.services.apigateway.model

Class GetDocumentationPartsRequest

java.lang.Object

software.amazon.awssdk.AmazonWebServiceRequest

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

All Implemented Interfaces:

Cloneable, ReadLimitInfo, ToCopyableBuilder<GetDocumentationPartsRequest.Builder,GetDocumentationPartsRequest>

@Generated("software.amazon.awssdk:codegen")
public class GetDocumentationPartsRequest
extends AmazonWebServiceRequest
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	Description
static interface	GetDocumentationPartsRequest.Builder

Field Summary

Fields inherited from class software.amazon.awssdk.AmazonWebServiceRequest

NOOP

Method Summary

Modifier and Type	Method	Description
static GetDocumentationPartsRequest.Builder	builder()
boolean	equals(Object obj)
int	hashCode()
Integer	limit()	The maximum number of returned results per page.
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 identifier of the API of the to-be-retrieved documentation parts.
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()
String	type()	The type of API entities of the to-be-retrieved documentation parts.

Methods inherited from class software.amazon.awssdk.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

restApiId

public String restApiId()

[Required] The identifier of the API of the to-be-retrieved documentation parts.

Returns:

[Required] The identifier of the API of the to-be-retrieved documentation parts.

type

public String type()

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

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.

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>

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