Classes
AnalysisEvent
An event indicating the progress of an analysis.
AnalysisMessage
A message produced during analysis.
AnalysisOptions
Options for analysis.
AnalysisOptions.Types
Container for nested types declared in the AnalysisOptions message type.
AnalysisOptions.Types.Python
Options for Python analysis.
AnalysisQuery
A query for performing an analysis.
BigQueryJob
A BigQuery job executed by the system.
BigQueryTableReference
Message representing a reference to a single BigQuery table.
BigQueryTableReferences
Message representing references to BigQuery tables.
Blob
A blob of data with a MIME type.
ChartMessage
A message produced during chart generation.
ChartOptions
Options for chart generation.
ChartOptions.Types
Container for nested types declared in the ChartOptions message type.
ChartOptions.Types.ImageOptions
Options for rendering images of generated charts.
ChartOptions.Types.ImageOptions.Types
Container for nested types declared in the ImageOptions message type.
ChartOptions.Types.ImageOptions.Types.NoImage
No image.
ChartOptions.Types.ImageOptions.Types.SvgOptions
SVG options.
ChartQuery
A query for generating a chart.
ChartResult
The result of a chart generation query.
ChatRequest
Request for Chat.
ClientManagedResourceContext
Context with client managed resources. Some clients may not use GDA managed resources including conversations and agents, instead they create and manage their own conversations and agents resources.
Context
A collection of context to apply to this conversation
Context.Types
Container for nested types declared in the Context message type.
Context.Types.SchemaRelationship
The relationship between two tables, including referencing and referenced columns. This is a derived context retrieved from Dataplex Dataset Insights.
Context.Types.SchemaRelationship.Types
Container for nested types declared in the SchemaRelationship message type.
Context.Types.SchemaRelationship.Types.SchemaPaths
Represents an ordered set of paths within the table schema.
Conversation
Message for a conversation.
ConversationName
Resource name for the Conversation resource.
ConversationOptions
Options for the conversation.
ConversationReference
Reference to a persisted conversation and agent context.
CreateConversationRequest
Request for creating a conversation.
CreateDataAgentRequest
Message for creating a DataAgent.
Credentials
Represents different forms of credential specification.
DataAgent
Message describing a DataAgent object.
DataAgentContext
Context for the chat request using a data agent.
DataAgentContext.Types
Container for nested types declared in the DataAgentContext message type.
DataAgentName
Resource name for the DataAgent resource.
DataAgentService
Service describing handlers for resources.
DataAgentService.DataAgentServiceBase
Base class for server-side implementations of DataAgentService
DataAgentService.DataAgentServiceClient
Client for DataAgentService
DataAgentServiceClient
DataAgentService client wrapper, for convenient use.
DataAgentServiceClientBuilder
Builder class for DataAgentServiceClient to provide simple configuration of credentials, endpoint etc.
DataAgentServiceClientImpl
DataAgentService client wrapper implementation, for convenient use.
DataAgentServiceSettings
Settings for DataAgentServiceClient instances.
DataAnalyticsAgent
Message describing a DataAnalyticsAgent object.
DataChatService
Service to ask a natural language question on top of BigQuery and Looker Studio datasources to get back streamed responses of various kinds to help provide a rich conversational answer.
DataChatService.DataChatServiceBase
Base class for server-side implementations of DataChatService
DataChatService.DataChatServiceClient
Client for DataChatService
DataChatServiceClient
DataChatService client wrapper, for convenient use.
DataChatServiceClient.ChatStream
Server streaming methods for Chat(ChatRequest, CallSettings).
DataChatServiceClientBuilder
Builder class for DataChatServiceClient to provide simple configuration of credentials, endpoint etc.
DataChatServiceClientImpl
DataChatService client wrapper implementation, for convenient use.
DataChatServiceSettings
Settings for DataChatServiceClient instances.
DataFilter
A filter on a datasource's underlying data. Filter syntax documentation: https://cloud.google.com/looker/docs/filter-expressions
DataMessage
A message produced during data retrieval.
DataQuery
A query for retrieving data.
DataResult
Retrieved data.
Datasource
A datasource that can be used to answer questions.
DatasourceOptions
Options for datasources configurations.
DatasourceReferences
A collection of references to datasources.
DeleteConversationRequest
Request for deleting a conversation based on parent and conversation id.
DeleteDataAgentRequest
Message for deleting a DataAgent.
ErrorMessage
An error message from a tool call. This message is used to represent an error that occurred while an agent was trying to use a tool. It's important to note that not all errors are terminal. Many are recoverable, and the agent may use the information from this error message to self-correct and retry the tool call or try a different approach.
For example, if a data query fails, the agent might receive an
ErrorMessage, analyze it, and then generate a corrected query.
Clients should be cautious about interpreting this message as a definitive failure. It can be part of the agent's normal, iterative process of completing a task. Surfacing these errors directly to end-users without context (e.g., as a "hard failure") may be misleading.
ExampleQueries
A message containing derived and authored example queries.
ExampleQuery
Example of relevant and commonly used SQL query and its corresponding natural language queries optionally present. Currently only used for BigQuery data sources.
Field
A field in a schema.
GetConversationRequest
Request for getting a conversation based on parent and conversation id.
GetDataAgentRequest
Message for getting a DataAgent.
GlossaryTerm
Definition of a term within a specific domain.
ListAccessibleDataAgentsRequest
Message for requesting list of accessible DataAgents.
ListAccessibleDataAgentsRequest.Types
Container for nested types declared in the ListAccessibleDataAgentsRequest message type.
ListAccessibleDataAgentsResponse
Message for response to listing accessible DataAgents.
ListConversationsRequest
Request for listing conversations based on parent.
ListConversationsResponse
Message for response to listing conversations.
ListDataAgentsRequest
Message for requesting list of DataAgents.
ListDataAgentsResponse
Message for response to listing DataAgents.
ListMessagesRequest
Request for listing chat messages based on parent and conversation_id.
ListMessagesResponse
Response for listing chat messages.
LookerExploreReference
Message representing a reference to a single Looker explore.
LookerExploreReferences
Message representing references to Looker explores.
LookerQuery
A query for retrieving data from a Looker Explore. See Run Inline Query.
LookerQuery.Types
Container for nested types declared in the LookerQuery message type.
LookerQuery.Types.Filter
A Looker query filter.
Message
A message from an interaction between the user and the system.
OAuthCredentials
Represents OAuth credentials.
OAuthCredentials.Types
Container for nested types declared in the OAuthCredentials message type.
OAuthCredentials.Types.SecretBased
The name of the secret containing the access token. Represents secret-based OAuth credentials.
OAuthCredentials.Types.TokenBased
Read more about Looker access tokens here: https://developers.looker.com/api/advanced-usage/looker-api-oauth
OperationMetadata
Represents the metadata of the long-running operation.
PrivateLookerInstanceInfo
Message representing a private Looker instance info required if the Looker instance is behind a private network.
Schema
The schema of a Datasource or QueryResult instance.
SchemaMessage
A message produced during schema resolution.
SchemaQuery
A query for resolving the schema relevant to the posed question.
SchemaResult
The result of schema resolution.
StorageMessage
A stored message containing user message or system message.
StudioDatasourceReference
Message representing a reference to a single Looker Studio datasource.
StudioDatasourceReferences
Message representing references to Looker Studio datasources.
SystemMessage
A message from the system in response to the user. This message can also be a message from the user as historical context for multiturn conversations with the system.
TextMessage
A multi-part text message.
TextMessage.Types
Container for nested types declared in the TextMessage message type.
UpdateDataAgentRequest
Message for updating a DataAgent.
UserMessage
A message from the user that is interacting with the system.
Enums
AnalysisEvent.KindOneofCase
Enum of possible cases for the "kind" oneof.
AnalysisMessage.KindOneofCase
Enum of possible cases for the "kind" oneof.
ChartMessage.KindOneofCase
Enum of possible cases for the "kind" oneof.
ChartOptions.Types.ImageOptions.KindOneofCase
Enum of possible cases for the "kind" oneof.
ChatRequest.ContextProviderOneofCase
Enum of possible cases for the "context_provider" oneof.
Context.Types.SchemaRelationship.Types.Source
Source which generated the schema relation edge.
ConversationName.ResourceNameType
The possible contents of ConversationName.
Credentials.KindOneofCase
Enum of possible cases for the "kind" oneof.
DataAgent.TypeOneofCase
Enum of possible cases for the "type" oneof.
DataAgentContext.Types.ContextVersion
List of context versions supported by DCS. There are two versions of context. This is to maintain versioning for the data agent.
DataAgentName.ResourceNameType
The possible contents of DataAgentName.
DataFilterType
The type of filter present on a datasource, such as ALWAYS_FILTER.
DataMessage.KindOneofCase
Enum of possible cases for the "kind" oneof.
DataQuery.QueryTypeOneofCase
Enum of possible cases for the "query_type" oneof.
Datasource.ReferenceOneofCase
Enum of possible cases for the "reference" oneof.
DatasourceReferences.ReferencesOneofCase
Enum of possible cases for the "references" oneof.
ExampleQuery.QueryOneofCase
Enum of possible cases for the "query" oneof.
ListAccessibleDataAgentsRequest.Types.CreatorFilter
Filter for the creator of the agent.
LookerExploreReference.InstanceOneofCase
Enum of possible cases for the "instance" oneof.
Message.KindOneofCase
Enum of possible cases for the "kind" oneof.
OAuthCredentials.KindOneofCase
Enum of possible cases for the "kind" oneof.
SchemaMessage.KindOneofCase
Enum of possible cases for the "kind" oneof.
SystemMessage.KindOneofCase
Enum of possible cases for the "kind" oneof.
TextMessage.Types.TextType
The type of the text message.
UserMessage.KindOneofCase
Enum of possible cases for the "kind" oneof.