Class DocumentBlockParam.Builder
-
- All Implemented Interfaces:
public final class DocumentBlockParam.BuilderA builder for DocumentBlockParam.
-
-
Method Summary
-
-
Method Detail
-
source
final DocumentBlockParam.Builder source(DocumentBlockParam.Source source)
-
source
final DocumentBlockParam.Builder source(JsonField<DocumentBlockParam.Source> source)
Sets Builder.source to an arbitrary JSON value.
You should usually call Builder.source with a well-typed Source value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
-
source
final DocumentBlockParam.Builder source(Base64PdfSource base64)
Alias for calling source with
Source.ofBase64(base64).
-
source
final DocumentBlockParam.Builder source(PlainTextSource text)
Alias for calling source with
Source.ofText(text).
-
source
final DocumentBlockParam.Builder source(ContentBlockSource content)
Alias for calling source with
Source.ofContent(content).
-
source
final DocumentBlockParam.Builder source(UrlPdfSource url)
Alias for calling source with
Source.ofUrl(url).
-
base64Source
final DocumentBlockParam.Builder base64Source(String data)
Alias for calling source with the following:
Base64PdfSource.builder() .data(data) .build()
-
textSource
final DocumentBlockParam.Builder textSource(String data)
Alias for calling source with the following:
PlainTextSource.builder() .data(data) .build()
-
contentSource
final DocumentBlockParam.Builder contentSource(ContentBlockSource.Content content)
Alias for calling source with the following:
ContentBlockSource.builder() .content(content) .build()
-
contentSource
final DocumentBlockParam.Builder contentSource(String string)
Alias for calling contentSource with
ContentBlockSource.Content.ofString(string).
-
contentSourceOfBlockSource
final DocumentBlockParam.Builder contentSourceOfBlockSource(List<ContentBlockSourceContent> blockSource)
Alias for calling contentSource with
ContentBlockSource.Content.ofBlockSource(blockSource).
-
urlSource
final DocumentBlockParam.Builder urlSource(String url)
Alias for calling source with the following:
UrlPdfSource.builder() .url(url) .build()
-
type
final DocumentBlockParam.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("document")This method is primarily for setting the field to an undocumented or not yet supported value.
-
cacheControl
final DocumentBlockParam.Builder cacheControl(CacheControlEphemeral cacheControl)
Create a cache control breakpoint at this content block.
-
cacheControl
final DocumentBlockParam.Builder cacheControl(Optional<CacheControlEphemeral> cacheControl)
Alias for calling Builder.cacheControl with
cacheControl.orElse(null).
-
cacheControl
final DocumentBlockParam.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 DocumentBlockParam.Builder citations(CitationsConfigParam citations)
-
citations
final DocumentBlockParam.Builder citations(JsonField<CitationsConfigParam> citations)
Sets Builder.citations to an arbitrary JSON value.
You should usually call Builder.citations with a well-typed CitationsConfigParam value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
-
context
final DocumentBlockParam.Builder context(String context)
-
context
final DocumentBlockParam.Builder context(Optional<String> context)
Alias for calling Builder.context with
context.orElse(null).
-
context
final DocumentBlockParam.Builder context(JsonField<String> context)
Sets Builder.context to an arbitrary JSON value.
You should usually call Builder.context with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
-
title
final DocumentBlockParam.Builder title(String title)
-
title
final DocumentBlockParam.Builder title(Optional<String> title)
Alias for calling Builder.title with
title.orElse(null).
-
title
final DocumentBlockParam.Builder title(JsonField<String> title)
Sets Builder.title to an arbitrary JSON value.
You should usually call Builder.title with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
-
additionalProperties
final DocumentBlockParam.Builder additionalProperties(Map<String, JsonValue> additionalProperties)
-
putAdditionalProperty
final DocumentBlockParam.Builder putAdditionalProperty(String key, JsonValue value)
-
putAllAdditionalProperties
final DocumentBlockParam.Builder putAllAdditionalProperties(Map<String, JsonValue> additionalProperties)
-
removeAdditionalProperty
final DocumentBlockParam.Builder removeAdditionalProperty(String key)
-
removeAllAdditionalProperties
final DocumentBlockParam.Builder removeAllAdditionalProperties(Set<String> keys)
-
build
final DocumentBlockParam build()
Returns an immutable instance of DocumentBlockParam.
Further updates to this Builder will not mutate the returned instance.
The following fields are required:
.source()
-
-
-
-