BigQuery Data QnA V1alpha API - Class Google::Cloud::DataQnA::V1alpha::SuggestQueriesRequest (v0.5.0)

Reference documentation and code samples for the BigQuery Data QnA V1alpha API class Google::Cloud::DataQnA::V1alpha::SuggestQueriesRequest.

Request for query suggestions.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#parent

def parent() -> ::String
Returns
  • (::String) — Required. The parent of the suggestion query is the resource denoting the project and location.

#parent=

def parent=(value) -> ::String
Parameter
  • value (::String) — Required. The parent of the suggestion query is the resource denoting the project and location.
Returns
  • (::String) — Required. The parent of the suggestion query is the resource denoting the project and location.

#query

def query() -> ::String
Returns
  • (::String) — User query for which to generate suggestions. If the query is empty, zero state suggestions are returned. This allows UIs to display suggestions right away, helping the user to get a sense of what a query might look like.

#query=

def query=(value) -> ::String
Parameter
  • value (::String) — User query for which to generate suggestions. If the query is empty, zero state suggestions are returned. This allows UIs to display suggestions right away, helping the user to get a sense of what a query might look like.
Returns
  • (::String) — User query for which to generate suggestions. If the query is empty, zero state suggestions are returned. This allows UIs to display suggestions right away, helping the user to get a sense of what a query might look like.

#scopes

def scopes() -> ::Array<::String>
Returns
  • (::Array<::String>) — The scopes to which this search is restricted. The only supported scope pattern is //bigquery.googleapis.com/projects/{GCP-PROJECT-ID}/datasets/{DATASET-ID}/tables/{TABLE-ID}.

#scopes=

def scopes=(value) -> ::Array<::String>
Parameter
  • value (::Array<::String>) — The scopes to which this search is restricted. The only supported scope pattern is //bigquery.googleapis.com/projects/{GCP-PROJECT-ID}/datasets/{DATASET-ID}/tables/{TABLE-ID}.
Returns
  • (::Array<::String>) — The scopes to which this search is restricted. The only supported scope pattern is //bigquery.googleapis.com/projects/{GCP-PROJECT-ID}/datasets/{DATASET-ID}/tables/{TABLE-ID}.

#suggestion_types

def suggestion_types() -> ::Array<::Google::Cloud::DataQnA::V1alpha::SuggestionType>
Returns
  • (::Array<::Google::Cloud::DataQnA::V1alpha::SuggestionType>) — The requested suggestion type. Multiple suggestion types can be requested, but there is no guarantee that the service will return suggestions for each type. Suggestions for a requested type might rank lower than suggestions for other types and the service may decide to cut these suggestions off.

#suggestion_types=

def suggestion_types=(value) -> ::Array<::Google::Cloud::DataQnA::V1alpha::SuggestionType>
Parameter
  • value (::Array<::Google::Cloud::DataQnA::V1alpha::SuggestionType>) — The requested suggestion type. Multiple suggestion types can be requested, but there is no guarantee that the service will return suggestions for each type. Suggestions for a requested type might rank lower than suggestions for other types and the service may decide to cut these suggestions off.
Returns
  • (::Array<::Google::Cloud::DataQnA::V1alpha::SuggestionType>) — The requested suggestion type. Multiple suggestion types can be requested, but there is no guarantee that the service will return suggestions for each type. Suggestions for a requested type might rank lower than suggestions for other types and the service may decide to cut these suggestions off.