google-cloud-discovery_engine-v1 0.4.2 → 0.5.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (90) hide show
  1. checksums.yaml +4 -4
  2. data/lib/google/cloud/discovery_engine/v1/completion_service/client.rb +235 -4
  3. data/lib/google/cloud/discovery_engine/v1/completion_service/operations.rb +801 -0
  4. data/lib/google/cloud/discovery_engine/v1/completion_service/rest/client.rb +221 -4
  5. data/lib/google/cloud/discovery_engine/v1/completion_service/rest/operations.rb +1091 -0
  6. data/lib/google/cloud/discovery_engine/v1/completion_service/rest/service_stub.rb +136 -0
  7. data/lib/google/cloud/discovery_engine/v1/completion_service/rest.rb +1 -0
  8. data/lib/google/cloud/discovery_engine/v1/completion_service.rb +1 -0
  9. data/lib/google/cloud/discovery_engine/v1/conversational_search_service/client.rb +20 -3
  10. data/lib/google/cloud/discovery_engine/v1/conversational_search_service/paths.rb +91 -0
  11. data/lib/google/cloud/discovery_engine/v1/conversational_search_service/rest/client.rb +20 -3
  12. data/lib/google/cloud/discovery_engine/v1/conversational_search_service/rest/service_stub.rb +45 -0
  13. data/lib/google/cloud/discovery_engine/v1/data_store_service/client.rb +924 -0
  14. data/lib/google/cloud/discovery_engine/v1/data_store_service/credentials.rb +47 -0
  15. data/lib/google/cloud/discovery_engine/v1/data_store_service/operations.rb +801 -0
  16. data/lib/google/cloud/discovery_engine/v1/data_store_service/paths.rb +97 -0
  17. data/lib/google/cloud/discovery_engine/v1/data_store_service/rest/client.rb +863 -0
  18. data/lib/google/cloud/discovery_engine/v1/data_store_service/rest/operations.rb +1091 -0
  19. data/lib/google/cloud/discovery_engine/v1/data_store_service/rest/service_stub.rb +403 -0
  20. data/lib/google/cloud/discovery_engine/v1/data_store_service/rest.rb +54 -0
  21. data/lib/google/cloud/discovery_engine/v1/data_store_service.rb +57 -0
  22. data/lib/google/cloud/discovery_engine/v1/document_service/rest/operations.rb +14 -0
  23. data/lib/google/cloud/discovery_engine/v1/engine_service/client.rb +885 -0
  24. data/lib/google/cloud/discovery_engine/v1/engine_service/credentials.rb +47 -0
  25. data/lib/google/cloud/discovery_engine/v1/engine_service/operations.rb +801 -0
  26. data/lib/google/cloud/discovery_engine/v1/engine_service/paths.rb +73 -0
  27. data/lib/google/cloud/discovery_engine/v1/engine_service/rest/client.rb +824 -0
  28. data/lib/google/cloud/discovery_engine/v1/engine_service/rest/operations.rb +1091 -0
  29. data/lib/google/cloud/discovery_engine/v1/engine_service/rest/service_stub.rb +366 -0
  30. data/lib/google/cloud/discovery_engine/v1/engine_service/rest.rb +54 -0
  31. data/lib/google/cloud/discovery_engine/v1/engine_service.rb +57 -0
  32. data/lib/google/cloud/discovery_engine/v1/rest.rb +3 -0
  33. data/lib/google/cloud/discovery_engine/v1/schema_service/rest/operations.rb +14 -0
  34. data/lib/google/cloud/discovery_engine/v1/search_service/client.rb +40 -4
  35. data/lib/google/cloud/discovery_engine/v1/search_service/paths.rb +19 -0
  36. data/lib/google/cloud/discovery_engine/v1/search_service/rest/client.rb +40 -4
  37. data/lib/google/cloud/discovery_engine/v1/search_service/rest/service_stub.rb +8 -0
  38. data/lib/google/cloud/discovery_engine/v1/site_search_engine_service/client.rb +1631 -0
  39. data/lib/google/cloud/discovery_engine/v1/site_search_engine_service/credentials.rb +47 -0
  40. data/lib/google/cloud/discovery_engine/v1/site_search_engine_service/operations.rb +801 -0
  41. data/lib/google/cloud/discovery_engine/v1/site_search_engine_service/paths.rb +127 -0
  42. data/lib/google/cloud/discovery_engine/v1/site_search_engine_service/rest/client.rb +1521 -0
  43. data/lib/google/cloud/discovery_engine/v1/site_search_engine_service/rest/operations.rb +1091 -0
  44. data/lib/google/cloud/discovery_engine/v1/site_search_engine_service/rest/service_stub.rb +860 -0
  45. data/lib/google/cloud/discovery_engine/v1/site_search_engine_service/rest.rb +53 -0
  46. data/lib/google/cloud/discovery_engine/v1/site_search_engine_service.rb +56 -0
  47. data/lib/google/cloud/discovery_engine/v1/user_event_service/rest/operations.rb +14 -0
  48. data/lib/google/cloud/discovery_engine/v1/version.rb +1 -1
  49. data/lib/google/cloud/discovery_engine/v1.rb +3 -0
  50. data/lib/google/cloud/discoveryengine/v1/common_pb.rb +5 -1
  51. data/lib/google/cloud/discoveryengine/v1/completion_pb.rb +45 -0
  52. data/lib/google/cloud/discoveryengine/v1/completion_service_pb.rb +4 -1
  53. data/lib/google/cloud/discoveryengine/v1/completion_service_services_pb.rb +8 -0
  54. data/lib/google/cloud/discoveryengine/v1/conversation_pb.rb +1 -1
  55. data/lib/google/cloud/discoveryengine/v1/conversational_search_service_pb.rb +1 -1
  56. data/lib/google/cloud/discoveryengine/v1/data_store_pb.rb +49 -0
  57. data/lib/google/cloud/discoveryengine/v1/data_store_service_pb.rb +62 -0
  58. data/lib/google/cloud/discoveryengine/v1/data_store_service_services_pb.rb +61 -0
  59. data/lib/google/cloud/discoveryengine/v1/document_pb.rb +1 -1
  60. data/lib/google/cloud/discoveryengine/v1/document_service_pb.rb +1 -1
  61. data/lib/google/cloud/discoveryengine/v1/engine_pb.rb +53 -0
  62. data/lib/google/cloud/discoveryengine/v1/engine_service_pb.rb +62 -0
  63. data/lib/google/cloud/discoveryengine/v1/engine_service_services_pb.rb +55 -0
  64. data/lib/google/cloud/discoveryengine/v1/import_config_pb.rb +7 -1
  65. data/lib/google/cloud/discoveryengine/v1/purge_config_pb.rb +6 -1
  66. data/lib/google/cloud/discoveryengine/v1/schema_pb.rb +1 -1
  67. data/lib/google/cloud/discoveryengine/v1/schema_service_pb.rb +1 -1
  68. data/lib/google/cloud/discoveryengine/v1/search_service_pb.rb +8 -1
  69. data/lib/google/cloud/discoveryengine/v1/site_search_engine_pb.rb +54 -0
  70. data/lib/google/cloud/discoveryengine/v1/site_search_engine_service_pb.rb +82 -0
  71. data/lib/google/cloud/discoveryengine/v1/site_search_engine_service_services_pb.rb +73 -0
  72. data/lib/google/cloud/discoveryengine/v1/user_event_pb.rb +1 -1
  73. data/lib/google/cloud/discoveryengine/v1/user_event_service_pb.rb +1 -1
  74. data/proto_docs/google/cloud/discoveryengine/v1/common.rb +51 -0
  75. data/proto_docs/google/cloud/discoveryengine/v1/completion.rb +53 -0
  76. data/proto_docs/google/cloud/discoveryengine/v1/completion_service.rb +10 -4
  77. data/proto_docs/google/cloud/discoveryengine/v1/conversation.rb +2 -0
  78. data/proto_docs/google/cloud/discoveryengine/v1/conversational_search_service.rb +19 -1
  79. data/proto_docs/google/cloud/discoveryengine/v1/data_store.rb +88 -0
  80. data/proto_docs/google/cloud/discoveryengine/v1/data_store_service.rb +214 -0
  81. data/proto_docs/google/cloud/discoveryengine/v1/document.rb +1 -1
  82. data/proto_docs/google/cloud/discoveryengine/v1/engine.rb +214 -0
  83. data/proto_docs/google/cloud/discoveryengine/v1/engine_service.rb +177 -0
  84. data/proto_docs/google/cloud/discoveryengine/v1/import_config.rb +66 -0
  85. data/proto_docs/google/cloud/discoveryengine/v1/purge_config.rb +41 -0
  86. data/proto_docs/google/cloud/discoveryengine/v1/search_service.rb +149 -4
  87. data/proto_docs/google/cloud/discoveryengine/v1/site_search_engine.rb +160 -0
  88. data/proto_docs/google/cloud/discoveryengine/v1/site_search_engine_service.rb +525 -0
  89. data/proto_docs/google/cloud/discoveryengine/v1/user_event.rb +3 -3
  90. metadata +48 -2
