Class SearchResultBlockParam
-
- All Implemented Interfaces:
public final class SearchResultBlockParam
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classSearchResultBlockParam.BuilderA builder for SearchResultBlockParam.
-
Method Summary
Modifier and Type Method Description final List<TextBlockParam>content()final Stringsource()final Stringtitle()final JsonValue_type()Expected to always return the following:
However, this method can be useful for debugging and logging (e.g.JsonValue.from("search_result")final Optional<CacheControlEphemeral>cacheControl()Create a cache control breakpoint at this content block. final Optional<CitationsConfigParam>citations()final JsonField<List<TextBlockParam>>_content()Returns the raw JSON value of content. final JsonField<String>_source()Returns the raw JSON value of source. final JsonField<String>_title()Returns the raw JSON value of title. final JsonField<CacheControlEphemeral>_cacheControl()Returns the raw JSON value of cacheControl. final JsonField<CitationsConfigParam>_citations()Returns the raw JSON value of citations. final Map<String, JsonValue>_additionalProperties()final SearchResultBlockParam.BuildertoBuilder()final SearchResultBlockParamvalidate()Validates that the types of all values in this object match their expected types recursively. final BooleanisValid()Booleanequals(Object other)IntegerhashCode()StringtoString()final static SearchResultBlockParam.Builderbuilder()Returns a mutable builder for constructing an instance of SearchResultBlockParam. -
-
Method Detail
-
content
final List<TextBlockParam> content()
-
_type
final JsonValue _type()
Expected to always return the following:
JsonValue.from("search_result")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<CitationsConfigParam> citations()
-
_content
final JsonField<List<TextBlockParam>> _content()
Returns the raw JSON value of content.
Unlike content, this method doesn't throw if the JSON field has an unexpected type.
-
_source
final JsonField<String> _source()
Returns the raw JSON value of source.
Unlike source, this method doesn't throw if the JSON field has an unexpected type.
-
_title
final JsonField<String> _title()
Returns the raw JSON value of title.
Unlike title, 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<CitationsConfigParam> _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 SearchResultBlockParam.Builder toBuilder()
-
validate
final SearchResultBlockParam 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 SearchResultBlockParam.Builder builder()
Returns a mutable builder for constructing an instance of SearchResultBlockParam.
The following fields are required:
.content() .source() .title()
-
-
-
-