Package com.veeva.vault.sdk.api.document

Interface RenditionReadStructurePageRequest.Builder<B extends RenditionReadStructurePageRequest.Builder,T extends RenditionReadStructurePageRequest>

All Known Subinterfaces:
RenditionReadBookmarkPageRequest.Builder, RenditionReadNamedDestinationPageRequest.Builder, RenditionReadPageLinkPageRequest.Builder, RenditionReadPageSizePageRequest.Builder
Enclosing interface:
RenditionReadStructurePageRequest
public static interface RenditionReadStructurePageRequest.Builder<B extends RenditionReadStructurePageRequest.Builder,T extends RenditionReadStructurePageRequest>
Builds a RenditionReadStructurePageRequest.

  • Method Details

    • withQueryId

      B withQueryId(String queryId)
      Required: The query ID initiated based on a RenditionReadStructureExecutionRequest. Cannot be null or empty.
      Parameters:
      queryId - the query ID
      Returns:
      this builder

    • withPageOffset

      B withPageOffset(long pageOffset)
      The number of the first page of rendition structural metadata to read for this request.
      Parameters:
      pageOffset - the number of the first page of rendition structural metadata
      Returns:
      this builder

    • withPageSize

      B withPageSize(int pageSize)
      The number of results to retrieve in this page.

      If not specified, the page size defined in the original query will be used.

      Parameters:
      pageSize - page size
      Returns:
      this builder

    • build

      T build()
      Builds and returns a RenditionReadStructurePageRequest.
      Returns:
      A new RenditionReadStructurePageRequest