Some or all of the information on this page might not apply to Cloud de Confiance by S3NS. See Differences from Google Cloud for more details.

Interface ContextOrBuilder (0.21.0)

public interface ContextOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getDatasourceReferences()

public abstract 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.

getDatasourceReferencesOrBuilder()

public abstract 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`

getExampleQueries(int index)

public abstract 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`

getExampleQueriesCount()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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`

getGlossaryTermsCount()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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`

getLookerGoldenQueriesCount()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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.

getOptionsOrBuilder()

public abstract 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 abstract 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`

getSchemaRelationshipsCount()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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.

getUserFunctionsOrBuilder()

public abstract 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 abstract 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 abstract 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 abstract 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.

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2026-06-18 UTC.