Class Context.Builder (0.21.0) 

public static final class Context.Builder extends GeneratedMessage.Builder<Context.Builder> implements ContextOrBuilder

A collection of context to apply to this conversation

Protobuf type google.cloud.geminidataanalytics.v1.Context

Inheritance

java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > Context.Builder

Implements

ContextOrBuilder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addAllExampleQueries(Iterable<? extends ExampleQuery> values)

public Context.Builder addAllExampleQueries(Iterable<? extends ExampleQuery> values)

Optional. A list of example queries, providing examples of relevant and commonly used SQL queries and their corresponding natural language queries optionally present. Currently only used for BigQuery data sources and databases (alloydb, cloudsql, spanner) data sources.

repeated .google.cloud.geminidataanalytics.v1.ExampleQuery example_queries = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
values Iterable<? extends com.google.cloud.geminidataanalytics.v1.ExampleQuery>
Returns
Type Description
Context.Builder

addAllGlossaryTerms(Iterable<? extends GlossaryTerm> values)

public Context.Builder addAllGlossaryTerms(Iterable<? extends GlossaryTerm> values)

Optional. Term definitions (currently, only user authored) Not supported for databases (alloydb, cloudsql, spanner) data sources.

repeated .google.cloud.geminidataanalytics.v1.GlossaryTerm glossary_terms = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
values Iterable<? extends com.google.cloud.geminidataanalytics.v1.GlossaryTerm>
Returns
Type Description
Context.Builder

addAllLookerGoldenQueries(Iterable<? extends LookerGoldenQuery> values)

public Context.Builder addAllLookerGoldenQueries(Iterable<? extends LookerGoldenQuery> values)

Optional. A list of golden queries, providing examples of relevant and commonly used Looker queries and their corresponding natural language queries optionally present. Only supported for Looker data sources.

repeated .google.cloud.geminidataanalytics.v1.LookerGoldenQuery looker_golden_queries = 11 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
values Iterable<? extends com.google.cloud.geminidataanalytics.v1.LookerGoldenQuery>
Returns
Type Description
Context.Builder

addAllSchemaRelationships(Iterable<? extends Context.SchemaRelationship> values)

public Context.Builder addAllSchemaRelationships(Iterable<? extends Context.SchemaRelationship> values)

Optional. Relationships between table schema, including referencing and referenced columns.

repeated .google.cloud.geminidataanalytics.v1.Context.SchemaRelationship schema_relationships = 9 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
values Iterable<? extends com.google.cloud.geminidataanalytics.v1.Context.SchemaRelationship>
Returns
Type Description
Context.Builder

addExampleQueries(ExampleQuery value)

public Context.Builder addExampleQueries(ExampleQuery value)

Optional. A list of example queries, providing examples of relevant and commonly used SQL queries and their corresponding natural language queries optionally present. Currently only used for BigQuery data sources and databases (alloydb, cloudsql, spanner) data sources.

repeated .google.cloud.geminidataanalytics.v1.ExampleQuery example_queries = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ExampleQuery
Returns
Type Description
Context.Builder

addExampleQueries(ExampleQuery.Builder builderForValue)

public Context.Builder addExampleQueries(ExampleQuery.Builder builderForValue)

Optional. A list of example queries, providing examples of relevant and commonly used SQL queries and their corresponding natural language queries optionally present. Currently only used for BigQuery data sources and databases (alloydb, cloudsql, spanner) data sources.

repeated .google.cloud.geminidataanalytics.v1.ExampleQuery example_queries = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue ExampleQuery.Builder
Returns
Type Description
Context.Builder

addExampleQueries(int index, ExampleQuery value)

public Context.Builder addExampleQueries(int index, ExampleQuery value)

Optional. A list of example queries, providing examples of relevant and commonly used SQL queries and their corresponding natural language queries optionally present. Currently only used for BigQuery data sources and databases (alloydb, cloudsql, spanner) data sources.

repeated .google.cloud.geminidataanalytics.v1.ExampleQuery example_queries = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int
value ExampleQuery
Returns
Type Description
Context.Builder

addExampleQueries(int index, ExampleQuery.Builder builderForValue)

public Context.Builder addExampleQueries(int index, ExampleQuery.Builder builderForValue)

Optional. A list of example queries, providing examples of relevant and commonly used SQL queries and their corresponding natural language queries optionally present. Currently only used for BigQuery data sources and databases (alloydb, cloudsql, spanner) data sources.

repeated .google.cloud.geminidataanalytics.v1.ExampleQuery example_queries = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int
builderForValue ExampleQuery.Builder
Returns
Type Description
Context.Builder

addExampleQueriesBuilder()

public ExampleQuery.Builder addExampleQueriesBuilder()

Optional. A list of example queries, providing examples of relevant and commonly used SQL queries and their corresponding natural language queries optionally present. Currently only used for BigQuery data sources and databases (alloydb, cloudsql, spanner) data sources.

