google-cloud-discovery_engine-v1 2.3.0 → 2.4.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/AUTHENTICATION.md +4 -4
- data/README.md +4 -4
- data/lib/google/cloud/discovery_engine/v1/assistant_service/client.rb +509 -0
- data/lib/google/cloud/discovery_engine/v1/assistant_service/credentials.rb +47 -0
- data/lib/google/cloud/discovery_engine/v1/assistant_service/paths.rb +169 -0
- data/lib/google/cloud/discovery_engine/v1/assistant_service/rest/client.rb +478 -0
- data/lib/google/cloud/discovery_engine/v1/assistant_service/rest/service_stub.rb +137 -0
- data/lib/google/cloud/discovery_engine/v1/assistant_service/rest.rb +52 -0
- data/lib/google/cloud/discovery_engine/v1/assistant_service.rb +55 -0
- data/lib/google/cloud/discovery_engine/v1/completion_service/client.rb +5 -5
- data/lib/google/cloud/discovery_engine/v1/completion_service/rest/client.rb +5 -5
- data/lib/google/cloud/discovery_engine/v1/conversational_search_service/client.rb +16 -4
- data/lib/google/cloud/discovery_engine/v1/conversational_search_service/rest/client.rb +16 -4
- data/lib/google/cloud/discovery_engine/v1/data_store_service/client.rb +2 -2
- data/lib/google/cloud/discovery_engine/v1/data_store_service/rest/client.rb +2 -2
- data/lib/google/cloud/discovery_engine/v1/document_service/client.rb +11 -11
- data/lib/google/cloud/discovery_engine/v1/document_service/rest/client.rb +11 -11
- data/lib/google/cloud/discovery_engine/v1/identity_mapping_store_service/client.rb +2 -2
- data/lib/google/cloud/discovery_engine/v1/identity_mapping_store_service/rest/client.rb +2 -2
- data/lib/google/cloud/discovery_engine/v1/rest.rb +4 -2
- data/lib/google/cloud/discovery_engine/v1/search_service/client.rb +16 -28
- data/lib/google/cloud/discovery_engine/v1/search_service/rest/client.rb +16 -28
- data/lib/google/cloud/discovery_engine/v1/session_service/client.rb +920 -0
- data/lib/google/cloud/discovery_engine/v1/session_service/credentials.rb +47 -0
- data/lib/google/cloud/discovery_engine/v1/session_service/paths.rb +330 -0
- data/lib/google/cloud/discovery_engine/v1/session_service/rest/client.rb +859 -0
- data/lib/google/cloud/discovery_engine/v1/session_service/rest/service_stub.rb +462 -0
- data/lib/google/cloud/discovery_engine/v1/session_service/rest.rb +52 -0
- data/lib/google/cloud/discovery_engine/v1/session_service.rb +55 -0
- data/lib/google/cloud/discovery_engine/v1/user_event_service/client.rb +3 -3
- data/lib/google/cloud/discovery_engine/v1/user_event_service/rest/client.rb +3 -3
- data/lib/google/cloud/discovery_engine/v1/version.rb +1 -1
- data/lib/google/cloud/discovery_engine/v1.rb +5 -3
- data/lib/google/cloud/discoveryengine/v1/assist_answer_pb.rb +59 -0
- data/lib/google/cloud/discoveryengine/v1/assistant_pb.rb +45 -0
- data/lib/google/cloud/discoveryengine/v1/assistant_service_pb.rb +62 -0
- data/lib/google/cloud/discoveryengine/v1/assistant_service_services_pb.rb +45 -0
- data/lib/google/cloud/discoveryengine/v1/session_pb.rb +1 -1
- data/lib/google/cloud/discoveryengine/v1/session_service_pb.rb +49 -0
- data/lib/google/cloud/discoveryengine/v1/session_service_services_pb.rb +64 -0
- data/proto_docs/google/cloud/discoveryengine/v1/assist_answer.rb +278 -0
- data/proto_docs/google/cloud/discoveryengine/v1/assistant.rb +39 -0
- data/proto_docs/google/cloud/discoveryengine/v1/assistant_service.rb +207 -0
- data/proto_docs/google/cloud/discoveryengine/v1/conversational_search_service.rb +15 -3
- data/proto_docs/google/cloud/discoveryengine/v1/search_service.rb +8 -14
- data/proto_docs/google/cloud/discoveryengine/v1/session.rb +20 -4
- metadata +24 -1
@@ -0,0 +1,137 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Copyright 2025 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
|
+
require "google/cloud/discoveryengine/v1/assistant_service_pb"
|
20
|
+
|
21
|
+
module Google
|
22
|
+
module Cloud
|
23
|
+
module DiscoveryEngine
|
24
|
+
module V1
|
25
|
+
module AssistantService
|
26
|
+
module Rest
|
27
|
+
##
|
28
|
+
# REST service stub for the AssistantService service.
|
29
|
+
# Service stub contains baseline method implementations
|
30
|
+
# including transcoding, making the REST call, and deserialing the response.
|
31
|
+
#
|
32
|
+
class ServiceStub
|
33
|
+
# @private
|
34
|
+
def initialize endpoint:, endpoint_template:, universe_domain:, credentials:, logger:
|
35
|
+
# These require statements are intentionally placed here to initialize
|
36
|
+
# the REST modules only when it's required.
|
37
|
+
require "gapic/rest"
|
38
|
+
|
39
|
+
@client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint,
|
40
|
+
endpoint_template: endpoint_template,
|
41
|
+
universe_domain: universe_domain,
|
42
|
+
credentials: credentials,
|
43
|
+
numeric_enums: true,
|
44
|
+
service_name: self.class,
|
45
|
+
raise_faraday_errors: false,
|
46
|
+
logger: logger
|
47
|
+
end
|
48
|
+
|
49
|
+
##
|
50
|
+
# The effective universe domain
|
51
|
+
#
|
52
|
+
# @return [String]
|
53
|
+
#
|
54
|
+
def universe_domain
|
55
|
+
@client_stub.universe_domain
|
56
|
+
end
|
57
|
+
|
58
|
+
##
|
59
|
+
# The effective endpoint
|
60
|
+
#
|
61
|
+
# @return [String]
|
62
|
+
#
|
63
|
+
def endpoint
|
64
|
+
@client_stub.endpoint
|
65
|
+
end
|
66
|
+
|
67
|
+
##
|
68
|
+
# The logger used for request/response debug logging.
|
69
|
+
#
|
70
|
+
# @return [Logger]
|
71
|
+
#
|
72
|
+
def logger stub: false
|
73
|
+
stub ? @client_stub.stub_logger : @client_stub.logger
|
74
|
+
end
|
75
|
+
|
76
|
+
##
|
77
|
+
# Baseline implementation for the stream_assist REST call
|
78
|
+
#
|
79
|
+
# @param request_pb [::Google::Cloud::DiscoveryEngine::V1::StreamAssistRequest]
|
80
|
+
# A request object representing the call parameters. Required.
|
81
|
+
# @param options [::Gapic::CallOptions]
|
82
|
+
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
|
83
|
+
#
|
84
|
+
# @yieldparam chunk [::String] The chunk of data received during server streaming.
|
85
|
+
#
|
86
|
+
# @return [::Gapic::Rest::TransportOperation]
|
87
|
+
def stream_assist(request_pb, options = nil, &)
|
88
|
+
raise ::ArgumentError, "request must be provided" if request_pb.nil?
|
89
|
+
|
90
|
+
verb, uri, query_string_params, body = ServiceStub.transcode_stream_assist_request request_pb
|
91
|
+
query_string_params = if query_string_params.any?
|
92
|
+
query_string_params.to_h { |p| p.split "=", 2 }
|
93
|
+
else
|
94
|
+
{}
|
95
|
+
end
|
96
|
+
|
97
|
+
response = @client_stub.make_http_request(
|
98
|
+
verb,
|
99
|
+
uri: uri,
|
100
|
+
body: body || "",
|
101
|
+
params: query_string_params,
|
102
|
+
method_name: "stream_assist",
|
103
|
+
options: options,
|
104
|
+
is_server_streaming: true,
|
105
|
+
&
|
106
|
+
)
|
107
|
+
::Gapic::Rest::TransportOperation.new response
|
108
|
+
end
|
109
|
+
|
110
|
+
##
|
111
|
+
# @private
|
112
|
+
#
|
113
|
+
# GRPC transcoding helper method for the stream_assist REST call
|
114
|
+
#
|
115
|
+
# @param request_pb [::Google::Cloud::DiscoveryEngine::V1::StreamAssistRequest]
|
116
|
+
# A request object representing the call parameters. Required.
|
117
|
+
# @return [Array(String, [String, nil], Hash{String => String})]
|
118
|
+
# Uri, Body, Query string parameters
|
119
|
+
def self.transcode_stream_assist_request request_pb
|
120
|
+
transcoder = Gapic::Rest::GrpcTranscoder.new
|
121
|
+
.with_bindings(
|
122
|
+
uri_method: :post,
|
123
|
+
uri_template: "/v1/{name}:streamAssist",
|
124
|
+
body: "*",
|
125
|
+
matches: [
|
126
|
+
["name", %r{^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/assistants/[^/]+/?$}, false]
|
127
|
+
]
|
128
|
+
)
|
129
|
+
transcoder.transcode request_pb
|
130
|
+
end
|
131
|
+
end
|
132
|
+
end
|
133
|
+
end
|
134
|
+
end
|
135
|
+
end
|
136
|
+
end
|
137
|
+
end
|
@@ -0,0 +1,52 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Copyright 2025 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
|
+
require "gapic/rest"
|
20
|
+
require "gapic/config"
|
21
|
+
require "gapic/config/method"
|
22
|
+
|
23
|
+
require "google/cloud/discovery_engine/v1/version"
|
24
|
+
|
25
|
+
require "google/cloud/discovery_engine/v1/assistant_service/credentials"
|
26
|
+
require "google/cloud/discovery_engine/v1/assistant_service/paths"
|
27
|
+
require "google/cloud/discovery_engine/v1/assistant_service/rest/client"
|
28
|
+
|
29
|
+
module Google
|
30
|
+
module Cloud
|
31
|
+
module DiscoveryEngine
|
32
|
+
module V1
|
33
|
+
##
|
34
|
+
# Service for managing Assistant configuration and assisting users.
|
35
|
+
#
|
36
|
+
# To load this service and instantiate a REST client:
|
37
|
+
#
|
38
|
+
# require "google/cloud/discovery_engine/v1/assistant_service/rest"
|
39
|
+
# client = ::Google::Cloud::DiscoveryEngine::V1::AssistantService::Rest::Client.new
|
40
|
+
#
|
41
|
+
module AssistantService
|
42
|
+
# Client for the REST transport
|
43
|
+
module Rest
|
44
|
+
end
|
45
|
+
end
|
46
|
+
end
|
47
|
+
end
|
48
|
+
end
|
49
|
+
end
|
50
|
+
|
51
|
+
helper_path = ::File.join __dir__, "rest", "helpers.rb"
|
52
|
+
require "google/cloud/discovery_engine/v1/assistant_service/rest/helpers" if ::File.file? helper_path
|
@@ -0,0 +1,55 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Copyright 2025 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
|
+
require "gapic/common"
|
20
|
+
require "gapic/config"
|
21
|
+
require "gapic/config/method"
|
22
|
+
|
23
|
+
require "google/cloud/discovery_engine/v1/version"
|
24
|
+
|
25
|
+
require "google/cloud/discovery_engine/v1/assistant_service/credentials"
|
26
|
+
require "google/cloud/discovery_engine/v1/assistant_service/paths"
|
27
|
+
require "google/cloud/discovery_engine/v1/assistant_service/client"
|
28
|
+
require "google/cloud/discovery_engine/v1/assistant_service/rest"
|
29
|
+
|
30
|
+
module Google
|
31
|
+
module Cloud
|
32
|
+
module DiscoveryEngine
|
33
|
+
module V1
|
34
|
+
##
|
35
|
+
# Service for managing Assistant configuration and assisting users.
|
36
|
+
#
|
37
|
+
# @example Load this service and instantiate a gRPC client
|
38
|
+
#
|
39
|
+
# require "google/cloud/discovery_engine/v1/assistant_service"
|
40
|
+
# client = ::Google::Cloud::DiscoveryEngine::V1::AssistantService::Client.new
|
41
|
+
#
|
42
|
+
# @example Load this service and instantiate a REST client
|
43
|
+
#
|
44
|
+
# require "google/cloud/discovery_engine/v1/assistant_service/rest"
|
45
|
+
# client = ::Google::Cloud::DiscoveryEngine::V1::AssistantService::Rest::Client.new
|
46
|
+
#
|
47
|
+
module AssistantService
|
48
|
+
end
|
49
|
+
end
|
50
|
+
end
|
51
|
+
end
|
52
|
+
end
|
53
|
+
|
54
|
+
helper_path = ::File.join __dir__, "assistant_service", "helpers.rb"
|
55
|
+
require "google/cloud/discovery_engine/v1/assistant_service/helpers" if ::File.file? helper_path
|
@@ -369,7 +369,7 @@ module Google
|
|
369
369
|
# @param inline_source [::Google::Cloud::DiscoveryEngine::V1::ImportSuggestionDenyListEntriesRequest::InlineSource, ::Hash]
|
370
370
|
# The Inline source for the input content for suggestion deny list entries.
|
371
371
|
#
|
372
|
-
# Note: The following
|
372
|
+
# Note: The following parameters are mutually exclusive: `inline_source`, `gcs_source`. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.
|
373
373
|
# @param gcs_source [::Google::Cloud::DiscoveryEngine::V1::GcsSource, ::Hash]
|
374
374
|
# Cloud Storage location for the input content.
|
375
375
|
#
|
@@ -380,7 +380,7 @@ module Google
|
|
380
380
|
# * `suggestion_deny_list` (default): One JSON [SuggestionDenyListEntry]
|
381
381
|
# per line.
|
382
382
|
#
|
383
|
-
# Note: The following
|
383
|
+
# Note: The following parameters are mutually exclusive: `gcs_source`, `inline_source`. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.
|
384
384
|
# @param parent [::String]
|
385
385
|
# Required. The parent data store resource name for which to import denylist
|
386
386
|
# entries. Follows pattern projects/*/locations/*/collections/*/dataStores/*.
|
@@ -578,15 +578,15 @@ module Google
|
|
578
578
|
# @param inline_source [::Google::Cloud::DiscoveryEngine::V1::ImportCompletionSuggestionsRequest::InlineSource, ::Hash]
|
579
579
|
# The Inline source for suggestion entries.
|
580
580
|
#
|
581
|
-
# Note: The following
|
581
|
+
# Note: The following parameters are mutually exclusive: `inline_source`, `gcs_source`, `bigquery_source`. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.
|
582
582
|
# @param gcs_source [::Google::Cloud::DiscoveryEngine::V1::GcsSource, ::Hash]
|
583
583
|
# Cloud Storage location for the input content.
|
584
584
|
#
|
585
|
-
# Note: The following
|
585
|
+
# Note: The following parameters are mutually exclusive: `gcs_source`, `inline_source`, `bigquery_source`. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.
|
586
586
|
# @param bigquery_source [::Google::Cloud::DiscoveryEngine::V1::BigQuerySource, ::Hash]
|
587
587
|
# BigQuery input source.
|
588
588
|
#
|
589
|
-
# Note: The following
|
589
|
+
# Note: The following parameters are mutually exclusive: `bigquery_source`, `inline_source`, `gcs_source`. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.
|
590
590
|
# @param parent [::String]
|
591
591
|
# Required. The parent data store resource name for which to import customer
|
592
592
|
# autocomplete suggestions.
|
@@ -355,7 +355,7 @@ module Google
|
|
355
355
|
# @param inline_source [::Google::Cloud::DiscoveryEngine::V1::ImportSuggestionDenyListEntriesRequest::InlineSource, ::Hash]
|
356
356
|
# The Inline source for the input content for suggestion deny list entries.
|
357
357
|
#
|
358
|
-
# Note: The following
|
358
|
+
# Note: The following parameters are mutually exclusive: `inline_source`, `gcs_source`. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.
|
359
359
|
# @param gcs_source [::Google::Cloud::DiscoveryEngine::V1::GcsSource, ::Hash]
|
360
360
|
# Cloud Storage location for the input content.
|
361
361
|
#
|
@@ -366,7 +366,7 @@ module Google
|
|
366
366
|
# * `suggestion_deny_list` (default): One JSON [SuggestionDenyListEntry]
|
367
367
|
# per line.
|
368
368
|
#
|
369
|
-
# Note: The following
|
369
|
+
# Note: The following parameters are mutually exclusive: `gcs_source`, `inline_source`. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.
|
370
370
|
# @param parent [::String]
|
371
371
|
# Required. The parent data store resource name for which to import denylist
|
372
372
|
# entries. Follows pattern projects/*/locations/*/collections/*/dataStores/*.
|
@@ -550,15 +550,15 @@ module Google
|
|
550
550
|
# @param inline_source [::Google::Cloud::DiscoveryEngine::V1::ImportCompletionSuggestionsRequest::InlineSource, ::Hash]
|
551
551
|
# The Inline source for suggestion entries.
|
552
552
|
#
|
553
|
-
# Note: The following
|
553
|
+
# Note: The following parameters are mutually exclusive: `inline_source`, `gcs_source`, `bigquery_source`. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.
|
554
554
|
# @param gcs_source [::Google::Cloud::DiscoveryEngine::V1::GcsSource, ::Hash]
|
555
555
|
# Cloud Storage location for the input content.
|
556
556
|
#
|
557
|
-
# Note: The following
|
557
|
+
# Note: The following parameters are mutually exclusive: `gcs_source`, `inline_source`, `bigquery_source`. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.
|
558
558
|
# @param bigquery_source [::Google::Cloud::DiscoveryEngine::V1::BigQuerySource, ::Hash]
|
559
559
|
# BigQuery input source.
|
560
560
|
#
|
561
|
-
# Note: The following
|
561
|
+
# Note: The following parameters are mutually exclusive: `bigquery_source`, `inline_source`, `gcs_source`. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.
|
562
562
|
# @param parent [::String]
|
563
563
|
# Required. The parent data store resource name for which to import customer
|
564
564
|
# autocomplete suggestions.
|
@@ -1625,11 +1625,23 @@ module Google
|
|
1625
1625
|
# A page token, received from a previous `ListSessions` call.
|
1626
1626
|
# Provide this to retrieve the subsequent page.
|
1627
1627
|
# @param filter [::String]
|
1628
|
-
# A
|
1629
|
-
#
|
1630
|
-
#
|
1631
|
-
#
|
1628
|
+
# A comma-separated list of fields to filter by, in EBNF grammar.
|
1629
|
+
# The supported fields are:
|
1630
|
+
# * `user_pseudo_id`
|
1631
|
+
# * `state`
|
1632
|
+
# * `display_name`
|
1633
|
+
# * `starred`
|
1634
|
+
# * `is_pinned`
|
1635
|
+
# * `labels`
|
1636
|
+
# * `create_time`
|
1637
|
+
# * `update_time`
|
1638
|
+
#
|
1639
|
+
# Examples:
|
1632
1640
|
# "user_pseudo_id = some_id"
|
1641
|
+
# "display_name = \"some_name\""
|
1642
|
+
# "starred = true"
|
1643
|
+
# "is_pinned=true AND (NOT labels:hidden)"
|
1644
|
+
# "create_time > \"1970-01-01T12:00:00Z\""
|
1633
1645
|
# @param order_by [::String]
|
1634
1646
|
# A comma-separated list of fields to order by, sorted in ascending order.
|
1635
1647
|
# Use "desc" after a field name for descending.
|
@@ -1529,11 +1529,23 @@ module Google
|
|
1529
1529
|
# A page token, received from a previous `ListSessions` call.
|
1530
1530
|
# Provide this to retrieve the subsequent page.
|
1531
1531
|
# @param filter [::String]
|
1532
|
-
# A
|
1533
|
-
#
|
1534
|
-
#
|
1535
|
-
#
|
1532
|
+
# A comma-separated list of fields to filter by, in EBNF grammar.
|
1533
|
+
# The supported fields are:
|
1534
|
+
# * `user_pseudo_id`
|
1535
|
+
# * `state`
|
1536
|
+
# * `display_name`
|
1537
|
+
# * `starred`
|
1538
|
+
# * `is_pinned`
|
1539
|
+
# * `labels`
|
1540
|
+
# * `create_time`
|
1541
|
+
# * `update_time`
|
1542
|
+
#
|
1543
|
+
# Examples:
|
1536
1544
|
# "user_pseudo_id = some_id"
|
1545
|
+
# "display_name = \"some_name\""
|
1546
|
+
# "starred = true"
|
1547
|
+
# "is_pinned=true AND (NOT labels:hidden)"
|
1548
|
+
# "create_time > \"1970-01-01T12:00:00Z\""
|
1537
1549
|
# @param order_by [::String]
|
1538
1550
|
# A comma-separated list of fields to order by, sorted in ascending order.
|
1539
1551
|
# Use "desc" after a field name for descending.
|
@@ -241,13 +241,13 @@ module Google
|
|
241
241
|
# @param cmek_config_name [::String]
|
242
242
|
# Resource name of the CmekConfig to use for protecting this DataStore.
|
243
243
|
#
|
244
|
-
# Note: The following
|
244
|
+
# Note: The following parameters are mutually exclusive: `cmek_config_name`, `disable_cmek`. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.
|
245
245
|
# @param disable_cmek [::Boolean]
|
246
246
|
# DataStore without CMEK protections. If a default CmekConfig is set for
|
247
247
|
# the project, setting this field will override the default CmekConfig as
|
248
248
|
# well.
|
249
249
|
#
|
250
|
-
# Note: The following
|
250
|
+
# Note: The following parameters are mutually exclusive: `disable_cmek`, `cmek_config_name`. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.
|
251
251
|
# @param parent [::String]
|
252
252
|
# Required. The parent resource name, such as
|
253
253
|
# `projects/{project}/locations/{location}/collections/{collection}`.
|
@@ -234,13 +234,13 @@ module Google
|
|
234
234
|
# @param cmek_config_name [::String]
|
235
235
|
# Resource name of the CmekConfig to use for protecting this DataStore.
|
236
236
|
#
|
237
|
-
# Note: The following
|
237
|
+
# Note: The following parameters are mutually exclusive: `cmek_config_name`, `disable_cmek`. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.
|
238
238
|
# @param disable_cmek [::Boolean]
|
239
239
|
# DataStore without CMEK protections. If a default CmekConfig is set for
|
240
240
|
# the project, setting this field will override the default CmekConfig as
|
241
241
|
# well.
|
242
242
|
#
|
243
|
-
# Note: The following
|
243
|
+
# Note: The following parameters are mutually exclusive: `disable_cmek`, `cmek_config_name`. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.
|
244
244
|
# @param parent [::String]
|
245
245
|
# Required. The parent resource name, such as
|
246
246
|
# `projects/{project}/locations/{location}/collections/{collection}`.
|
@@ -763,39 +763,39 @@ module Google
|
|
763
763
|
# @param inline_source [::Google::Cloud::DiscoveryEngine::V1::ImportDocumentsRequest::InlineSource, ::Hash]
|
764
764
|
# The Inline source for the input content for documents.
|
765
765
|
#
|
766
|
-
# Note: The following
|
766
|
+
# Note: The following parameters are mutually exclusive: `inline_source`, `gcs_source`, `bigquery_source`, `fhir_store_source`, `spanner_source`, `cloud_sql_source`, `firestore_source`, `alloy_db_source`, `bigtable_source`. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.
|
767
767
|
# @param gcs_source [::Google::Cloud::DiscoveryEngine::V1::GcsSource, ::Hash]
|
768
768
|
# Cloud Storage location for the input content.
|
769
769
|
#
|
770
|
-
# Note: The following
|
770
|
+
# Note: The following parameters are mutually exclusive: `gcs_source`, `inline_source`, `bigquery_source`, `fhir_store_source`, `spanner_source`, `cloud_sql_source`, `firestore_source`, `alloy_db_source`, `bigtable_source`. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.
|
771
771
|
# @param bigquery_source [::Google::Cloud::DiscoveryEngine::V1::BigQuerySource, ::Hash]
|
772
772
|
# BigQuery input source.
|
773
773
|
#
|
774
|
-
# Note: The following
|
774
|
+
# Note: The following parameters are mutually exclusive: `bigquery_source`, `inline_source`, `gcs_source`, `fhir_store_source`, `spanner_source`, `cloud_sql_source`, `firestore_source`, `alloy_db_source`, `bigtable_source`. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.
|
775
775
|
# @param fhir_store_source [::Google::Cloud::DiscoveryEngine::V1::FhirStoreSource, ::Hash]
|
776
776
|
# FhirStore input source.
|
777
777
|
#
|
778
|
-
# Note: The following
|
778
|
+
# Note: The following parameters are mutually exclusive: `fhir_store_source`, `inline_source`, `gcs_source`, `bigquery_source`, `spanner_source`, `cloud_sql_source`, `firestore_source`, `alloy_db_source`, `bigtable_source`. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.
|
779
779
|
# @param spanner_source [::Google::Cloud::DiscoveryEngine::V1::SpannerSource, ::Hash]
|
780
780
|
# Spanner input source.
|
781
781
|
#
|
782
|
-
# Note: The following
|
782
|
+
# Note: The following parameters are mutually exclusive: `spanner_source`, `inline_source`, `gcs_source`, `bigquery_source`, `fhir_store_source`, `cloud_sql_source`, `firestore_source`, `alloy_db_source`, `bigtable_source`. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.
|
783
783
|
# @param cloud_sql_source [::Google::Cloud::DiscoveryEngine::V1::CloudSqlSource, ::Hash]
|
784
784
|
# Cloud SQL input source.
|
785
785
|
#
|
786
|
-
# Note: The following
|
786
|
+
# Note: The following parameters are mutually exclusive: `cloud_sql_source`, `inline_source`, `gcs_source`, `bigquery_source`, `fhir_store_source`, `spanner_source`, `firestore_source`, `alloy_db_source`, `bigtable_source`. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.
|
787
787
|
# @param firestore_source [::Google::Cloud::DiscoveryEngine::V1::FirestoreSource, ::Hash]
|
788
788
|
# Firestore input source.
|
789
789
|
#
|
790
|
-
# Note: The following
|
790
|
+
# Note: The following parameters are mutually exclusive: `firestore_source`, `inline_source`, `gcs_source`, `bigquery_source`, `fhir_store_source`, `spanner_source`, `cloud_sql_source`, `alloy_db_source`, `bigtable_source`. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.
|
791
791
|
# @param alloy_db_source [::Google::Cloud::DiscoveryEngine::V1::AlloyDbSource, ::Hash]
|
792
792
|
# AlloyDB input source.
|
793
793
|
#
|
794
|
-
# Note: The following
|
794
|
+
# Note: The following parameters are mutually exclusive: `alloy_db_source`, `inline_source`, `gcs_source`, `bigquery_source`, `fhir_store_source`, `spanner_source`, `cloud_sql_source`, `firestore_source`, `bigtable_source`. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.
|
795
795
|
# @param bigtable_source [::Google::Cloud::DiscoveryEngine::V1::BigtableSource, ::Hash]
|
796
796
|
# Cloud Bigtable input source.
|
797
797
|
#
|
798
|
-
# Note: The following
|
798
|
+
# Note: The following parameters are mutually exclusive: `bigtable_source`, `inline_source`, `gcs_source`, `bigquery_source`, `fhir_store_source`, `spanner_source`, `cloud_sql_source`, `firestore_source`, `alloy_db_source`. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.
|
799
799
|
# @param parent [::String]
|
800
800
|
# Required. The parent branch resource name, such as
|
801
801
|
# `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.
|
@@ -989,11 +989,11 @@ module Google
|
|
989
989
|
# * `document_id`: One valid
|
990
990
|
# {::Google::Cloud::DiscoveryEngine::V1::Document#id Document.id} per line.
|
991
991
|
#
|
992
|
-
# Note: The following
|
992
|
+
# Note: The following parameters are mutually exclusive: `gcs_source`, `inline_source`. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.
|
993
993
|
# @param inline_source [::Google::Cloud::DiscoveryEngine::V1::PurgeDocumentsRequest::InlineSource, ::Hash]
|
994
994
|
# Inline source for the input content for purge.
|
995
995
|
#
|
996
|
-
# Note: The following
|
996
|
+
# Note: The following parameters are mutually exclusive: `inline_source`, `gcs_source`. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.
|
997
997
|
# @param parent [::String]
|
998
998
|
# Required. The parent resource name, such as
|
999
999
|
# `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.
|
@@ -721,39 +721,39 @@ module Google
|
|
721
721
|
# @param inline_source [::Google::Cloud::DiscoveryEngine::V1::ImportDocumentsRequest::InlineSource, ::Hash]
|
722
722
|
# The Inline source for the input content for documents.
|
723
723
|
#
|
724
|
-
# Note: The following
|
724
|
+
# Note: The following parameters are mutually exclusive: `inline_source`, `gcs_source`, `bigquery_source`, `fhir_store_source`, `spanner_source`, `cloud_sql_source`, `firestore_source`, `alloy_db_source`, `bigtable_source`. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.
|
725
725
|
# @param gcs_source [::Google::Cloud::DiscoveryEngine::V1::GcsSource, ::Hash]
|
726
726
|
# Cloud Storage location for the input content.
|
727
727
|
#
|
728
|
-
# Note: The following
|
728
|
+
# Note: The following parameters are mutually exclusive: `gcs_source`, `inline_source`, `bigquery_source`, `fhir_store_source`, `spanner_source`, `cloud_sql_source`, `firestore_source`, `alloy_db_source`, `bigtable_source`. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.
|
729
729
|
# @param bigquery_source [::Google::Cloud::DiscoveryEngine::V1::BigQuerySource, ::Hash]
|
730
730
|
# BigQuery input source.
|
731
731
|
#
|
732
|
-
# Note: The following
|
732
|
+
# Note: The following parameters are mutually exclusive: `bigquery_source`, `inline_source`, `gcs_source`, `fhir_store_source`, `spanner_source`, `cloud_sql_source`, `firestore_source`, `alloy_db_source`, `bigtable_source`. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.
|
733
733
|
# @param fhir_store_source [::Google::Cloud::DiscoveryEngine::V1::FhirStoreSource, ::Hash]
|
734
734
|
# FhirStore input source.
|
735
735
|
#
|
736
|
-
# Note: The following
|
736
|
+
# Note: The following parameters are mutually exclusive: `fhir_store_source`, `inline_source`, `gcs_source`, `bigquery_source`, `spanner_source`, `cloud_sql_source`, `firestore_source`, `alloy_db_source`, `bigtable_source`. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.
|
737
737
|
# @param spanner_source [::Google::Cloud::DiscoveryEngine::V1::SpannerSource, ::Hash]
|
738
738
|
# Spanner input source.
|
739
739
|
#
|
740
|
-
# Note: The following
|
740
|
+
# Note: The following parameters are mutually exclusive: `spanner_source`, `inline_source`, `gcs_source`, `bigquery_source`, `fhir_store_source`, `cloud_sql_source`, `firestore_source`, `alloy_db_source`, `bigtable_source`. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.
|
741
741
|
# @param cloud_sql_source [::Google::Cloud::DiscoveryEngine::V1::CloudSqlSource, ::Hash]
|
742
742
|
# Cloud SQL input source.
|
743
743
|
#
|
744
|
-
# Note: The following
|
744
|
+
# Note: The following parameters are mutually exclusive: `cloud_sql_source`, `inline_source`, `gcs_source`, `bigquery_source`, `fhir_store_source`, `spanner_source`, `firestore_source`, `alloy_db_source`, `bigtable_source`. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.
|
745
745
|
# @param firestore_source [::Google::Cloud::DiscoveryEngine::V1::FirestoreSource, ::Hash]
|
746
746
|
# Firestore input source.
|
747
747
|
#
|
748
|
-
# Note: The following
|
748
|
+
# Note: The following parameters are mutually exclusive: `firestore_source`, `inline_source`, `gcs_source`, `bigquery_source`, `fhir_store_source`, `spanner_source`, `cloud_sql_source`, `alloy_db_source`, `bigtable_source`. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.
|
749
749
|
# @param alloy_db_source [::Google::Cloud::DiscoveryEngine::V1::AlloyDbSource, ::Hash]
|
750
750
|
# AlloyDB input source.
|
751
751
|
#
|
752
|
-
# Note: The following
|
752
|
+
# Note: The following parameters are mutually exclusive: `alloy_db_source`, `inline_source`, `gcs_source`, `bigquery_source`, `fhir_store_source`, `spanner_source`, `cloud_sql_source`, `firestore_source`, `bigtable_source`. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.
|
753
753
|
# @param bigtable_source [::Google::Cloud::DiscoveryEngine::V1::BigtableSource, ::Hash]
|
754
754
|
# Cloud Bigtable input source.
|
755
755
|
#
|
756
|
-
# Note: The following
|
756
|
+
# Note: The following parameters are mutually exclusive: `bigtable_source`, `inline_source`, `gcs_source`, `bigquery_source`, `fhir_store_source`, `spanner_source`, `cloud_sql_source`, `firestore_source`, `alloy_db_source`. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.
|
757
757
|
# @param parent [::String]
|
758
758
|
# Required. The parent branch resource name, such as
|
759
759
|
# `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.
|
@@ -940,11 +940,11 @@ module Google
|
|
940
940
|
# * `document_id`: One valid
|
941
941
|
# {::Google::Cloud::DiscoveryEngine::V1::Document#id Document.id} per line.
|
942
942
|
#
|
943
|
-
# Note: The following
|
943
|
+
# Note: The following parameters are mutually exclusive: `gcs_source`, `inline_source`. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.
|
944
944
|
# @param inline_source [::Google::Cloud::DiscoveryEngine::V1::PurgeDocumentsRequest::InlineSource, ::Hash]
|
945
945
|
# Inline source for the input content for purge.
|
946
946
|
#
|
947
|
-
# Note: The following
|
947
|
+
# Note: The following parameters are mutually exclusive: `inline_source`, `gcs_source`. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.
|
948
948
|
# @param parent [::String]
|
949
949
|
# Required. The parent resource name, such as
|
950
950
|
# `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.
|
@@ -235,13 +235,13 @@ module Google
|
|
235
235
|
# Resource name of the CmekConfig to use for protecting this Identity
|
236
236
|
# Mapping Store.
|
237
237
|
#
|
238
|
-
# Note: The following
|
238
|
+
# Note: The following parameters are mutually exclusive: `cmek_config_name`, `disable_cmek`. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.
|
239
239
|
# @param disable_cmek [::Boolean]
|
240
240
|
# Identity Mapping Store without CMEK protections. If a default CmekConfig
|
241
241
|
# is set for the project, setting this field will override the default
|
242
242
|
# CmekConfig as well.
|
243
243
|
#
|
244
|
-
# Note: The following
|
244
|
+
# Note: The following parameters are mutually exclusive: `disable_cmek`, `cmek_config_name`. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.
|
245
245
|
# @param parent [::String]
|
246
246
|
# Required. The parent collection resource name, such as
|
247
247
|
# `projects/{project}/locations/{location}`.
|