@@ -27,6 +27,8 @@ module Google
27
27
  # @!attribute [rw] serving_config
28
28
  # @return [::String]
29
29
  # Required. The resource name of the Search serving config, such as
30
+ # `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`,
31
+ # or
30
32
  # `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`.
31
33
  # This field is used to identify the serving configuration name, set
32
34
  # of models used to make the search.
@@ -77,12 +79,37 @@ module Google
77
79
  # expression is case-sensitive.
78
80
  #
79
81
  # If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
82
+ #
83
+ # Filtering in Vertex AI Search is done by mapping the LHS filter key to a
84
+ # key property defined in the Vertex AI Search backend -- this mapping is
85
+ # defined by the customer in their schema. For example a media customer might
86
+ # have a field 'name' in their schema. In this case the filter would look
87
+ # like this: filter --> name:'ANY("king kong")'
88
+ #
89
+ # For more information about filtering including syntax and filter
90
+ # operators, see
91
+ # [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
92
+ # @!attribute [rw] canonical_filter
93
+ # @return [::String]
94
+ # The default filter that is applied when a user performs a search without
95
+ # checking any filters on the search page.
96
+ #
97
+ # The filter applied to every search request when quality improvement such as
98
+ # query expansion is needed. In the case a query does not have a sufficient
99
+ # amount of results this filter will be used to determine whether or not to
100
+ # enable the query expansion flow. The original filter will still be used for
101
+ # the query expanded search.
102
+ # This field is strongly recommended to achieve high search quality.
103
+ #
104
+ # For more information about filter syntax, see
105
+ # {::Google::Cloud::DiscoveryEngine::V1::SearchRequest#filter SearchRequest.filter}.
80
106
  # @!attribute [rw] order_by