repeated .google.cloud.geminidataanalytics.v1.ExampleQuery example_queries = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ExampleQuery.Builder

addExampleQueriesBuilder(int index)

public ExampleQuery.Builder addExampleQueriesBuilder(int index)

Optional. A list of example queries, providing examples of relevant and commonly used SQL queries and their corresponding natural language queries optionally present. Currently only used for BigQuery data sources and databases (alloydb, cloudsql, spanner) data sources.

repeated .google.cloud.geminidataanalytics.v1.ExampleQuery example_queries = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
ExampleQuery.Builder

addGlossaryTerms(GlossaryTerm value)

public Context.Builder addGlossaryTerms(GlossaryTerm value)

Optional. Term definitions (currently, only user authored) Not supported for databases (alloydb, cloudsql, spanner) data sources.

repeated .google.cloud.geminidataanalytics.v1.GlossaryTerm glossary_terms = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value GlossaryTerm
Returns
Type Description
Context.Builder

addGlossaryTerms(GlossaryTerm.Builder builderForValue)

public Context.Builder addGlossaryTerms(GlossaryTerm.Builder builderForValue)

Optional. Term definitions (currently, only user authored) Not supported for databases (alloydb, cloudsql, spanner) data sources.

repeated .google.cloud.geminidataanalytics.v1.GlossaryTerm glossary_terms = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue GlossaryTerm.Builder
Returns
Type Description
Context.Builder

addGlossaryTerms(int index, GlossaryTerm value)

public Context.Builder addGlossaryTerms(int index, GlossaryTerm value)

Optional. Term definitions (currently, only user authored) Not supported for databases (alloydb, cloudsql, spanner) data sources.

repeated .google.cloud.geminidataanalytics.v1.GlossaryTerm glossary_terms = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int
value GlossaryTerm
Returns
Type Description
Context.Builder

addGlossaryTerms(int index, GlossaryTerm.Builder builderForValue)

public Context.Builder addGlossaryTerms(int index, GlossaryTerm.Builder builderForValue)

Optional. Term definitions (currently, only user authored) Not supported for databases (alloydb, cloudsql, spanner) data sources.

repeated .google.cloud.geminidataanalytics.v1.GlossaryTerm glossary_terms = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int
builderForValue GlossaryTerm.Builder
Returns
Type Description
Context.Builder

addGlossaryTermsBuilder()

public GlossaryTerm.Builder addGlossaryTermsBuilder()

Optional. Term definitions (currently, only user authored) Not supported for databases (alloydb, cloudsql, spanner) data sources.

repeated .google.cloud.geminidataanalytics.v1.GlossaryTerm glossary_terms = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
GlossaryTerm.Builder

addGlossaryTermsBuilder(int index)

public GlossaryTerm.Builder addGlossaryTermsBuilder(int index)

Optional. Term definitions (currently, only user authored) Not supported for databases (alloydb, cloudsql, spanner) data sources.

repeated .google.cloud.geminidataanalytics.v1.GlossaryTerm glossary_terms = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
GlossaryTerm.Builder

addLookerGoldenQueries(LookerGoldenQuery value)

public Context.Builder addLookerGoldenQueries(LookerGoldenQuery value)

Optional. A list of golden queries, providing examples of relevant and commonly used Looker queries and their corresponding natural language queries optionally present. Only supported for Looker data sources.

repeated .google.cloud.geminidataanalytics.v1.LookerGoldenQuery looker_golden_queries = 11 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value LookerGoldenQuery
Returns
Type Description
Context.Builder

addLookerGoldenQueries(LookerGoldenQuery.Builder builderForValue)

public Context.Builder addLookerGoldenQueries(LookerGoldenQuery.Builder builderForValue)

Optional. A list of golden queries, providing examples of relevant and commonly used Looker queries and their corresponding natural language queries optionally present. Only supported for Looker data sources.

repeated .google.cloud.geminidataanalytics.v1.LookerGoldenQuery looker_golden_queries = 11 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue LookerGoldenQuery.Builder
Returns
Type Description
Context.Builder

addLookerGoldenQueries(int index, LookerGoldenQuery value)

public Context.Builder addLookerGoldenQueries(int index, LookerGoldenQuery value)

Optional. A list of golden queries, providing examples of relevant and commonly used Looker queries and their corresponding natural language queries optionally present. Only supported for Looker data sources.

repeated .google.cloud.geminidataanalytics.v1.LookerGoldenQuery looker_golden_queries = 11 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int
value LookerGoldenQuery
Returns
Type Description
Context.Builder

addLookerGoldenQueries(int index, LookerGoldenQuery.Builder builderForValue)

public Context.Builder addLookerGoldenQueries(int index, LookerGoldenQuery.Builder builderForValue)

Optional. A list of golden queries, providing examples of relevant and commonly used Looker queries and their corresponding natural language queries optionally present. Only supported for Looker data sources.

repeated .google.cloud.geminidataanalytics.v1.LookerGoldenQuery looker_golden_queries = 11 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int
builderForValue LookerGoldenQuery.Builder
Returns
Type Description
Context.Builder

