HighlightFieldOption
February 12, 2026 ยท View on GitHub
Properties
| Name | Type | Description | Notes |
|---|---|---|---|
| FragmentSize | Pointer to int32 | Maximum size of the text fragments in highlighted snippets per field | [optional] |
| Limit | Pointer to int32 | Maximum size of snippets per field | [optional] |
| LimitSnippets | Pointer to int32 | Maximum number of snippets per field | [optional] |
| LimitWords | Pointer to int32 | Maximum number of words per field | [optional] |
| NumberOfFragments | Pointer to int32 | Total number of highlighted fragments per field | [optional] |
Methods
NewHighlightFieldOption
func NewHighlightFieldOption() *HighlightFieldOption
NewHighlightFieldOption instantiates a new HighlightFieldOption object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed
NewHighlightFieldOptionWithDefaults
func NewHighlightFieldOptionWithDefaults() *HighlightFieldOption
NewHighlightFieldOptionWithDefaults instantiates a new HighlightFieldOption object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set
GetFragmentSize
func (o *HighlightFieldOption) GetFragmentSize() int32
GetFragmentSize returns the FragmentSize field if non-nil, zero value otherwise.
GetFragmentSizeOk
func (o *HighlightFieldOption) GetFragmentSizeOk() (*int32, bool)
GetFragmentSizeOk returns a tuple with the FragmentSize field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.
SetFragmentSize
func (o *HighlightFieldOption) SetFragmentSize(v int32)
SetFragmentSize sets FragmentSize field to given value.
HasFragmentSize
func (o *HighlightFieldOption) HasFragmentSize() bool
HasFragmentSize returns a boolean if a field has been set.
GetLimit
func (o *HighlightFieldOption) GetLimit() int32
GetLimit returns the Limit field if non-nil, zero value otherwise.
GetLimitOk
func (o *HighlightFieldOption) GetLimitOk() (*int32, bool)
GetLimitOk returns a tuple with the Limit field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.
SetLimit
func (o *HighlightFieldOption) SetLimit(v int32)
SetLimit sets Limit field to given value.
HasLimit
func (o *HighlightFieldOption) HasLimit() bool
HasLimit returns a boolean if a field has been set.
GetLimitSnippets
func (o *HighlightFieldOption) GetLimitSnippets() int32
GetLimitSnippets returns the LimitSnippets field if non-nil, zero value otherwise.
GetLimitSnippetsOk
func (o *HighlightFieldOption) GetLimitSnippetsOk() (*int32, bool)
GetLimitSnippetsOk returns a tuple with the LimitSnippets field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.
SetLimitSnippets
func (o *HighlightFieldOption) SetLimitSnippets(v int32)
SetLimitSnippets sets LimitSnippets field to given value.
HasLimitSnippets
func (o *HighlightFieldOption) HasLimitSnippets() bool
HasLimitSnippets returns a boolean if a field has been set.
GetLimitWords
func (o *HighlightFieldOption) GetLimitWords() int32
GetLimitWords returns the LimitWords field if non-nil, zero value otherwise.
GetLimitWordsOk
func (o *HighlightFieldOption) GetLimitWordsOk() (*int32, bool)
GetLimitWordsOk returns a tuple with the LimitWords field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.
SetLimitWords
func (o *HighlightFieldOption) SetLimitWords(v int32)
SetLimitWords sets LimitWords field to given value.
HasLimitWords
func (o *HighlightFieldOption) HasLimitWords() bool
HasLimitWords returns a boolean if a field has been set.
GetNumberOfFragments
func (o *HighlightFieldOption) GetNumberOfFragments() int32
GetNumberOfFragments returns the NumberOfFragments field if non-nil, zero value otherwise.
GetNumberOfFragmentsOk
func (o *HighlightFieldOption) GetNumberOfFragmentsOk() (*int32, bool)
GetNumberOfFragmentsOk returns a tuple with the NumberOfFragments field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.
SetNumberOfFragments
func (o *HighlightFieldOption) SetNumberOfFragments(v int32)
SetNumberOfFragments sets NumberOfFragments field to given value.
HasNumberOfFragments
func (o *HighlightFieldOption) HasNumberOfFragments() bool
HasNumberOfFragments returns a boolean if a field has been set.