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

Interface GetDocumentationPartsRequest.Builder

    • Method Detail

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

      • 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:
        LocationStatusType, LocationStatusType

      • 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:
        LocationStatusType, LocationStatusType