addLookerGoldenQueriesBuilder()

public LookerGoldenQuery.Builder addLookerGoldenQueriesBuilder()

Optional. A list of golden queries, providing examples of relevant and commonly used Looker queries and their corresponding natural language queries optionally present. Only supported for Looker data sources.

repeated .google.cloud.geminidataanalytics.v1.LookerGoldenQuery looker_golden_queries = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
LookerGoldenQuery.Builder

addLookerGoldenQueriesBuilder(int index)

public LookerGoldenQuery.Builder addLookerGoldenQueriesBuilder(int index)

Optional. A list of golden queries, providing examples of relevant and commonly used Looker queries and their corresponding natural language queries optionally present. Only supported for Looker data sources.

repeated .google.cloud.geminidataanalytics.v1.LookerGoldenQuery looker_golden_queries = 11 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
LookerGoldenQuery.Builder

addSchemaRelationships(Context.SchemaRelationship value)

public Context.Builder addSchemaRelationships(Context.SchemaRelationship value)

Optional. Relationships between table schema, including referencing and referenced columns.

repeated .google.cloud.geminidataanalytics.v1.Context.SchemaRelationship schema_relationships = 9 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value Context.SchemaRelationship
Returns
Type Description
Context.Builder

addSchemaRelationships(Context.SchemaRelationship.Builder builderForValue)

public Context.Builder addSchemaRelationships(Context.SchemaRelationship.Builder builderForValue)

Optional. Relationships between table schema, including referencing and referenced columns.

repeated .google.cloud.geminidataanalytics.v1.Context.SchemaRelationship schema_relationships = 9 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue Context.SchemaRelationship.Builder
Returns
Type Description
Context.Builder

addSchemaRelationships(int index, Context.SchemaRelationship value)

public Context.Builder addSchemaRelationships(int index, Context.SchemaRelationship value)

Optional. Relationships between table schema, including referencing and referenced columns.

repeated .google.cloud.geminidataanalytics.v1.Context.SchemaRelationship schema_relationships = 9 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int
value Context.SchemaRelationship
Returns
Type Description
Context.Builder

addSchemaRelationships(int index, Context.SchemaRelationship.Builder builderForValue)

public Context.Builder addSchemaRelationships(int index, Context.SchemaRelationship.Builder builderForValue)

Optional. Relationships between table schema, including referencing and referenced columns.

repeated .google.cloud.geminidataanalytics.v1.Context.SchemaRelationship schema_relationships = 9 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int
builderForValue Context.SchemaRelationship.Builder
Returns
Type Description
Context.Builder

addSchemaRelationshipsBuilder()

public Context.SchemaRelationship.Builder addSchemaRelationshipsBuilder()

Optional. Relationships between table schema, including referencing and referenced columns.

repeated .google.cloud.geminidataanalytics.v1.Context.SchemaRelationship schema_relationships = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Context.SchemaRelationship.Builder

addSchemaRelationshipsBuilder(int index)

public Context.SchemaRelationship.Builder addSchemaRelationshipsBuilder(int index)

Optional. Relationships between table schema, including referencing and referenced columns.

repeated .google.cloud.geminidataanalytics.v1.Context.SchemaRelationship schema_relationships = 9 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
Context.SchemaRelationship.Builder

build()

public Context build()
Returns
Type Description
Context

buildPartial()

public Context buildPartial()
Returns
Type Description
Context

clear()

public Context.Builder clear()
Returns
Type Description
Context.Builder
Overrides

clearDatasourceReferences()

public Context.Builder clearDatasourceReferences()

Required. Data sources that are available for answering the question.

.google.cloud.geminidataanalytics.v1.DatasourceReferences datasource_references = 7 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Context.Builder

clearExampleQueries()

public Context.Builder clearExampleQueries()

Optional. A list of example queries, providing examples of relevant and commonly used SQL queries and their corresponding natural language queries optionally present. Currently only used for BigQuery data sources and databases (alloydb, cloudsql, spanner) data sources.

repeated .google.cloud.geminidataanalytics.v1.ExampleQuery example_queries = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Context.Builder

clearGlossaryTerms()

public Context.Builder clearGlossaryTerms()

Optional. Term definitions (currently, only user authored) Not supported for databases (alloydb, cloudsql, spanner) data sources.

repeated .google.cloud.geminidataanalytics.v1.GlossaryTerm glossary_terms = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Context.Builder

clearLookerGoldenQueries()

public Context.Builder clearLookerGoldenQueries()

Optional. A list of golden queries, providing examples of relevant and commonly used Looker queries and their corresponding natural language queries optionally present. Only supported for Looker data sources.

repeated .google.cloud.geminidataanalytics.v1.LookerGoldenQuery looker_golden_queries = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Context.Builder

clearOptions()

public Context.Builder clearOptions()

Optional. Additional options for the conversation.

