Interface GetDocumentationPartsRequest.Builder

All Superinterfaces:
ApiGatewayRequest.Builder, AwsRequest.Builder, Buildable, CopyableBuilder<GetDocumentationPartsRequest.Builder,GetDocumentationPartsRequest>, SdkBuilder<GetDocumentationPartsRequest.Builder,GetDocumentationPartsRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
GetDocumentationPartsRequest
public static interface GetDocumentationPartsRequest.Builder extends ApiGatewayRequest.Builder, SdkPojo, CopyableBuilder<GetDocumentationPartsRequest.Builder,GetDocumentationPartsRequest>

  • Method Details

    • restApiId

      GetDocumentationPartsRequest.Builder restApiId(String restApiId)

      The string identifier of the associated RestApi.

      Parameters:
      restApiId - The string identifier of the associated RestApi.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • type

      GetDocumentationPartsRequest.Builder type(String type)

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

      Parameters:
      type - The type of API entities of the to-be-retrieved documentation parts.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • type

      GetDocumentationPartsRequest.Builder type(DocumentationPartType type)

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

      Parameters:
      type - The type of API entities of the to-be-retrieved documentation parts.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • nameQuery

      GetDocumentationPartsRequest.Builder nameQuery(String nameQuery)

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

      Parameters:
      nameQuery - The name of API entities of the to-be-retrieved documentation parts.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • path

      GetDocumentationPartsRequest.Builder path(String path)

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

      Parameters:
      path - The path of API entities of the to-be-retrieved documentation parts.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • position

      GetDocumentationPartsRequest.Builder position(String position)

      The current pagination position in the paged result set.

      Parameters:
      position - The current pagination position in the paged result set.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • limit

      GetDocumentationPartsRequest.Builder limit(Integer limit)

      The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

      Parameters:
      limit - The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • locationStatus

      GetDocumentationPartsRequest.Builder locationStatus(String 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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • locationStatus

      GetDocumentationPartsRequest.Builder locationStatus(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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • overrideConfiguration

      GetDocumentationPartsRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      GetDocumentationPartsRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.