81
107
  # @return [::String]
82
108
  # The order in which documents are returned. Documents can be ordered by
83
109
  # a field in an {::Google::Cloud::DiscoveryEngine::V1::Document Document} object.
84
110
  # Leave it unset if ordered by relevance. `order_by` expression is
85
- # case-sensitive.
111
+ # case-sensitive. For more information on ordering, see
112
+ # [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order)
86
113
  #
87
114
  # If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
88
115
  # @!attribute [rw] user_info
@@ -100,6 +127,8 @@ module Google
100
127
  # @!attribute [rw] boost_spec
101
128
  # @return [::Google::Cloud::DiscoveryEngine::V1::SearchRequest::BoostSpec]
102
129
  # Boost specification to boost certain documents.
130
+ # For more information on boosting, see
131
+ # [Boosting](https://cloud.google.com/retail/docs/boosting#boost)
103
132
  # @!attribute [rw] params
104
133
  # @return [::Google::Protobuf::Map{::String => ::Google::Protobuf::Value}]
105
134
  # Additional search parameters.
@@ -108,9 +137,17 @@ module Google
108
137
  #
109
138
  # * `user_country_code`: string. Default empty. If set to non-empty, results
110
139
  # are restricted or boosted based on the location provided.
140
+ # Example:
141
+ # user_country_code: "au"
142
+ #
143
+ # For available codes see [Country
144
+ # Codes](https://developers.google.com/custom-search/docs/json_api_reference#countryCodes)
145
+ #
111
146
  # * `search_type`: double. Default empty. Enables non-webpage searching
112
- # depending on the value. The only valid non-default value is 1,
113
- # which enables image searching.
147
+ # depending on the value. The only valid non-default value is 1,
148
+ # which enables image searching.
149
+ # Example:
150
+ # search_type: 1
114
151
  # @!attribute [rw] query_expansion_spec
115
152
  # @return [::Google::Cloud::DiscoveryEngine::V1::SearchRequest::QueryExpansionSpec]
116
153
  # The query expansion specification that specifies the conditions under which
@@ -511,13 +548,50 @@ module Google
511
548
  # navigational queries. If this field is set to `true`, we skip
