starting point for go docs

This commit is contained in:
darrell-thobe-sp
2025-03-27 14:43:04 -04:00
parent bdfaf3e228
commit 34d14a520e
2762 changed files with 516453 additions and 0 deletions

View File

@@ -0,0 +1,132 @@
---
id: v2024-text-query
title: TextQuery
pagination_label: TextQuery
sidebar_label: TextQuery
sidebar_class_name: gosdk
keywords: ['go', 'Golang', 'sdk', 'TextQuery', 'V2024TextQuery']
slug: /tools/sdk/go/v2024/models/text-query
tags: ['SDK', 'Software Development Kit', 'TextQuery', 'V2024TextQuery']
---
# TextQuery
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Terms** | **[]string** | Words or characters that specify a particular thing to be searched for. |
**Fields** | **[]string** | The fields to be searched. |
**MatchAny** | Pointer to **bool** | Indicates that at least one of the terms must be found in the specified fields; otherwise, all terms must be found. | [optional] [default to false]
**Contains** | Pointer to **bool** | Indicates that the terms can be located anywhere in the specified fields; otherwise, the fields must begin with the terms. | [optional] [default to false]
## Methods
### NewTextQuery
`func NewTextQuery(terms []string, fields []string, ) *TextQuery`
NewTextQuery instantiates a new TextQuery 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
### NewTextQueryWithDefaults
`func NewTextQueryWithDefaults() *TextQuery`
NewTextQueryWithDefaults instantiates a new TextQuery 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
### GetTerms
`func (o *TextQuery) GetTerms() []string`
GetTerms returns the Terms field if non-nil, zero value otherwise.
### GetTermsOk
`func (o *TextQuery) GetTermsOk() (*[]string, bool)`
GetTermsOk returns a tuple with the Terms field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetTerms
`func (o *TextQuery) SetTerms(v []string)`
SetTerms sets Terms field to given value.
### GetFields
`func (o *TextQuery) GetFields() []string`
GetFields returns the Fields field if non-nil, zero value otherwise.
### GetFieldsOk
`func (o *TextQuery) GetFieldsOk() (*[]string, bool)`
GetFieldsOk returns a tuple with the Fields field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetFields
`func (o *TextQuery) SetFields(v []string)`
SetFields sets Fields field to given value.
### GetMatchAny
`func (o *TextQuery) GetMatchAny() bool`
GetMatchAny returns the MatchAny field if non-nil, zero value otherwise.
### GetMatchAnyOk
`func (o *TextQuery) GetMatchAnyOk() (*bool, bool)`
GetMatchAnyOk returns a tuple with the MatchAny field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetMatchAny
`func (o *TextQuery) SetMatchAny(v bool)`
SetMatchAny sets MatchAny field to given value.
### HasMatchAny
`func (o *TextQuery) HasMatchAny() bool`
HasMatchAny returns a boolean if a field has been set.
### GetContains
`func (o *TextQuery) GetContains() bool`
GetContains returns the Contains field if non-nil, zero value otherwise.
### GetContainsOk
`func (o *TextQuery) GetContainsOk() (*bool, bool)`
GetContainsOk returns a tuple with the Contains field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetContains
`func (o *TextQuery) SetContains(v bool)`
SetContains sets Contains field to given value.
### HasContains
`func (o *TextQuery) HasContains() bool`
HasContains returns a boolean if a field has been set.