Class TextBlockParam
-
- All Implemented Interfaces:
public final class TextBlockParam
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classTextBlockParam.BuilderA builder for TextBlockParam.
-
Method Summary
Modifier and Type Method Description final Stringtext()final JsonValue_type()Expected to always return the following:
However, this method can be useful for debugging and logging (e.g.JsonValue.from("text")final Optional<CacheControlEphemeral>cacheControl()Create a cache control breakpoint at this content block. final Optional<List<TextCitationParam>>citations()final JsonField<String>_text()Returns the raw JSON value of text. final JsonField<CacheControlEphemeral>_cacheControl()Returns the raw JSON value of cacheControl. final JsonField<List<TextCitationParam>>_citations()Returns the raw JSON value of citations. final Map<String, JsonValue>_additionalProperties()final TextBlockParam.BuildertoBuilder()final TextBlockParamvalidate()Validates that the types of all values in this object match their expected types recursively. final BooleanisValid()Booleanequals(Object other)IntegerhashCode()StringtoString()final static TextBlockParam.Builderbuilder()Returns a mutable builder for constructing an instance of TextBlockParam. -
-
Method Detail
-
_type
final JsonValue _type()
Expected to always return the following:
JsonValue.from("text")However, this method can be useful for debugging and logging (e.g. if the server responded with an unexpected value).
-
cacheControl
final Optional<CacheControlEphemeral> cacheControl()
Create a cache control breakpoint at this content block.
-
citations
final Optional<List<TextCitationParam>> citations()
-
_text
final JsonField<String> _text()
Returns the raw JSON value of text.
Unlike text, this method doesn't throw if the JSON field has an unexpected type.
-
_cacheControl
final JsonField<CacheControlEphemeral> _cacheControl()
Returns the raw JSON value of cacheControl.
Unlike cacheControl, this method doesn't throw if the JSON field has an unexpected type.
-
_citations
final JsonField<List<TextCitationParam>> _citations()
Returns the raw JSON value of citations.
Unlike citations, this method doesn't throw if the JSON field has an unexpected type.
-
_additionalProperties
final Map<String, JsonValue> _additionalProperties()
-
toBuilder
final TextBlockParam.Builder toBuilder()
-
validate
final TextBlockParam validate()
Validates that the types of all values in this object match their expected types recursively.
This method is not forwards compatible with new types from the API for existing fields.
-
builder
final static TextBlockParam.Builder builder()
Returns a mutable builder for constructing an instance of TextBlockParam.
The following fields are required:
.text()
-
-
-
-