Constructor Detail

Method Detail

• text

   final TextBlockParam.Builder text(String text)

• text

   final TextBlockParam.Builder text(JsonField<String> text)

  Sets Builder.text to an arbitrary JSON value.

  You should usually call Builder.text with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• type

   final TextBlockParam.Builder type(JsonValue type)

  Sets the field to an arbitrary JSON value.

  It is usually unnecessary to call this method because the field defaults to the following:

  JsonValue.from("text")

  This method is primarily for setting the field to an undocumented or not yet supported value.

• cacheControl

   final TextBlockParam.Builder cacheControl(CacheControlEphemeral cacheControl)

  Create a cache control breakpoint at this content block.

• cacheControl

   final TextBlockParam.Builder cacheControl(Optional<CacheControlEphemeral> cacheControl)

  Alias for calling Builder.cacheControl with cacheControl.orElse(null).

• cacheControl

   final TextBlockParam.Builder cacheControl(JsonField<CacheControlEphemeral> cacheControl)

  Sets Builder.cacheControl to an arbitrary JSON value.

  You should usually call Builder.cacheControl with a well-typed CacheControlEphemeral value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• citations

   final TextBlockParam.Builder citations(List<TextCitationParam> citations)

• citations

   final TextBlockParam.Builder citations(Optional<List<TextCitationParam>> citations)

  Alias for calling Builder.citations with citations.orElse(null).

• citations

   final TextBlockParam.Builder citations(JsonField<List<TextCitationParam>> citations)

  Sets Builder.citations to an arbitrary JSON value.

  You should usually call Builder.citations with a well-typed List<TextCitationParam> value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• addCitation

   final TextBlockParam.Builder addCitation(TextCitationParam citation)

  Adds a single TextCitationParam to citations.

• addCitation

   final TextBlockParam.Builder addCitation(CitationCharLocationParam charLocation)

  Alias for calling addCitation with TextCitationParam.ofCharLocation(charLocation).

• addCitation

   final TextBlockParam.Builder addCitation(CitationCharLocation charLocation)

  Alias for calling addCitation with charLocation.toParam().

• addCitation

   final TextBlockParam.Builder addCitation(CitationPageLocationParam pageLocation)

  Alias for calling addCitation with TextCitationParam.ofPageLocation(pageLocation).

• addCitation

   final TextBlockParam.Builder addCitation(CitationPageLocation pageLocation)

  Alias for calling addCitation with pageLocation.toParam().

• addCitation

   final TextBlockParam.Builder addCitation(CitationContentBlockLocationParam contentBlockLocation)

  Alias for calling addCitation with TextCitationParam.ofContentBlockLocation(contentBlockLocation).

• addCitation

   final TextBlockParam.Builder addCitation(CitationContentBlockLocation contentBlockLocation)

  Alias for calling addCitation with contentBlockLocation.toParam().

• addCitation

   final TextBlockParam.Builder addCitation(CitationWebSearchResultLocationParam webSearchResultLocation)

  Alias for calling addCitation with TextCitationParam.ofWebSearchResultLocation(webSearchResultLocation).

• addCitation

   final TextBlockParam.Builder addCitation(CitationsWebSearchResultLocation webSearchResultLocation)

  Alias for calling addCitation with webSearchResultLocation.toParam().

• additionalProperties

   final TextBlockParam.Builder additionalProperties(Map<String, JsonValue> additionalProperties)

• putAdditionalProperty

   final TextBlockParam.Builder putAdditionalProperty(String key, JsonValue value)

• putAllAdditionalProperties

   final TextBlockParam.Builder putAllAdditionalProperties(Map<String, JsonValue> additionalProperties)

• removeAdditionalProperty

   final TextBlockParam.Builder removeAdditionalProperty(String key)

• removeAllAdditionalProperties

   final TextBlockParam.Builder removeAllAdditionalProperties(Set<String> keys)

• build

   final TextBlockParam build()

  Returns an immutable instance of TextBlockParam.

  Further updates to this Builder will not mutate the returned instance.

  The following fields are required:

  .text()