.google.cloud.geminidataanalytics.v1.ConversationOptions options = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Context.Builder

clearSchemaRelationships()

public Context.Builder clearSchemaRelationships()

Optional. Relationships between table schema, including referencing and referenced columns.

repeated .google.cloud.geminidataanalytics.v1.Context.SchemaRelationship schema_relationships = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Context.Builder

clearSystemInstruction()

public Context.Builder clearSystemInstruction()

Optional. The basic entry point for data owners creating domain knowledge for Agent.

Why: Business jargon (e.g., YTD revenue is calculated as…, Retirement Age is 65 in the USA, etc) and system instructions (e.g., answer like a Pirate) can help the model understand the business context around a user question.

string system_instruction = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Context.Builder

This builder for chaining.

clearUserFunctions()

public Context.Builder clearUserFunctions()

Optional. A collection of user functions to be included in context.

.google.cloud.geminidataanalytics.v1.UserFunctions user_functions = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Context.Builder

getDatasourceReferences()

public DatasourceReferences getDatasourceReferences()

Required. Data sources that are available for answering the question.

.google.cloud.geminidataanalytics.v1.DatasourceReferences datasource_references = 7 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
DatasourceReferences

The datasourceReferences.

getDatasourceReferencesBuilder()

public DatasourceReferences.Builder getDatasourceReferencesBuilder()

Required. Data sources that are available for answering the question.

.google.cloud.geminidataanalytics.v1.DatasourceReferences datasource_references = 7 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
DatasourceReferences.Builder

getDatasourceReferencesOrBuilder()

public DatasourceReferencesOrBuilder getDatasourceReferencesOrBuilder()

Required. Data sources that are available for answering the question.

.google.cloud.geminidataanalytics.v1.DatasourceReferences datasource_references = 7 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
DatasourceReferencesOrBuilder

getDefaultInstanceForType()

public Context getDefaultInstanceForType()
Returns
Type Description
Context

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getExampleQueries(int index)

public ExampleQuery getExampleQueries(int index)

Optional. A list of example queries, providing examples of relevant and commonly used SQL queries and their corresponding natural language queries optionally present. Currently only used for BigQuery data sources and databases (alloydb, cloudsql, spanner) data sources.

repeated .google.cloud.geminidataanalytics.v1.ExampleQuery example_queries = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
ExampleQuery

getExampleQueriesBuilder(int index)

public ExampleQuery.Builder getExampleQueriesBuilder(int index)

Optional. A list of example queries, providing examples of relevant and commonly used SQL queries and their corresponding natural language queries optionally present. Currently only used for BigQuery data sources and databases (alloydb, cloudsql, spanner) data sources.

repeated .google.cloud.geminidataanalytics.v1.ExampleQuery example_queries = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
ExampleQuery.Builder

getExampleQueriesBuilderList()

public List<ExampleQuery.Builder> getExampleQueriesBuilderList()

Optional. A list of example queries, providing examples of relevant and commonly used SQL queries and their corresponding natural language queries optionally present. Currently only used for BigQuery data sources and databases (alloydb, cloudsql, spanner) data sources.

repeated .google.cloud.geminidataanalytics.v1.ExampleQuery example_queries = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<Builder>

getExampleQueriesCount()

public int getExampleQueriesCount()

Optional. A list of example queries, providing examples of relevant and commonly used SQL queries and their corresponding natural language queries optionally present. Currently only used for BigQuery data sources and databases (alloydb, cloudsql, spanner) data sources.

repeated .google.cloud.geminidataanalytics.v1.ExampleQuery example_queries = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getExampleQueriesList()

public List<ExampleQuery> getExampleQueriesList()

Optional. A list of example queries, providing examples of relevant and commonly used SQL queries and their corresponding natural language queries optionally present. Currently only used for BigQuery data sources and databases (alloydb, cloudsql, spanner) data sources.

repeated .google.cloud.geminidataanalytics.v1.ExampleQuery example_queries = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<ExampleQuery>

getExampleQueriesOrBuilder(int index)

public ExampleQueryOrBuilder getExampleQueriesOrBuilder(int index)

Optional. A list of example queries, providing examples of relevant and commonly used SQL queries and their corresponding natural language queries optionally present. Currently only used for BigQuery data sources and databases (alloydb, cloudsql, spanner) data sources.

repeated .google.cloud.geminidataanalytics.v1.ExampleQuery example_queries = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
ExampleQueryOrBuilder

getExampleQueriesOrBuilderList()

public List<? extends ExampleQueryOrBuilder> getExampleQueriesOrBuilderList()

Optional. A list of example queries, providing examples of relevant and commonly used SQL queries and their corresponding natural language queries optionally present. Currently only used for BigQuery data sources and databases (alloydb, cloudsql, spanner) data sources.

repeated .google.cloud.geminidataanalytics.v1.ExampleQuery example_queries = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<? extends com.google.cloud.geminidataanalytics.v1.ExampleQueryOrBuilder>

getGlossaryTerms(int index)