512
549
  # generating summaries for non-summary seeking queries and return
513
550
  # fallback messages instead.
551
+ # @!attribute [rw] model_prompt_spec
552
+ # @return [::Google::Cloud::DiscoveryEngine::V1::SearchRequest::ContentSearchSpec::SummarySpec::ModelPromptSpec]
553
+ # If specified, the spec will be used to modify the prompt provided to
554
+ # the LLM.
514
555
  # @!attribute [rw] language_code
515
556
  # @return [::String]
516
557
  # Language code for Summary. Use language tags defined by
517
- # [BCP47][https://www.rfc-editor.org/rfc/bcp/bcp47.txt].
558
+ # [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt).
559
+ # Note: This is an experimental feature.
560
+ # @!attribute [rw] model_spec
561
+ # @return [::Google::Cloud::DiscoveryEngine::V1::SearchRequest::ContentSearchSpec::SummarySpec::ModelSpec]
562
+ # If specified, the spec will be used to modify the model specification
563
+ # provided to the LLM.
518
564
  class SummarySpec
519
565
  include ::Google::Protobuf::MessageExts
520
566
  extend ::Google::Protobuf::MessageExts::ClassMethods
567
+
568
+ # Specification of the prompt to use with the model.
569
+ # @!attribute [rw] preamble
570
+ # @return [::String]
571
+ # Text at the beginning of the prompt that instructs the assistant.
572
+ # Examples are available in the user guide.
573
+ class ModelPromptSpec
574
+ include ::Google::Protobuf::MessageExts
575
+ extend ::Google::Protobuf::MessageExts::ClassMethods
576
+ end
577
+
578
+ # Specification of the model.
579
+ # @!attribute [rw] version
580
+ # @return [::String]
581
+ # The model version used to generate the summary.
582
+ #
583
+ # Supported values are:
584
+ #
585
+ # * `stable`: string. Default value when no value is specified. Uses a
586
+ # generally available, fine-tuned version of the text-bison@001
587
+ # model.
588
+ # * `preview`: string. (Public preview) Uses a fine-tuned version of
589
+ # the text-bison@002 model. This model works only for summaries in
590
+ # English.
591
+ class ModelSpec
592
+ include ::Google::Protobuf::MessageExts
593
+ extend ::Google::Protobuf::MessageExts::ClassMethods
594
+ end
521
595
  end
522
596
  end
523
597
 
@@ -653,6 +727,9 @@ module Google
653
727
  # @return [::Google::Cloud::DiscoveryEngine::V1::SearchResponse::Summary::SafetyAttributes]
654
728
  # A collection of Safety Attribute categories and their associated
655
729
  # confidence scores.
730
+ # @!attribute [rw] summary_with_metadata
731
+ # @return [::Google::Cloud::DiscoveryEngine::V1::SearchResponse::Summary::SummaryWithMetadata]
732
+ # Summary with metadata information.
656
733
  class Summary
657
734
  include ::Google::Protobuf::MessageExts
658
735
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -671,6 +748,74 @@ module Google
671
748
  extend ::Google::Protobuf::MessageExts::ClassMethods
672
749
  end
673
750
 
