1.0.0-beta25 (latest) 1.0.0-beta24

    public sealed class SearchInfo : IMessage<SearchInfo>, IEquatable<SearchInfo>, IDeepCloneable<SearchInfo>, IBufferMessage, IMessage

Reference documentation and code samples for the Discovery Engine v1beta API class SearchInfo.

Detailed search information.

## Inheritance

[object](https://learn.microsoft.com/dotnet/api/system.object) \> SearchInfo

## Implements

[IMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IMessage-1.html)[SearchInfo](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.SearchInfo), [IEquatable](https://learn.microsoft.com/dotnet/api/system.iequatable-1)[SearchInfo](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.SearchInfo), [IDeepCloneable](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IDeepCloneable-1.html)[SearchInfo](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.SearchInfo), [IBufferMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IBufferMessage.html), [IMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IMessage.html)

## Inherited Members

[object.GetHashCode()](https://learn.microsoft.com/dotnet/api/system.object.gethashcode) [object.GetType()](https://learn.microsoft.com/dotnet/api/system.object.gettype) [object.ToString()](https://learn.microsoft.com/dotnet/api/system.object.tostring)

## Namespace

[Google.Cloud.DiscoveryEngine.V1Beta](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta)

## Assembly

Google.Cloud.DiscoveryEngine.V1Beta.dll

## Constructors

### SearchInfo()

    public SearchInfo()

### SearchInfo(SearchInfo)

    public SearchInfo(SearchInfo other)

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `other` | `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.SearchInfo` |

## Properties

### HasOffset

    public bool HasOffset { get; }

Gets whether the "offset" field is set

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.boolean` |   |

### Offset

    public int Offset { get; set; }

An integer that specifies the current offset for pagination (the 0-indexed
starting location, amongst the products deemed by the API as relevant).

See
\[SearchRequest.offset\]\[google.cloud.discoveryengine.v1beta.SearchRequest.offset\]
for definition.

If this field is negative, an `INVALID_ARGUMENT` is returned.

This can only be set for `search` events. Other event types should not set
this field. Otherwise, an `INVALID_ARGUMENT` error is returned.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.int32` |   |

### OrderBy

    public string OrderBy { get; set; }

The order in which products are returned, if applicable.

See
\[SearchRequest.order_by\]\[google.cloud.discoveryengine.v1beta.SearchRequest.order_by\]
for definition and syntax.

The value must be a UTF-8 encoded string with a length limit of 1,000
characters. Otherwise, an `INVALID_ARGUMENT` error is returned.

This can only be set for `search` events. Other event types should not set
this field. Otherwise, an `INVALID_ARGUMENT` error is returned.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.string` |   |

### SearchQuery

    public string SearchQuery { get; set; }

The user's search query.

See
\[SearchRequest.query\]\[google.cloud.discoveryengine.v1beta.SearchRequest.query\]
for definition.

The value must be a UTF-8 encoded string with a length limit of 5,000
characters. Otherwise, an `INVALID_ARGUMENT` error is returned.

At least one of
\[search_query\]\[google.cloud.discoveryengine.v1beta.SearchInfo.search_query\]
or
\[PageInfo.page_category\]\[google.cloud.discoveryengine.v1beta.PageInfo.page_category\]
is required for `search` events. Other event types should not set this
field. Otherwise, an `INVALID_ARGUMENT` error is returned.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.string` |   |