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:
SdkPojo, ToCopyableBuilder<GetDocumentationPartsRequest.Builder,GetDocumentationPartsRequest>
@Generated("software.amazon.awssdk:codegen") public final 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).

  • Method Details

    • restApiId

      public final String restApiId()

      The string identifier of the associated RestApi.

      Returns:
      The string identifier of the associated RestApi.

    • type

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

    • typeAsString

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

    • nameQuery

      public final 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 final 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 final String position()

      The current pagination position in the paged result set.

      Returns:
      The current pagination position in the paged result set.

    • limit

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

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

    • locationStatusAsString

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

    • 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 final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      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

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.