751
+ # Citation metadata.
752
+ # @!attribute [rw] citations
753
+ # @return [::Array<::Google::Cloud::DiscoveryEngine::V1::SearchResponse::Summary::Citation>]
754
+ # Citations for segments.
755
+ class CitationMetadata
756
+ include ::Google::Protobuf::MessageExts
757
+ extend ::Google::Protobuf::MessageExts::ClassMethods
758
+ end
759
+
760
+ # Citation info for a segment.
761
+ # @!attribute [rw] start_index
762
+ # @return [::Integer]
763
+ # Index indicates the start of the segment, measured in bytes/unicode.
764
+ # @!attribute [rw] end_index
765
+ # @return [::Integer]
766
+ # End of the attributed segment, exclusive.
767
+ # @!attribute [rw] sources
768
+ # @return [::Array<::Google::Cloud::DiscoveryEngine::V1::SearchResponse::Summary::CitationSource>]
769
+ # Citation sources for the attributed segment.
770
+ class Citation
771
+ include ::Google::Protobuf::MessageExts
772
+ extend ::Google::Protobuf::MessageExts::ClassMethods
773
+ end
774
+
775
+ # Citation source.
776
+ # @!attribute [rw] reference_index
777
+ # @return [::Integer]
778
+ # Document reference index from SummaryWithMetadata.references.
779
+ # It is 0-indexed and the value will be zero if the reference_index is
780
+ # not set explicitly.
781
+ class CitationSource
782
+ include ::Google::Protobuf::MessageExts
783
+ extend ::Google::Protobuf::MessageExts::ClassMethods
784
+ end
785
+
786
+ # Document reference.
787
+ # @!attribute [rw] title
788
+ # @return [::String]
789
+ # Title of the document.
790
+ # @!attribute [rw] document
791
+ # @return [::String]
792
+ # Required.
793
+ # {::Google::Cloud::DiscoveryEngine::V1::Document#name Document.name} of the
794
+ # document. Full resource name of the referenced document, in the format
795
+ # `projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*`.
796
+ # @!attribute [rw] uri
797
+ # @return [::String]
798
+ # Cloud Storage or HTTP uri for the document.
799
+ class Reference
800
+ include ::Google::Protobuf::MessageExts
801
+ extend ::Google::Protobuf::MessageExts::ClassMethods
802
+ end
803
+
804
+ # Summary with metadata information.
805
+ # @!attribute [rw] summary
806
+ # @return [::String]
807
+ # Summary text with no citation information.
808
+ # @!attribute [rw] citation_metadata
809
+ # @return [::Google::Cloud::DiscoveryEngine::V1::SearchResponse::Summary::CitationMetadata]
810
+ # Citation metadata for given summary.
811
+ # @!attribute [rw] references
812
+ # @return [::Array<::Google::Cloud::DiscoveryEngine::V1::SearchResponse::Summary::Reference>]
813
+ # Document References.
814
+ class SummaryWithMetadata
815
+ include ::Google::Protobuf::MessageExts
816
+ extend ::Google::Protobuf::MessageExts::ClassMethods
817
+ end
818
+
674
819
  # An Enum for summary-skipped reasons.
675
820
  module SummarySkippedReason
676
821
  # Default value. The summary skipped reason is not specified.
