Package types (0.13.10)

Configuration data for advance site search.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

AlloyDB source import data from.

Defines an answer.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Request message for ConversationalSearchService.AnswerQuery method.

Response message for ConversationalSearchService.AnswerQuery method.

AssistAnswer resource, main part of AssistResponse.

User metadata of the request.

Discovery Engine Assistant resource.

Multi-modal content.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

A piece of content and possibly its grounding information.

Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Metadata related to the progress of the SiteSearchEngineService.BatchCreateTargetSites operation. This will be returned by the google.longrunning.Operation.metadata field.

Request message for SiteSearchEngineService.BatchCreateTargetSites method.

Response message for SiteSearchEngineService.BatchCreateTargetSites method.

Request message for DocumentService.BatchGetDocumentsMetadata method.

Response message for DocumentService.BatchGetDocumentsMetadata method.

Metadata related to the progress of the UserLicenseService.BatchUpdateUserLicenses operation. This will be returned by the google.longrunning.Operation.metadata field.

Request message for UserLicenseService.BatchUpdateUserLicenses method.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Response message for UserLicenseService.BatchUpdateUserLicenses method.

Metadata related to the progress of the SiteSearchEngineService.BatchVerifyTargetSites operation. This will be returned by the google.longrunning.Operation.metadata field.

Request message for SiteSearchEngineService.BatchVerifyTargetSites method.

Response message for SiteSearchEngineService.BatchVerifyTargetSites method.

BigQuery source import data from.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

The Bigtable Options object that contains information to support the import.

The Cloud Bigtable source for importing data.

Request message for GroundedGenerationService.CheckGrounding method.

Response message for the GroundedGenerationService.CheckGrounding method.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Specification for the grounding check.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Chunk captures all raw metadata information of items to be recommended or searched in the chunk mode.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Cloud SQL source import data from.

Configurations used to enable CMEK data encryption with Cloud KMS keys.

Request message for CollectUserEvent method.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Request message for CompletionService.CompleteQuery method.

Response message for CompletionService.CompleteQuery method.

Detailed completion information including completion attribution token and clicked completion info.

Autocomplete suggestions that are imported from Customer.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Defines circumstances to be checked before allowing a behavior

Defines a conditioned behavior to employ during serving. Must be attached to a ServingConfig to be considered at serving time. Permitted actions dependent on SolutionType.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

External conversation proto definition.

Defines context of the conversation

Defines a conversation message.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Request message for ConversationalSearchService.ConverseConversation method.

Response message for ConversationalSearchService.ConverseConversation method.

Request for CreateControl method.

Request for CreateConversation method.

Metadata related to the progress of the DataStoreService.CreateDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.

Request for DataStoreService.CreateDataStore method.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Request message for DocumentService.CreateDocument method.

Metadata related to the progress of the EngineService.CreateEngine operation. This will be returned by the google.longrunning.Operation.metadata field.

Request for EngineService.CreateEngine method.

Request message for IdentityMappingStoreService.CreateIdentityMappingStore

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Metadata for Create Schema LRO.

Request message for SchemaService.CreateSchema method.

Request for CreateSession method.

Metadata related to the progress of the SiteSearchEngineService.CreateSitemap operation. This will be returned by the google.longrunning.Operation.metadata field.

Request message for SiteSearchEngineService.CreateSitemap method.

Metadata related to the progress of the SiteSearchEngineService.CreateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.

Request message for SiteSearchEngineService.CreateTargetSite method.

A custom attribute that is not explicitly modeled in a resource, e.g. UserEvent.

Metadata that describes a custom tuned model.

DataStore captures global settings and configs at the DataStore level.

Metadata related to the progress of the CmekConfigService.DeleteCmekConfig operation. This will be returned by the google.longrunning.Operation.metadata field.

Request message for CmekConfigService.DeleteCmekConfig method.

Request for DeleteControl method.

Request for DeleteConversation method.

Metadata related to the progress of the DataStoreService.DeleteDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.

Request message for DataStoreService.DeleteDataStore method.

Request message for DocumentService.DeleteDocument method.

Metadata related to the progress of the EngineService.DeleteEngine operation. This will be returned by the google.longrunning.Operation.metadata field.

Request message for EngineService.DeleteEngine method.

Metadata related to the progress of the IdentityMappingStoreService.DeleteIdentityMappingStore operation. This will be returned by the google.longrunning.Operation.metadata field.

Request message for IdentityMappingStoreService.DeleteIdentityMappingStore

Metadata for DeleteSchema LRO.

Request message for SchemaService.DeleteSchema method.

Request for DeleteSession method.