public GlossaryTerm getGlossaryTerms(int index)

Optional. Term definitions (currently, only user authored) Not supported for databases (alloydb, cloudsql, spanner) data sources.

repeated .google.cloud.geminidataanalytics.v1.GlossaryTerm glossary_terms = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
GlossaryTerm

getGlossaryTermsBuilder(int index)

public GlossaryTerm.Builder getGlossaryTermsBuilder(int index)

Optional. Term definitions (currently, only user authored) Not supported for databases (alloydb, cloudsql, spanner) data sources.

repeated .google.cloud.geminidataanalytics.v1.GlossaryTerm glossary_terms = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
GlossaryTerm.Builder

getGlossaryTermsBuilderList()

public List<GlossaryTerm.Builder> getGlossaryTermsBuilderList()

Optional. Term definitions (currently, only user authored) Not supported for databases (alloydb, cloudsql, spanner) data sources.

repeated .google.cloud.geminidataanalytics.v1.GlossaryTerm glossary_terms = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<Builder>

getGlossaryTermsCount()

public int getGlossaryTermsCount()

Optional. Term definitions (currently, only user authored) Not supported for databases (alloydb, cloudsql, spanner) data sources.

repeated .google.cloud.geminidataanalytics.v1.GlossaryTerm glossary_terms = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getGlossaryTermsList()

public List<GlossaryTerm> getGlossaryTermsList()

Optional. Term definitions (currently, only user authored) Not supported for databases (alloydb, cloudsql, spanner) data sources.

repeated .google.cloud.geminidataanalytics.v1.GlossaryTerm glossary_terms = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<GlossaryTerm>

getGlossaryTermsOrBuilder(int index)

public GlossaryTermOrBuilder getGlossaryTermsOrBuilder(int index)

Optional. Term definitions (currently, only user authored) Not supported for databases (alloydb, cloudsql, spanner) data sources.

repeated .google.cloud.geminidataanalytics.v1.GlossaryTerm glossary_terms = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
GlossaryTermOrBuilder

getGlossaryTermsOrBuilderList()

public List<? extends GlossaryTermOrBuilder> getGlossaryTermsOrBuilderList()

Optional. Term definitions (currently, only user authored) Not supported for databases (alloydb, cloudsql, spanner) data sources.

repeated .google.cloud.geminidataanalytics.v1.GlossaryTerm glossary_terms = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<? extends com.google.cloud.geminidataanalytics.v1.GlossaryTermOrBuilder>

getLookerGoldenQueries(int index)

public LookerGoldenQuery getLookerGoldenQueries(int index)

Optional. A list of golden queries, providing examples of relevant and commonly used Looker queries and their corresponding natural language queries optionally present. Only supported for Looker data sources.

repeated .google.cloud.geminidataanalytics.v1.LookerGoldenQuery looker_golden_queries = 11 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
LookerGoldenQuery

getLookerGoldenQueriesBuilder(int index)

public LookerGoldenQuery.Builder getLookerGoldenQueriesBuilder(int index)

Optional. A list of golden queries, providing examples of relevant and commonly used Looker queries and their corresponding natural language queries optionally present. Only supported for Looker data sources.

repeated .google.cloud.geminidataanalytics.v1.LookerGoldenQuery looker_golden_queries = 11 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
LookerGoldenQuery.Builder

getLookerGoldenQueriesBuilderList()

public List<LookerGoldenQuery.Builder> getLookerGoldenQueriesBuilderList()

Optional. A list of golden queries, providing examples of relevant and commonly used Looker queries and their corresponding natural language queries optionally present. Only supported for Looker data sources.

repeated .google.cloud.geminidataanalytics.v1.LookerGoldenQuery looker_golden_queries = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<Builder>

getLookerGoldenQueriesCount()

public int getLookerGoldenQueriesCount()

Optional. A list of golden queries, providing examples of relevant and commonly used Looker queries and their corresponding natural language queries optionally present. Only supported for Looker data sources.

repeated .google.cloud.geminidataanalytics.v1.LookerGoldenQuery looker_golden_queries = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getLookerGoldenQueriesList()

public List<LookerGoldenQuery> getLookerGoldenQueriesList()

Optional. A list of golden queries, providing examples of relevant and commonly used Looker queries and their corresponding natural language queries optionally present. Only supported for Looker data sources.

repeated .google.cloud.geminidataanalytics.v1.LookerGoldenQuery looker_golden_queries = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<LookerGoldenQuery>

getLookerGoldenQueriesOrBuilder(int index)

public LookerGoldenQueryOrBuilder getLookerGoldenQueriesOrBuilder(int index)

Optional. A list of golden queries, providing examples of relevant and commonly used Looker queries and their corresponding natural language queries optionally present. Only supported for Looker data sources.

repeated .google.cloud.geminidataanalytics.v1.LookerGoldenQuery looker_golden_queries = 11 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
LookerGoldenQueryOrBuilder

getLookerGoldenQueriesOrBuilderList()