@@ -0,0 +1,160 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2024 Google LLC
4
+ #
5
+ # Licensed under the Apache License, Version 2.0 (the "License");
6
+ # you may not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # https://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing, software
12
+ # distributed under the License is distributed on an "AS IS" BASIS,
13
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ # See the License for the specific language governing permissions and
15
+ # limitations under the License.
16
+
17
+ # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
+
19
+
20
+ module Google
21
+ module Cloud
22
+ module DiscoveryEngine
23
+ module V1
24
+ # SiteSearchEngine captures DataStore level site search persisting
25
+ # configurations. It is a singleton value per data store.
26
+ # @!attribute [rw] name
27
+ # @return [::String]
28
+ # The fully qualified resource name of the site search engine.
29
+ # Format: `projects/*/locations/*/dataStores/*/siteSearchEngine`
30
+ class SiteSearchEngine
31
+ include ::Google::Protobuf::MessageExts
32
+ extend ::Google::Protobuf::MessageExts::ClassMethods
33
+ end
34
+
35
+ # A target site for the SiteSearchEngine.
36
+ # @!attribute [r] name
37
+ # @return [::String]
38
+ # Output only. The fully qualified resource name of the target site.
39
+ # `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}`
40
+ # The `target_site_id` is system-generated.
41
+ # @!attribute [rw] provided_uri_pattern
42
+ # @return [::String]
43
+ # Required. Input only. The user provided URI pattern from which the
44
+ # `generated_uri_pattern` is generated.
45
+ # @!attribute [rw] type
46
+ # @return [::Google::Cloud::DiscoveryEngine::V1::TargetSite::Type]
47
+ # The type of the target site, e.g., whether the site is to be included or
48
+ # excluded.
49
+ # @!attribute [rw] exact_match
50
+ # @return [::Boolean]
51
+ # Input only. If set to false, a uri_pattern is generated to include all
52
+ # pages whose address contains the provided_uri_pattern. If set to true, an
53
+ # uri_pattern is generated to try to be an exact match of the
54
+ # provided_uri_pattern or just the specific page if the provided_uri_pattern
55
+ # is a specific one. provided_uri_pattern is always normalized to
56
+ # generate the URI pattern to be used by the search engine.
57
+ # @!attribute [r] generated_uri_pattern
58
+ # @return [::String]
59
+ # Output only. This is system-generated based on the provided_uri_pattern.
60
+ # @!attribute [r] site_verification_info
61
+ # @return [::Google::Cloud::DiscoveryEngine::V1::SiteVerificationInfo]
62
+ # Output only. Site ownership and validity verification status.
63
+ # @!attribute [r] indexing_status
64
+ # @return [::Google::Cloud::DiscoveryEngine::V1::TargetSite::IndexingStatus]
65
+ # Output only. Indexing status.
66
+ # @!attribute [r] update_time
67
+ # @return [::Google::Protobuf::Timestamp]
68
+ # Output only. The target site's last updated time.
69
+ # @!attribute [r] failure_reason
70
+ # @return [::Google::Cloud::DiscoveryEngine::V1::TargetSite::FailureReason]
71
+ # Output only. Failure reason.
72
+ class TargetSite
73
+ include ::Google::Protobuf::MessageExts
74
+ extend ::Google::Protobuf::MessageExts::ClassMethods
75
+
76
+ # Site search indexing failure reasons.
77
+ # @!attribute [rw] quota_failure
78
+ # @return [::Google::Cloud::DiscoveryEngine::V1::TargetSite::FailureReason::QuotaFailure]
79
+ # Failed due to insufficient quota.
80
+ class FailureReason
81
+ include ::Google::Protobuf::MessageExts
82
+ extend ::Google::Protobuf::MessageExts::ClassMethods
83
+
84
+ # Failed due to insufficient quota.
85
+ # @!attribute [rw] total_required_quota
86
+ # @return [::Integer]
87
+ # This number is an estimation on how much total quota this project needs
88
+ # to successfully complete indexing.
89
+ class QuotaFailure
90
+ include ::Google::Protobuf::MessageExts
91
+ extend ::Google::Protobuf::MessageExts::ClassMethods
92
+ end
93
+ end
94
+
95
+ # Possible target site types.
96
+ module Type
97
+ # This value is unused. In this case, server behavior defaults to
98
+ # {::Google::Cloud::DiscoveryEngine::V1::TargetSite::Type::INCLUDE Type.INCLUDE}.
99
+ TYPE_UNSPECIFIED = 0
100
+
101
+ # Include the target site.
102
+ INCLUDE = 1
103
+
104
+ # Exclude the target site.
105
+ EXCLUDE = 2
106
+ end
107
+
108
+ # Target site indexing status enumeration.
109
+ module IndexingStatus
110
+ # Defaults to SUCCEEDED.
111
+ INDEXING_STATUS_UNSPECIFIED = 0
112
+
113
+ # The target site is in the update queue and will be picked up by indexing
114
+ # pipeline.
115
+ PENDING = 1
116
+
117
+ # The target site fails to be indexed.
118
+ FAILED = 2
119
+
120
+ # The target site has been indexed.
121
+ SUCCEEDED = 3
122
+
123
+ # The previously indexed target site has been marked to be deleted. This is
124
+ # a transitioning state which will resulted in either:
125
+ # 1. target site deleted if unindexing is successful;
126
+ # 2. state reverts to SUCCEEDED if the unindexing fails.
127
+ DELETING = 4
128
+ end
129
+ end
130
+
131
+ # Verification information for target sites in advanced site search.
132
+ # @!attribute [rw] site_verification_state
133
+ # @return [::Google::Cloud::DiscoveryEngine::V1::SiteVerificationInfo::SiteVerificationState]
134
+ # Site verification state indicating the ownership and validity.
135
+ # @!attribute [rw] verify_time
136
+ # @return [::Google::Protobuf::Timestamp]
137
+ # Latest site verification time.
138
+ class SiteVerificationInfo
139
+ include ::Google::Protobuf::MessageExts
140
+ extend ::Google::Protobuf::MessageExts::ClassMethods
141
+
142
+ # Site verification state.
143
+ module SiteVerificationState
144
+ # Defaults to VERIFIED.
145
+ SITE_VERIFICATION_STATE_UNSPECIFIED = 0
146
+
147
+ # Site ownership verified.
148
+ VERIFIED = 1
149
+
150
+ # Site ownership pending verification or verification failed.
151
+ UNVERIFIED = 2
152
+
153
+ # Site exempt from verification, e.g., a public website that opens to all.
154
+ EXEMPTED = 3
155
+ end
156
+ end
157
+ end
158
+ end
159
+ end
160
+ end