Google Cloud Gemini Data Analytics V1beta Client - Class BigQueryTableReferences (0.16.0)

Reference documentation and code samples for the Google Cloud Gemini Data Analytics V1beta Client class BigQueryTableReferences.

Message representing references to BigQuery tables and property graphs.

At least one of table_references, property_graph_references, or search_scope must be populated.

Generated from protobuf message google.cloud.geminidataanalytics.v1beta.BigQueryTableReferences

Namespace

Google \ Cloud \ GeminiDataAnalytics \ V1beta

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ table_references array<BigQueryTableReference>

Optional. References to BigQuery tables.

↳ property_graph_references array<BigQueryPropertyGraphReference>

Optional. References to BigQuery graphs. Note: "property graph" is the former name for BigQuery Graph. The field and message names retain the original term for backward compatibility; both refer to the same resource.

↳ search_scope SearchScope

Optional. Search over BigQuery resources to discover most relevant tables to the query. When set, at least one of include_project_ids or include_dataset_references must be populated with non-blank identifiers. Matches from the two fields are unioned (OR-ed). Note: search_scope is only supported for standalone conversations (ChatRequest.inline_context or ClientManagedResourceContext.inline_context) and is not supported in DataAgent.

↳ agent_context_reference AgentContextReference

Optional. Parameters for retrieving data from Agent Context.

getTableReferences

Optional. References to BigQuery tables.

Returns
Type Description
Google\Protobuf\RepeatedField<BigQueryTableReference>

setTableReferences

Optional. References to BigQuery tables.

Parameter
Name Description
var array<BigQueryTableReference>
Returns
Type Description
$this

getPropertyGraphReferences

Optional. References to BigQuery graphs.

Note: "property graph" is the former name for BigQuery Graph. The field and message names retain the original term for backward compatibility; both refer to the same resource.

Returns
Type Description
Google\Protobuf\RepeatedField<BigQueryPropertyGraphReference>

setPropertyGraphReferences

Optional. References to BigQuery graphs.

Note: "property graph" is the former name for BigQuery Graph. The field and message names retain the original term for backward compatibility; both refer to the same resource.

Parameter
Name Description
var array<BigQueryPropertyGraphReference>
Returns
Type Description
$this

getSearchScope

Optional. Search over BigQuery resources to discover most relevant tables to the query.

When set, at least one of include_project_ids or include_dataset_references must be populated with non-blank identifiers. Matches from the two fields are unioned (OR-ed). Note: search_scope is only supported for standalone conversations (ChatRequest.inline_context or ClientManagedResourceContext.inline_context) and is not supported in DataAgent.

Returns
Type Description
SearchScope|null

hasSearchScope

clearSearchScope

setSearchScope

Optional. Search over BigQuery resources to discover most relevant tables to the query.

When set, at least one of include_project_ids or include_dataset_references must be populated with non-blank identifiers. Matches from the two fields are unioned (OR-ed). Note: search_scope is only supported for standalone conversations (ChatRequest.inline_context or ClientManagedResourceContext.inline_context) and is not supported in DataAgent.

Parameter
Name Description
var SearchScope
Returns
Type Description
$this

getAgentContextReference

Optional. Parameters for retrieving data from Agent Context.

Returns
Type Description
AgentContextReference|null

hasAgentContextReference

clearAgentContextReference

setAgentContextReference

Optional. Parameters for retrieving data from Agent Context.

Parameter
Name Description
var AgentContextReference
Returns
Type Description
$this