public List<? extends LookerGoldenQueryOrBuilder> getLookerGoldenQueriesOrBuilderList()

Optional. A list of golden queries, providing examples of relevant and commonly used Looker queries and their corresponding natural language queries optionally present. Only supported for Looker data sources.

repeated .google.cloud.geminidataanalytics.v1.LookerGoldenQuery looker_golden_queries = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<? extends com.google.cloud.geminidataanalytics.v1.LookerGoldenQueryOrBuilder>

getOptions()

public ConversationOptions getOptions()

Optional. Additional options for the conversation.

.google.cloud.geminidataanalytics.v1.ConversationOptions options = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ConversationOptions

The options.

getOptionsBuilder()

public ConversationOptions.Builder getOptionsBuilder()

Optional. Additional options for the conversation.

.google.cloud.geminidataanalytics.v1.ConversationOptions options = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ConversationOptions.Builder

getOptionsOrBuilder()

public ConversationOptionsOrBuilder getOptionsOrBuilder()

Optional. Additional options for the conversation.

.google.cloud.geminidataanalytics.v1.ConversationOptions options = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ConversationOptionsOrBuilder

getSchemaRelationships(int index)

public Context.SchemaRelationship getSchemaRelationships(int index)

Optional. Relationships between table schema, including referencing and referenced columns.

repeated .google.cloud.geminidataanalytics.v1.Context.SchemaRelationship schema_relationships = 9 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
Context.SchemaRelationship

getSchemaRelationshipsBuilder(int index)

public Context.SchemaRelationship.Builder getSchemaRelationshipsBuilder(int index)

Optional. Relationships between table schema, including referencing and referenced columns.

repeated .google.cloud.geminidataanalytics.v1.Context.SchemaRelationship schema_relationships = 9 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
Context.SchemaRelationship.Builder

getSchemaRelationshipsBuilderList()

public List<Context.SchemaRelationship.Builder> getSchemaRelationshipsBuilderList()

Optional. Relationships between table schema, including referencing and referenced columns.

repeated .google.cloud.geminidataanalytics.v1.Context.SchemaRelationship schema_relationships = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<Builder>

getSchemaRelationshipsCount()

public int getSchemaRelationshipsCount()

Optional. Relationships between table schema, including referencing and referenced columns.

repeated .google.cloud.geminidataanalytics.v1.Context.SchemaRelationship schema_relationships = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getSchemaRelationshipsList()

public List<Context.SchemaRelationship> getSchemaRelationshipsList()

Optional. Relationships between table schema, including referencing and referenced columns.

repeated .google.cloud.geminidataanalytics.v1.Context.SchemaRelationship schema_relationships = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<SchemaRelationship>

getSchemaRelationshipsOrBuilder(int index)

public Context.SchemaRelationshipOrBuilder getSchemaRelationshipsOrBuilder(int index)

Optional. Relationships between table schema, including referencing and referenced columns.

repeated .google.cloud.geminidataanalytics.v1.Context.SchemaRelationship schema_relationships = 9 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
Context.SchemaRelationshipOrBuilder

getSchemaRelationshipsOrBuilderList()

public List<? extends Context.SchemaRelationshipOrBuilder> getSchemaRelationshipsOrBuilderList()

Optional. Relationships between table schema, including referencing and referenced columns.

repeated .google.cloud.geminidataanalytics.v1.Context.SchemaRelationship schema_relationships = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<? extends com.google.cloud.geminidataanalytics.v1.Context.SchemaRelationshipOrBuilder>

getSystemInstruction()

public String getSystemInstruction()

Optional. The basic entry point for data owners creating domain knowledge for Agent.

Why: Business jargon (e.g., YTD revenue is calculated as…, Retirement Age is 65 in the USA, etc) and system instructions (e.g., answer like a Pirate) can help the model understand the business context around a user question.

string system_instruction = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The systemInstruction.

getSystemInstructionBytes()

public ByteString getSystemInstructionBytes()

Optional. The basic entry point for data owners creating domain knowledge for Agent.

Why: Business jargon (e.g., YTD revenue is calculated as…, Retirement Age is 65 in the USA, etc) and system instructions (e.g., answer like a Pirate) can help the model understand the business context around a user question.

string system_instruction = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for systemInstruction.

getUserFunctions()

public UserFunctions getUserFunctions()

Optional. A collection of user functions to be included in context.

.google.cloud.geminidataanalytics.v1.UserFunctions user_functions = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
UserFunctions

The userFunctions.

getUserFunctionsBuilder()

public UserFunctions.Builder getUserFunctionsBuilder()

Optional. A collection of user functions to be included in context.

.google.cloud.geminidataanalytics.v1.UserFunctions user_functions = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
UserFunctions.Builder

getUserFunctionsOrBuilder()

public UserFunctionsOrBuilder getUserFunctionsOrBuilder()

Optional. A collection of user functions to be included in context.

.google.cloud.geminidataanalytics.v1.UserFunctions user_functions = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
UserFunctionsOrBuilder

