Interface Citation.Builder

All Superinterfaces:
Buildable, CopyableBuilder<Citation.Builder,Citation>, SdkBuilder<Citation.Builder,Citation>, SdkPojo
Enclosing class:
Citation
@Mutable @NotThreadSafe public static interface Citation.Builder extends SdkPojo, CopyableBuilder<Citation.Builder,Citation>

  • Method Details

    • contentId

      Citation.Builder contentId(String contentId)

      The identifier of the content being cited.

      Parameters:
      contentId - The identifier of the content being cited.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • title

      Citation.Builder title(String title)

      The title of the cited content.

      Parameters:
      title - The title of the cited content.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • knowledgeBaseId

      Citation.Builder knowledgeBaseId(String knowledgeBaseId)

      The identifier of the knowledge base containing the cited content.

      Parameters:
      knowledgeBaseId - The identifier of the knowledge base containing the cited content.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • citationSpan

      Citation.Builder citationSpan(CitationSpan citationSpan)
      Sets the value of the CitationSpan property for this object.
      Parameters:
      citationSpan - The new value for the CitationSpan property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • citationSpan

      default Citation.Builder citationSpan(Consumer<CitationSpan.Builder> citationSpan)
      Sets the value of the CitationSpan property for this object. This is a convenience method that creates an instance of the CitationSpan.Builder avoiding the need to create one manually via CitationSpan.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to citationSpan(CitationSpan).

      Parameters:
      citationSpan - a consumer that will call methods on CitationSpan.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • sourceURL

      Citation.Builder sourceURL(String sourceURL)

      The source URL for the citation.

      Parameters:
      sourceURL - The source URL for the citation.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • referenceType

      Citation.Builder referenceType(String referenceType)

      A type to define the KB origin of a cited content

      Parameters:
      referenceType - A type to define the KB origin of a cited content
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • referenceType

      Citation.Builder referenceType(ReferenceType referenceType)

      A type to define the KB origin of a cited content

      Parameters:
      referenceType - A type to define the KB origin of a cited content
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: