Class GetDocumentationPartsRequest
- All Implemented Interfaces:
SdkPojo
,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
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final Integer
limit()
The maximum number of returned results per page.final LocationStatusType
The status of the API documentation parts to retrieve.final String
The status of the API documentation parts to retrieve.final String
The name of API entities of the to-be-retrieved documentation parts.final String
path()
The path of API entities of the to-be-retrieved documentation parts.final String
position()
The current pagination position in the paged result set.final String
The string identifier of the associated RestApi.static Class
<? extends GetDocumentationPartsRequest.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final DocumentationPartType
type()
The type of API entities of the to-be-retrieved documentation parts.final String
The type of API entities of the to-be-retrieved documentation parts.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
restApiId
The string identifier of the associated RestApi.
- Returns:
- The string identifier of the associated RestApi.
-
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 returnDocumentationPartType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtypeAsString()
.- Returns:
- The type of API entities of the to-be-retrieved documentation parts.
- See Also:
-
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 returnDocumentationPartType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtypeAsString()
.- Returns:
- The type of API entities of the to-be-retrieved documentation parts.
- See Also:
-
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
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
The current pagination position in the paged result set.
- Returns:
- The current pagination position in the paged result set.
-
limit
The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
- Returns:
- The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
-
locationStatus
The status of the API documentation parts to retrieve. Valid values are
DOCUMENTED
for retrieving DocumentationPart resources with content andUNDOCUMENTED
for DocumentationPart resources without content.If the service returns an enum value that is not available in the current SDK version,
locationStatus
will returnLocationStatusType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromlocationStatusAsString()
.- Returns:
- The status of the API documentation parts to retrieve. Valid values are
DOCUMENTED
for retrieving DocumentationPart resources with content andUNDOCUMENTED
for DocumentationPart resources without content. - See Also:
-
locationStatusAsString
The status of the API documentation parts to retrieve. Valid values are
DOCUMENTED
for retrieving DocumentationPart resources with content andUNDOCUMENTED
for DocumentationPart resources without content.If the service returns an enum value that is not available in the current SDK version,
locationStatus
will returnLocationStatusType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromlocationStatusAsString()
.- Returns:
- The status of the API documentation parts to retrieve. Valid values are
DOCUMENTED
for retrieving DocumentationPart resources with content andUNDOCUMENTED
for DocumentationPart resources without content. - See Also:
-
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 interfaceToCopyableBuilder<GetDocumentationPartsRequest.Builder,
GetDocumentationPartsRequest> - Specified by:
toBuilder
in classApiGatewayRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. 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, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- 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
-
sdkFields
-