hasDatasourceReferences()

public boolean hasDatasourceReferences()

Required. Data sources that are available for answering the question.

.google.cloud.geminidataanalytics.v1.DatasourceReferences datasource_references = 7 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the datasourceReferences field is set.

hasOptions()

public boolean hasOptions()

Optional. Additional options for the conversation.

.google.cloud.geminidataanalytics.v1.ConversationOptions options = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the options field is set.

hasUserFunctions()

public boolean hasUserFunctions()

Optional. A collection of user functions to be included in context.

.google.cloud.geminidataanalytics.v1.UserFunctions user_functions = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the userFunctions field is set.

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeDatasourceReferences(DatasourceReferences value)

public Context.Builder mergeDatasourceReferences(DatasourceReferences value)

Required. Data sources that are available for answering the question.

.google.cloud.geminidataanalytics.v1.DatasourceReferences datasource_references = 7 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value DatasourceReferences
Returns
Type Description
Context.Builder

mergeFrom(Context other)

public Context.Builder mergeFrom(Context other)
Parameter
Name Description
other Context
Returns
Type Description
Context.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Context.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Context.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public Context.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
Context.Builder
Overrides

mergeOptions(ConversationOptions value)

public Context.Builder mergeOptions(ConversationOptions value)

Optional. Additional options for the conversation.

.google.cloud.geminidataanalytics.v1.ConversationOptions options = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ConversationOptions
Returns
Type Description
Context.Builder

mergeUserFunctions(UserFunctions value)

public Context.Builder mergeUserFunctions(UserFunctions value)

Optional. A collection of user functions to be included in context.

.google.cloud.geminidataanalytics.v1.UserFunctions user_functions = 10 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value UserFunctions
Returns
Type Description
Context.Builder

removeExampleQueries(int index)

public Context.Builder removeExampleQueries(int index)

Optional. A list of example queries, providing examples of relevant and commonly used SQL queries and their corresponding natural language queries optionally present. Currently only used for BigQuery data sources and databases (alloydb, cloudsql, spanner) data sources.

repeated .google.cloud.geminidataanalytics.v1.ExampleQuery example_queries = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
Context.Builder

removeGlossaryTerms(int index)

public Context.Builder removeGlossaryTerms(int index)

Optional. Term definitions (currently, only user authored) Not supported for databases (alloydb, cloudsql, spanner) data sources.

repeated .google.cloud.geminidataanalytics.v1.GlossaryTerm glossary_terms = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
Context.Builder

removeLookerGoldenQueries(int index)

public Context.Builder removeLookerGoldenQueries(int index)

Optional. A list of golden queries, providing examples of relevant and commonly used Looker queries and their corresponding natural language queries optionally present. Only supported for Looker data sources.

repeated .google.cloud.geminidataanalytics.v1.LookerGoldenQuery looker_golden_queries = 11 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
Context.Builder

removeSchemaRelationships(int index)

public Context.Builder removeSchemaRelationships(int index)

Optional. Relationships between table schema, including referencing and referenced columns.

repeated .google.cloud.geminidataanalytics.v1.Context.SchemaRelationship schema_relationships = 9 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
Context.Builder

setDatasourceReferences(DatasourceReferences value)

public Context.Builder setDatasourceReferences(DatasourceReferences value)

Required. Data sources that are available for answering the question.

.google.cloud.geminidataanalytics.v1.DatasourceReferences datasource_references = 7 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value DatasourceReferences
Returns
Type Description
Context.Builder

setDatasourceReferences(DatasourceReferences.Builder builderForValue)

public Context.Builder setDatasourceReferences(DatasourceReferences.Builder builderForValue)

Required. Data sources that are available for answering the question.

.google.cloud.geminidataanalytics.v1.DatasourceReferences datasource_references = 7 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
builderForValue DatasourceReferences.Builder
Returns
Type Description
Context.Builder

setExampleQueries(int index, ExampleQuery value)

public Context.Builder setExampleQueries(int index, ExampleQuery value)

Optional. A list of example queries, providing examples of relevant and commonly used SQL queries and their corresponding natural language queries optionally present. Currently only used for BigQuery data sources and databases (alloydb, cloudsql, spanner) data sources.

repeated .google.cloud.geminidataanalytics.v1.ExampleQuery example_queries = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int
value ExampleQuery
Returns
Type Description
Context.Builder

setExampleQueries(int index, ExampleQuery.Builder builderForValue)

public Context.Builder setExampleQueries(int index, ExampleQuery.Builder builderForValue)

Optional. A list of example queries, providing examples of relevant and commonly used SQL queries and their corresponding natural language queries optionally present. Currently only used for BigQuery data sources and databases (alloydb, cloudsql, spanner) data sources.

repeated .google.cloud.geminidataanalytics.v1.ExampleQuery example_queries = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int
builderForValue ExampleQuery.Builder
Returns
Type Description
Context.Builder

setGlossaryTerms(int index, GlossaryTerm value)

