Show / Hide Table of Contents

Class SearchRequest

The search API request. NEXT ID: 17

Inheritance
object
SearchRequest
Implements
IDirectResponseSchema
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Google.Apis.CloudSearch.v1.Data
Assembly: Google.Apis.CloudSearch.v1.dll
Syntax
public class SearchRequest : IDirectResponseSchema

Properties

ContextAttributes

Context attributes for the request which will be used to adjust ranking of search results. The maximum number of elements is 10.

Declaration
[JsonProperty("contextAttributes")]
public virtual IList<ContextAttribute> ContextAttributes { get; set; }
Property Value
Type Description
IList<ContextAttribute>

DataSourceRestrictions

The sources to use for querying. If not specified, all data sources from the current search application are used.

Declaration
[JsonProperty("dataSourceRestrictions")]
public virtual IList<DataSourceRestriction> DataSourceRestrictions { get; set; }
Property Value
Type Description
IList<DataSourceRestriction>

ETag

The ETag of the item.

Declaration
public virtual string ETag { get; set; }
Property Value
Type Description
string

FacetOptions

Declaration
[JsonProperty("facetOptions")]
public virtual IList<FacetOptions> FacetOptions { get; set; }
Property Value
Type Description
IList<FacetOptions>

PageSize

Maximum number of search results to return in one page. Valid values are between 1 and 100, inclusive. Default value is 10. Minimum value is 50 when results beyond 2000 are requested.

Declaration
[JsonProperty("pageSize")]
public virtual int? PageSize { get; set; }
Property Value
Type Description
int?

Query

The raw query string. See supported search operators in the Narrow your search with operators

Declaration
[JsonProperty("query")]
public virtual string Query { get; set; }
Property Value
Type Description
string

QueryInterpretationOptions

Options to interpret the user query.

Declaration
[JsonProperty("queryInterpretationOptions")]
public virtual QueryInterpretationOptions QueryInterpretationOptions { get; set; }
Property Value
Type Description
QueryInterpretationOptions

RequestOptions

Request options, such as the search application and user timezone.

Declaration
[JsonProperty("requestOptions")]
public virtual RequestOptions RequestOptions { get; set; }
Property Value
Type Description
RequestOptions

SortOptions

The options for sorting the search results

Declaration
[JsonProperty("sortOptions")]
public virtual SortOptions SortOptions { get; set; }
Property Value
Type Description
SortOptions

Start

Starting index of the results.

Declaration
[JsonProperty("start")]
public virtual int? Start { get; set; }
Property Value
Type Description
int?

Implements

IDirectResponseSchema
In this article
Back to top Generated by DocFX