Metadata related to the progress of the SiteSearchEngineService.DeleteSitemap operation. This will be returned by the google.longrunning.Operation.metadata field.

Request message for SiteSearchEngineService.DeleteSitemap method.

Metadata related to the progress of the SiteSearchEngineService.DeleteTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.

Request message for SiteSearchEngineService.DeleteTargetSite method.

Metadata related to the progress of the SiteSearchEngineService.DisableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.

Request message for SiteSearchEngineService.DisableAdvancedSiteSearch method.

Response message for SiteSearchEngineService.DisableAdvancedSiteSearch method.

Document captures all raw metadata information of items to be recommended or searched.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Detailed document information associated with a user event.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

A singleton resource of DataStore. If it's empty when DataStore is created and DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED, the default parser will default to digital parser.

Double list.

Metadata related to the progress of the SiteSearchEngineService.EnableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.

Request message for SiteSearchEngineService.EnableAdvancedSiteSearch method.

Response message for SiteSearchEngineService.EnableAdvancedSiteSearch method.

Metadata that describes the training and serving parameters of an Engine.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Fact Chunk.

Request message for SiteSearchEngineService.FetchDomainVerificationStatus method.

Response message for SiteSearchEngineService.FetchDomainVerificationStatus method.

Request message for SiteSearchEngineService.FetchSitemaps method.

Response message for SiteSearchEngineService.FetchSitemaps method.

Cloud FhirStore source import data from.

Firestore source import data from.

Cloud Storage ___location for input content.

Top-level message sent by the client for the GenerateGroundedContent method.

Response for the GenerateGroundedContent method.

Request for GetAnswer method.

Request message for GetCmekConfigRequest method.

Request for GetControl method.

Request for GetConversation method.

Request message for DataStoreService.GetDataStore method.

Request message for DocumentService.GetDocument method.

Request message for EngineService.GetEngine method.

Request message for IdentityMappingStoreService.GetIdentityMappingStore

Request message for SchemaService.GetSchema method.

Request for GetSession method.

Request message for SiteSearchEngineService.GetSiteSearchEngine method.

Request message for SiteSearchEngineService.GetTargetSite method.

Base structured datatype containing multi-part content of a message.

Grounding Fact.

Harm categories that will block the content.

Config to data store for HEALTHCARE_FHIR vertical.

Identity Mapping Entry that maps an external identity to an internal identity.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

IdentityMappingEntry LongRunningOperation metadata for IdentityMappingStoreService.ImportIdentityMappings and IdentityMappingStoreService.PurgeIdentityMappings

Identity Mapping Store which contains Identity Mapping Entries.

Metadata related to the progress of the ImportCompletionSuggestions operation. This will be returned by the google.longrunning.Operation.metadata field.

Request message for CompletionService.ImportCompletionSuggestions method.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Response of the CompletionService.ImportCompletionSuggestions method. If the long running operation is done, this message is returned by the google.longrunning.Operations.response field if the operation is successful.

Metadata related to the progress of the ImportDocuments operation. This is returned by the google.longrunning.Operation.metadata field.

Request message for Import methods.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Response of the ImportDocumentsRequest. If the long running operation is done, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.

Configuration of destination for Import related errors.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Request message for IdentityMappingStoreService.ImportIdentityMappings

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Response message for IdentityMappingStoreService.ImportIdentityMappings

Metadata related to the progress of the ImportSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.

Request message for CompletionService.ImportSuggestionDenyListEntries method.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Response message for CompletionService.ImportSuggestionDenyListEntries method.

Metadata related to the progress of the Import operation. This is returned by the google.longrunning.Operation.metadata field.

Request message for the ImportUserEvents request.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Response of the ImportUserEventsRequest. If the long running operation was successful, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.

The industry vertical associated with the DataStore.

A floating point interval.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Request message for CmekConfigService.ListCmekConfigs method.

Response message for CmekConfigService.ListCmekConfigs method.

Request for ListControls method.

Response for ListControls method.

Request for ListConversations method.

Response for ListConversations method.

Request message for SearchTuningService.ListCustomModels method.

Response message for SearchTuningService.ListCustomModels method.

Request message for DataStoreService.ListDataStores method.

Response message for DataStoreService.ListDataStores method.

Request message for DocumentService.ListDocuments method.

Response message for DocumentService.ListDocuments method.

Request message for EngineService.ListEngines method.

Response message for EngineService.ListEngines method.

Request message for IdentityMappingStoreService.ListIdentityMappingStores

Response message for IdentityMappingStoreService.ListIdentityMappingStores

Request message for IdentityMappingStoreService.ListIdentityMappings

Response message for IdentityMappingStoreService.ListIdentityMappings