public Context.Builder setGlossaryTerms(int index, GlossaryTerm value)

Optional. Term definitions (currently, only user authored) Not supported for databases (alloydb, cloudsql, spanner) data sources.

repeated .google.cloud.geminidataanalytics.v1.GlossaryTerm glossary_terms = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int
value GlossaryTerm
Returns
Type Description
Context.Builder

setGlossaryTerms(int index, GlossaryTerm.Builder builderForValue)

public Context.Builder setGlossaryTerms(int index, GlossaryTerm.Builder builderForValue)

Optional. Term definitions (currently, only user authored) Not supported for databases (alloydb, cloudsql, spanner) data sources.

repeated .google.cloud.geminidataanalytics.v1.GlossaryTerm glossary_terms = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int
builderForValue GlossaryTerm.Builder
Returns
Type Description
Context.Builder

setLookerGoldenQueries(int index, LookerGoldenQuery value)

public Context.Builder setLookerGoldenQueries(int index, LookerGoldenQuery value)

Optional. A list of golden queries, providing examples of relevant and commonly used Looker queries and their corresponding natural language queries optionally present. Only supported for Looker data sources.

repeated .google.cloud.geminidataanalytics.v1.LookerGoldenQuery looker_golden_queries = 11 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int
value LookerGoldenQuery
Returns
Type Description
Context.Builder

setLookerGoldenQueries(int index, LookerGoldenQuery.Builder builderForValue)

public Context.Builder setLookerGoldenQueries(int index, LookerGoldenQuery.Builder builderForValue)

Optional. A list of golden queries, providing examples of relevant and commonly used Looker queries and their corresponding natural language queries optionally present. Only supported for Looker data sources.

repeated .google.cloud.geminidataanalytics.v1.LookerGoldenQuery looker_golden_queries = 11 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int
builderForValue LookerGoldenQuery.Builder
Returns
Type Description
Context.Builder

setOptions(ConversationOptions value)

public Context.Builder setOptions(ConversationOptions value)

Optional. Additional options for the conversation.

.google.cloud.geminidataanalytics.v1.ConversationOptions options = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ConversationOptions
Returns
Type Description
Context.Builder

setOptions(ConversationOptions.Builder builderForValue)

public Context.Builder setOptions(ConversationOptions.Builder builderForValue)

Optional. Additional options for the conversation.

.google.cloud.geminidataanalytics.v1.ConversationOptions options = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue ConversationOptions.Builder
Returns
Type Description
Context.Builder

setSchemaRelationships(int index, Context.SchemaRelationship value)

public Context.Builder setSchemaRelationships(int index, Context.SchemaRelationship value)

Optional. Relationships between table schema, including referencing and referenced columns.

repeated .google.cloud.geminidataanalytics.v1.Context.SchemaRelationship schema_relationships = 9 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int
value Context.SchemaRelationship
Returns
Type Description
Context.Builder

setSchemaRelationships(int index, Context.SchemaRelationship.Builder builderForValue)

public Context.Builder setSchemaRelationships(int index, Context.SchemaRelationship.Builder builderForValue)

Optional. Relationships between table schema, including referencing and referenced columns.

repeated .google.cloud.geminidataanalytics.v1.Context.SchemaRelationship schema_relationships = 9 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int
builderForValue Context.SchemaRelationship.Builder
Returns
Type Description
Context.Builder

setSystemInstruction(String value)

public Context.Builder setSystemInstruction(String value)

Optional. The basic entry point for data owners creating domain knowledge for Agent.

Why: Business jargon (e.g., YTD revenue is calculated as…, Retirement Age is 65 in the USA, etc) and system instructions (e.g., answer like a Pirate) can help the model understand the business context around a user question.

string system_instruction = 1 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The systemInstruction to set.
Returns
Type Description
Context.Builder

This builder for chaining.

setSystemInstructionBytes(ByteString value)

public Context.Builder setSystemInstructionBytes(ByteString value)

Optional. The basic entry point for data owners creating domain knowledge for Agent.

Why: Business jargon (e.g., YTD revenue is calculated as…, Retirement Age is 65 in the USA, etc) and system instructions (e.g., answer like a Pirate) can help the model understand the business context around a user question.

string system_instruction = 1 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for systemInstruction to set.
Returns
Type Description
Context.Builder

This builder for chaining.

setUserFunctions(UserFunctions value)

public Context.Builder setUserFunctions(UserFunctions value)

Optional. A collection of user functions to be included in context.

.google.cloud.geminidataanalytics.v1.UserFunctions user_functions = 10 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value UserFunctions
Returns
Type Description
Context.Builder

setUserFunctions(UserFunctions.Builder builderForValue)

public Context.Builder setUserFunctions(UserFunctions.Builder builderForValue)

Optional. A collection of user functions to be included in context.

.google.cloud.geminidataanalytics.v1.UserFunctions user_functions = 10 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue UserFunctions.Builder
Returns
Type Description
Context.Builder