iotsitewise/aws.sdk.kotlin.services.iotsitewise.model/StartSearchRequest

StartSearchRequest

class StartSearchRequest

Input for the StartSearch operation.

Types

Builder

class Builder

Companion

object Companion

Properties

clientToken

val clientToken: String?

A unique, case-sensitive identifier you provide to ensure the request is idempotent. Repeating a StartSearch call with the same clientToken returns the original search rather than starting a new one. If omitted, the SDK autogenerates one.

groupId

val groupId: String?

An optional caller-supplied identifier used to group related searches together.

queryStatement

val queryStatement: String?

The natural-language query describing the data to search for.

searchFilters

val searchFilters: SearchFilters?

Optional filters that restrict the search to a subset of the workspace's data.

searchType

val searchType: SearchType?

The search strategy to use. Defaults to QUICK when omitted.

workspaceName

val workspaceName: String?

The name of the workspace whose data is searched.

Functions

copy

inline fun copy(block: StartSearchRequest.Builder.() -> Unit = {}): StartSearchRequest

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

toString

open override fun toString(): String