Request message for SchemaService.ListSchemas method.

Response message for SchemaService.ListSchemas method.

Request for ListSessions method.

Response for ListSessions method.

Request message for SiteSearchEngineService.ListTargetSites method.

Response message for SiteSearchEngineService.ListTargetSites method.

Request message for UserLicenseService.ListUserLicenses.

Response message for UserLicenseService.ListUserLicenses.

Media-specific user event information.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Detailed page information.

Detailed panel information associated with a user event.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Principal identifier of a user or a group.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Metadata and configurations for a Google Cloud project in the service.

Metadata associated with a project provision operation.

Request for ProjectService.ProvisionProject method.

Metadata related to the progress of the PurgeCompletionSuggestions operation. This is returned by the google.longrunning.Operation.metadata field.

Request message for CompletionService.PurgeCompletionSuggestions method.

Response message for CompletionService.PurgeCompletionSuggestions method.

Metadata related to the progress of the PurgeDocuments operation. This will be returned by the google.longrunning.Operation.metadata field.

Request message for DocumentService.PurgeDocuments method.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Response message for DocumentService.PurgeDocuments method. If the long running operation is successfully done, then this message is returned by the google.longrunning.Operations.response field.

Configuration of destination for Purge related errors.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Request message for IdentityMappingStoreService.PurgeIdentityMappings

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Metadata related to the progress of the PurgeSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.

Request message for CompletionService.PurgeSuggestionDenyListEntries method.

Response message for CompletionService.PurgeSuggestionDenyListEntries method.

Metadata related to the progress of the PurgeUserEvents operation. This will be returned by the google.longrunning.Operation.metadata field.

Request message for PurgeUserEvents method.

Response of the PurgeUserEventsRequest. If the long running operation is successfully done, then this message is returned by the google.longrunning.Operations.response field.

Defines a user inputed query.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Request message for RankService.Rank method.

Response message for RankService.Rank method.

Record message for RankService.Rank method.

Request message for Recommend method.

Response message for Recommend method.

Metadata related to the progress of the SiteSearchEngineService.RecrawlUris operation. This will be returned by the google.longrunning.Operation.metadata field.

Request message for SiteSearchEngineService.RecrawlUris method.

Response message for SiteSearchEngineService.RecrawlUris method.

Defines a reply message to user.

Safety rating corresponding to the generated content.

Defines the structure and layout of a type of document data.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Add-on that provides additional functionality for search.

Detailed search information.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Promotion proto includes uri and other helping information to display the promotion.

Request message for SearchService.Search method.

Response message for SearchService.Search method.

Tiers of search features. Different tiers might have different pricing. To learn more, check the pricing documentation.

Defines a further subdivision of SolutionType. Specifically applies to SOLUTION_TYPE_SEARCH.

Configures metadata that is used to generate serving time results (e.g. search results or recommendation predictions). The ServingConfig is passed in the search and predict request and generates results.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

External session proto definition.

Metadata for single-regional CMEKs.

SiteSearchEngine captures DataStore level site search persisting configurations. It is a singleton value per data store.

Verification information for target sites in advanced site search.

A sitemap for the SiteSearchEngine.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

The type of solution.

The Spanner source for importing data

Request for the AssistantService.StreamAssist method.

Response for the AssistantService.StreamAssist method.

Suggestion deny list entry identifying the phrase to block from suggestions and the applied operation for the phrase.

A target site for the SiteSearchEngine.

Defines text input.

Metadata related to the progress of the TrainCustomModel operation. This is returned by the google.longrunning.Operation.metadata field.

Request message for SearchTuningService.TrainCustomModel method.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Response of the TrainCustomModelRequest. This message is returned by the google.longrunning.Operations.response field.

A transaction represents the entire purchase transaction.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Metadata related to the progress of the CmekConfigService.UpdateCmekConfig operation. This will be returned by the google.longrunning.Operation.metadata field.

Request message for UpdateCmekConfig method. rpc.

Request for UpdateControl method.

Request for UpdateConversation method.

Request message for DataStoreService.UpdateDataStore method.

Request message for DocumentService.UpdateDocument method.

Request message for EngineService.UpdateEngine method.

Metadata for UpdateSchema LRO.

Request message for SchemaService.UpdateSchema method.

Request for UpdateServingConfig method.

Request for UpdateSession method.

Metadata related to the progress of the SiteSearchEngineService.UpdateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.

Request message for SiteSearchEngineService.UpdateTargetSite method.

UserEvent captures all metadata information Discovery Engine API needs to know about how end users interact with your website.

Information of an end user.

User License information assigned by the admin.

Config to store data store type configuration for workspace data

Request message for WriteUserEvent method.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields