google-apis-discoveryengine_v1alpha 0.80.0 → 0.82.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/CHANGELOG.md +8 -0
- data/lib/google/apis/discoveryengine_v1alpha/classes.rb +1515 -84
- data/lib/google/apis/discoveryengine_v1alpha/gem_version.rb +2 -2
- data/lib/google/apis/discoveryengine_v1alpha/representations.rb +601 -1
- data/lib/google/apis/discoveryengine_v1alpha/service.rb +1132 -86
- metadata +2 -2
|
@@ -51,6 +51,145 @@ module Google
|
|
|
51
51
|
@batch_path = 'batch'
|
|
52
52
|
end
|
|
53
53
|
|
|
54
|
+
# Distributes a LicenseConfig from billing account level to project level.
|
|
55
|
+
# @param [String] billing_account_license_config
|
|
56
|
+
# Required. Full resource name of BillingAccountLicenseConfig. Format: `
|
|
57
|
+
# billingAccounts/`billing_account`/billingAccountLicenseConfigs/`
|
|
58
|
+
# billing_account_license_config_id``.
|
|
59
|
+
# @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDistributeLicenseConfigRequest] google_cloud_discoveryengine_v1alpha_distribute_license_config_request_object
|
|
60
|
+
# @param [String] fields
|
|
61
|
+
# Selector specifying which fields to include in a partial response.
|
|
62
|
+
# @param [String] quota_user
|
|
63
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
64
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
65
|
+
# @param [Google::Apis::RequestOptions] options
|
|
66
|
+
# Request-specific options
|
|
67
|
+
#
|
|
68
|
+
# @yield [result, err] Result & error if block supplied
|
|
69
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDistributeLicenseConfigResponse] parsed result object
|
|
70
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
71
|
+
#
|
|
72
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDistributeLicenseConfigResponse]
|
|
73
|
+
#
|
|
74
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
75
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
76
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
77
|
+
def distribute_billing_account_billing_account_license_config_license_config(billing_account_license_config, google_cloud_discoveryengine_v1alpha_distribute_license_config_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
78
|
+
command = make_simple_command(:post, 'v1alpha/{+billingAccountLicenseConfig}:distributeLicenseConfig', options)
|
|
79
|
+
command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDistributeLicenseConfigRequest::Representation
|
|
80
|
+
command.request_object = google_cloud_discoveryengine_v1alpha_distribute_license_config_request_object
|
|
81
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDistributeLicenseConfigResponse::Representation
|
|
82
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDistributeLicenseConfigResponse
|
|
83
|
+
command.params['billingAccountLicenseConfig'] = billing_account_license_config unless billing_account_license_config.nil?
|
|
84
|
+
command.query['fields'] = fields unless fields.nil?
|
|
85
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
86
|
+
execute_or_queue_command(command, &block)
|
|
87
|
+
end
|
|
88
|
+
|
|
89
|
+
# Gets a BillingAccountLicenseConfig.
|
|
90
|
+
# @param [String] name
|
|
91
|
+
# Required. Full resource name of BillingAccountLicenseConfig. Format: `
|
|
92
|
+
# billingAccounts/`billing_account`/billingAccountLicenseConfigs/`
|
|
93
|
+
# billing_account_license_config_id``.
|
|
94
|
+
# @param [String] fields
|
|
95
|
+
# Selector specifying which fields to include in a partial response.
|
|
96
|
+
# @param [String] quota_user
|
|
97
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
98
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
99
|
+
# @param [Google::Apis::RequestOptions] options
|
|
100
|
+
# Request-specific options
|
|
101
|
+
#
|
|
102
|
+
# @yield [result, err] Result & error if block supplied
|
|
103
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaBillingAccountLicenseConfig] parsed result object
|
|
104
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
105
|
+
#
|
|
106
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaBillingAccountLicenseConfig]
|
|
107
|
+
#
|
|
108
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
109
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
110
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
111
|
+
def get_billing_account_billing_account_license_config(name, fields: nil, quota_user: nil, options: nil, &block)
|
|
112
|
+
command = make_simple_command(:get, 'v1alpha/{+name}', options)
|
|
113
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaBillingAccountLicenseConfig::Representation
|
|
114
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaBillingAccountLicenseConfig
|
|
115
|
+
command.params['name'] = name unless name.nil?
|
|
116
|
+
command.query['fields'] = fields unless fields.nil?
|
|
117
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
118
|
+
execute_or_queue_command(command, &block)
|
|
119
|
+
end
|
|
120
|
+
|
|
121
|
+
# Lists all BillingAccountLicenseConfigs for a given billing account.
|
|
122
|
+
# @param [String] parent
|
|
123
|
+
# Required. Format: `billingAccounts/`billing_account``.
|
|
124
|
+
# @param [Fixnum] page_size
|
|
125
|
+
# Optional. Not supported.
|
|
126
|
+
# @param [String] page_token
|
|
127
|
+
# Optional. Not supported.
|
|
128
|
+
# @param [String] fields
|
|
129
|
+
# Selector specifying which fields to include in a partial response.
|
|
130
|
+
# @param [String] quota_user
|
|
131
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
132
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
133
|
+
# @param [Google::Apis::RequestOptions] options
|
|
134
|
+
# Request-specific options
|
|
135
|
+
#
|
|
136
|
+
# @yield [result, err] Result & error if block supplied
|
|
137
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListBillingAccountLicenseConfigsResponse] parsed result object
|
|
138
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
139
|
+
#
|
|
140
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListBillingAccountLicenseConfigsResponse]
|
|
141
|
+
#
|
|
142
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
143
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
144
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
145
|
+
def list_billing_account_billing_account_license_configs(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
146
|
+
command = make_simple_command(:get, 'v1alpha/{+parent}/billingAccountLicenseConfigs', options)
|
|
147
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListBillingAccountLicenseConfigsResponse::Representation
|
|
148
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListBillingAccountLicenseConfigsResponse
|
|
149
|
+
command.params['parent'] = parent unless parent.nil?
|
|
150
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
|
151
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
|
152
|
+
command.query['fields'] = fields unless fields.nil?
|
|
153
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
154
|
+
execute_or_queue_command(command, &block)
|
|
155
|
+
end
|
|
156
|
+
|
|
157
|
+
# This method is called from the billing account side to retract the
|
|
158
|
+
# LicenseConfig from the given project back to the billing account.
|
|
159
|
+
# @param [String] billing_account_license_config
|
|
160
|
+
# Required. Full resource name of BillingAccountLicenseConfig. Format: `
|
|
161
|
+
# billingAccounts/`billing_account`/billingAccountLicenseConfigs/`
|
|
162
|
+
# billing_account_license_config_id``.
|
|
163
|
+
# @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaRetractLicenseConfigRequest] google_cloud_discoveryengine_v1alpha_retract_license_config_request_object
|
|
164
|
+
# @param [String] fields
|
|
165
|
+
# Selector specifying which fields to include in a partial response.
|
|
166
|
+
# @param [String] quota_user
|
|
167
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
168
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
169
|
+
# @param [Google::Apis::RequestOptions] options
|
|
170
|
+
# Request-specific options
|
|
171
|
+
#
|
|
172
|
+
# @yield [result, err] Result & error if block supplied
|
|
173
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaRetractLicenseConfigResponse] parsed result object
|
|
174
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
175
|
+
#
|
|
176
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaRetractLicenseConfigResponse]
|
|
177
|
+
#
|
|
178
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
179
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
180
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
181
|
+
def retract_billing_account_billing_account_license_config_license_config(billing_account_license_config, google_cloud_discoveryengine_v1alpha_retract_license_config_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
182
|
+
command = make_simple_command(:post, 'v1alpha/{+billingAccountLicenseConfig}:retractLicenseConfig', options)
|
|
183
|
+
command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaRetractLicenseConfigRequest::Representation
|
|
184
|
+
command.request_object = google_cloud_discoveryengine_v1alpha_retract_license_config_request_object
|
|
185
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaRetractLicenseConfigResponse::Representation
|
|
186
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaRetractLicenseConfigResponse
|
|
187
|
+
command.params['billingAccountLicenseConfig'] = billing_account_license_config unless billing_account_license_config.nil?
|
|
188
|
+
command.query['fields'] = fields unless fields.nil?
|
|
189
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
190
|
+
execute_or_queue_command(command, &block)
|
|
191
|
+
end
|
|
192
|
+
|
|
54
193
|
# Downloads a file from the session.
|
|
55
194
|
# @param [String] name
|
|
56
195
|
# Required. The resource name of the Session. Format: `projects/`project`/
|
|
@@ -96,6 +235,52 @@ module Google
|
|
|
96
235
|
execute_or_queue_command(command, &block)
|
|
97
236
|
end
|
|
98
237
|
|
|
238
|
+
# Uploads a file for the assistant to use as a source of information within the
|
|
239
|
+
# session.
|
|
240
|
+
# @param [String] name
|
|
241
|
+
# Required. The resource name of the Session. Format: `projects/`project`/
|
|
242
|
+
# locations/`location`/collections/`collection`/engines/`engine`/sessions/`
|
|
243
|
+
# session``
|
|
244
|
+
# @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaUploadSessionFileRequest] google_cloud_discoveryengine_v1alpha_upload_session_file_request_object
|
|
245
|
+
# @param [String] fields
|
|
246
|
+
# Selector specifying which fields to include in a partial response.
|
|
247
|
+
# @param [String] quota_user
|
|
248
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
249
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
250
|
+
# @param [IO, String] upload_source
|
|
251
|
+
# IO stream or filename containing content to upload
|
|
252
|
+
# @param [String] content_type
|
|
253
|
+
# Content type of the uploaded content.
|
|
254
|
+
# @param [Google::Apis::RequestOptions] options
|
|
255
|
+
# Request-specific options
|
|
256
|
+
#
|
|
257
|
+
# @yield [result, err] Result & error if block supplied
|
|
258
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaUploadSessionFileResponse] parsed result object
|
|
259
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
260
|
+
#
|
|
261
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaUploadSessionFileResponse]
|
|
262
|
+
#
|
|
263
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
264
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
265
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
266
|
+
def upload_medium(name, google_cloud_discoveryengine_v1alpha_upload_session_file_request_object = nil, fields: nil, quota_user: nil, upload_source: nil, content_type: nil, options: nil, &block)
|
|
267
|
+
if upload_source.nil?
|
|
268
|
+
command = make_simple_command(:post, 'v1alpha/{+name}:uploadFile', options)
|
|
269
|
+
else
|
|
270
|
+
command = make_upload_command(:post, 'v1alpha/{+name}:uploadFile', options)
|
|
271
|
+
command.upload_source = upload_source
|
|
272
|
+
command.upload_content_type = content_type
|
|
273
|
+
end
|
|
274
|
+
command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaUploadSessionFileRequest::Representation
|
|
275
|
+
command.request_object = google_cloud_discoveryengine_v1alpha_upload_session_file_request_object
|
|
276
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaUploadSessionFileResponse::Representation
|
|
277
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaUploadSessionFileResponse
|
|
278
|
+
command.params['name'] = name unless name.nil?
|
|
279
|
+
command.query['fields'] = fields unless fields.nil?
|
|
280
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
281
|
+
execute_or_queue_command(command, &block)
|
|
282
|
+
end
|
|
283
|
+
|
|
99
284
|
# Gets a Project. Returns NOT_FOUND when the project is not yet created.
|
|
100
285
|
# @param [String] name
|
|
101
286
|
# Required. Full resource name of a Project, such as `projects/`
|
|
@@ -671,6 +856,190 @@ module Google
|
|
|
671
856
|
execute_or_queue_command(command, &block)
|
|
672
857
|
end
|
|
673
858
|
|
|
859
|
+
# Creates an Authorization.
|
|
860
|
+
# @param [String] parent
|
|
861
|
+
# Required. The parent resource name. Format: `projects/`project`/locations/`
|
|
862
|
+
# location``
|
|
863
|
+
# @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAuthorization] google_cloud_discoveryengine_v1alpha_authorization_object
|
|
864
|
+
# @param [String] authorization_id
|
|
865
|
+
# Required. The ID to use for the authorization, which will become the final
|
|
866
|
+
# component of the resource name. This field must conform to [RFC-1034](https://
|
|
867
|
+
# tools.ietf.org/html/rfc1034) with a length limit of 63 characters.
|
|
868
|
+
# @param [String] fields
|
|
869
|
+
# Selector specifying which fields to include in a partial response.
|
|
870
|
+
# @param [String] quota_user
|
|
871
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
872
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
873
|
+
# @param [Google::Apis::RequestOptions] options
|
|
874
|
+
# Request-specific options
|
|
875
|
+
#
|
|
876
|
+
# @yield [result, err] Result & error if block supplied
|
|
877
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAuthorization] parsed result object
|
|
878
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
879
|
+
#
|
|
880
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAuthorization]
|
|
881
|
+
#
|
|
882
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
883
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
884
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
885
|
+
def create_project_location_authorization(parent, google_cloud_discoveryengine_v1alpha_authorization_object = nil, authorization_id: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
886
|
+
command = make_simple_command(:post, 'v1alpha/{+parent}/authorizations', options)
|
|
887
|
+
command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAuthorization::Representation
|
|
888
|
+
command.request_object = google_cloud_discoveryengine_v1alpha_authorization_object
|
|
889
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAuthorization::Representation
|
|
890
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAuthorization
|
|
891
|
+
command.params['parent'] = parent unless parent.nil?
|
|
892
|
+
command.query['authorizationId'] = authorization_id unless authorization_id.nil?
|
|
893
|
+
command.query['fields'] = fields unless fields.nil?
|
|
894
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
895
|
+
execute_or_queue_command(command, &block)
|
|
896
|
+
end
|
|
897
|
+
|
|
898
|
+
# Deletes an Authorization.
|
|
899
|
+
# @param [String] name
|
|
900
|
+
# Required. Resource name of Authorization. Format: `projects/`project`/
|
|
901
|
+
# locations/`location`/authorizations/`authorization`` If the caller does not
|
|
902
|
+
# have permission to delete the authorization, regardless of whether or not it
|
|
903
|
+
# exists, a `PERMISSION_DENIED` error is returned. If the authorization to
|
|
904
|
+
# delete does not exist, a `NOT_FOUND` error is returned.
|
|
905
|
+
# @param [String] fields
|
|
906
|
+
# Selector specifying which fields to include in a partial response.
|
|
907
|
+
# @param [String] quota_user
|
|
908
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
909
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
910
|
+
# @param [Google::Apis::RequestOptions] options
|
|
911
|
+
# Request-specific options
|
|
912
|
+
#
|
|
913
|
+
# @yield [result, err] Result & error if block supplied
|
|
914
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleProtobufEmpty] parsed result object
|
|
915
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
916
|
+
#
|
|
917
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleProtobufEmpty]
|
|
918
|
+
#
|
|
919
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
920
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
921
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
922
|
+
def delete_project_location_authorization(name, fields: nil, quota_user: nil, options: nil, &block)
|
|
923
|
+
command = make_simple_command(:delete, 'v1alpha/{+name}', options)
|
|
924
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleProtobufEmpty::Representation
|
|
925
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleProtobufEmpty
|
|
926
|
+
command.params['name'] = name unless name.nil?
|
|
927
|
+
command.query['fields'] = fields unless fields.nil?
|
|
928
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
929
|
+
execute_or_queue_command(command, &block)
|
|
930
|
+
end
|
|
931
|
+
|
|
932
|
+
# Gets an Authorization.
|
|
933
|
+
# @param [String] name
|
|
934
|
+
# Required. Resource name of Authorization. Format: `projects/`project`/
|
|
935
|
+
# locations/`location`/authorizations/`authorization``
|
|
936
|
+
# @param [String] fields
|
|
937
|
+
# Selector specifying which fields to include in a partial response.
|
|
938
|
+
# @param [String] quota_user
|
|
939
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
940
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
941
|
+
# @param [Google::Apis::RequestOptions] options
|
|
942
|
+
# Request-specific options
|
|
943
|
+
#
|
|
944
|
+
# @yield [result, err] Result & error if block supplied
|
|
945
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAuthorization] parsed result object
|
|
946
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
947
|
+
#
|
|
948
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAuthorization]
|
|
949
|
+
#
|
|
950
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
951
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
952
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
953
|
+
def get_project_location_authorization(name, fields: nil, quota_user: nil, options: nil, &block)
|
|
954
|
+
command = make_simple_command(:get, 'v1alpha/{+name}', options)
|
|
955
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAuthorization::Representation
|
|
956
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAuthorization
|
|
957
|
+
command.params['name'] = name unless name.nil?
|
|
958
|
+
command.query['fields'] = fields unless fields.nil?
|
|
959
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
960
|
+
execute_or_queue_command(command, &block)
|
|
961
|
+
end
|
|
962
|
+
|
|
963
|
+
# Lists all Authorizations under an Engine.
|
|
964
|
+
# @param [String] parent
|
|
965
|
+
# Required. The parent resource name. Format: `projects/`project`/locations/`
|
|
966
|
+
# location``
|
|
967
|
+
# @param [Fixnum] page_size
|
|
968
|
+
# Maximum number of Authorizations to return. If unspecified, defaults to 100.
|
|
969
|
+
# The maximum allowed value is 1000; anything above that will be coerced down to
|
|
970
|
+
# 1000.
|
|
971
|
+
# @param [String] page_token
|
|
972
|
+
# A page token ListAuthorizationsResponse.next_page_token, received from a
|
|
973
|
+
# previous AuthorizationService.ListAuthorizations call. Provide this to
|
|
974
|
+
# retrieve the subsequent page. When paginating, all other parameters provided
|
|
975
|
+
# to ListAuthorizations must match the call that provided the page token.
|
|
976
|
+
# @param [String] fields
|
|
977
|
+
# Selector specifying which fields to include in a partial response.
|
|
978
|
+
# @param [String] quota_user
|
|
979
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
980
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
981
|
+
# @param [Google::Apis::RequestOptions] options
|
|
982
|
+
# Request-specific options
|
|
983
|
+
#
|
|
984
|
+
# @yield [result, err] Result & error if block supplied
|
|
985
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListAuthorizationsResponse] parsed result object
|
|
986
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
987
|
+
#
|
|
988
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListAuthorizationsResponse]
|
|
989
|
+
#
|
|
990
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
991
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
992
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
993
|
+
def list_project_location_authorizations(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
994
|
+
command = make_simple_command(:get, 'v1alpha/{+parent}/authorizations', options)
|
|
995
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListAuthorizationsResponse::Representation
|
|
996
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListAuthorizationsResponse
|
|
997
|
+
command.params['parent'] = parent unless parent.nil?
|
|
998
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
|
999
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
|
1000
|
+
command.query['fields'] = fields unless fields.nil?
|
|
1001
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
1002
|
+
execute_or_queue_command(command, &block)
|
|
1003
|
+
end
|
|
1004
|
+
|
|
1005
|
+
# Updates an Authorization
|
|
1006
|
+
# @param [String] name
|
|
1007
|
+
# Identifier. Resource name of the authorization. Format: `projects/`project`/
|
|
1008
|
+
# locations/`location`/authorizations/`authorization`` It must be a UTF-8
|
|
1009
|
+
# encoded string with a length limit of 1024 characters.
|
|
1010
|
+
# @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAuthorization] google_cloud_discoveryengine_v1alpha_authorization_object
|
|
1011
|
+
# @param [String] update_mask
|
|
1012
|
+
# The list of fields to update.
|
|
1013
|
+
# @param [String] fields
|
|
1014
|
+
# Selector specifying which fields to include in a partial response.
|
|
1015
|
+
# @param [String] quota_user
|
|
1016
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
1017
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
1018
|
+
# @param [Google::Apis::RequestOptions] options
|
|
1019
|
+
# Request-specific options
|
|
1020
|
+
#
|
|
1021
|
+
# @yield [result, err] Result & error if block supplied
|
|
1022
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAuthorization] parsed result object
|
|
1023
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
1024
|
+
#
|
|
1025
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAuthorization]
|
|
1026
|
+
#
|
|
1027
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
1028
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
1029
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
1030
|
+
def patch_project_location_authorization(name, google_cloud_discoveryengine_v1alpha_authorization_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
1031
|
+
command = make_simple_command(:patch, 'v1alpha/{+name}', options)
|
|
1032
|
+
command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAuthorization::Representation
|
|
1033
|
+
command.request_object = google_cloud_discoveryengine_v1alpha_authorization_object
|
|
1034
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAuthorization::Representation
|
|
1035
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAuthorization
|
|
1036
|
+
command.params['name'] = name unless name.nil?
|
|
1037
|
+
command.query['updateMask'] = update_mask unless update_mask.nil?
|
|
1038
|
+
command.query['fields'] = fields unless fields.nil?
|
|
1039
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
1040
|
+
execute_or_queue_command(command, &block)
|
|
1041
|
+
end
|
|
1042
|
+
|
|
674
1043
|
# De-provisions a CmekConfig.
|
|
675
1044
|
# @param [String] name
|
|
676
1045
|
# Required. The resource name of the CmekConfig to delete, such as `projects/`
|
|
@@ -1323,9 +1692,9 @@ module Google
|
|
|
1323
1692
|
# values: * `document` is the default model for regular dataStores. * `search-
|
|
1324
1693
|
# history` is the default model for site search dataStores.
|
|
1325
1694
|
# @param [String] user_pseudo_id
|
|
1326
|
-
# A unique identifier for tracking visitors. For example, this could
|
|
1327
|
-
# implemented with an HTTP cookie, which should be able to uniquely identify
|
|
1328
|
-
# visitor on a single device. This unique identifier should not change if the
|
|
1695
|
+
# Optional. A unique identifier for tracking visitors. For example, this could
|
|
1696
|
+
# be implemented with an HTTP cookie, which should be able to uniquely identify
|
|
1697
|
+
# a visitor on a single device. This unique identifier should not change if the
|
|
1329
1698
|
# visitor logs in or out of the website. This field should NOT have a fixed
|
|
1330
1699
|
# value such as `unknown_visitor`. This should be the same identifier as
|
|
1331
1700
|
# UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a
|
|
@@ -4897,17 +5266,58 @@ module Google
|
|
|
4897
5266
|
execute_or_queue_command(command, &block)
|
|
4898
5267
|
end
|
|
4899
5268
|
|
|
4900
|
-
#
|
|
4901
|
-
# @param [String]
|
|
4902
|
-
#
|
|
4903
|
-
# location`/collections/`
|
|
4904
|
-
#
|
|
4905
|
-
#
|
|
4906
|
-
#
|
|
4907
|
-
#
|
|
4908
|
-
#
|
|
4909
|
-
#
|
|
4910
|
-
#
|
|
5269
|
+
# Update a WidgetConfig.
|
|
5270
|
+
# @param [String] name
|
|
5271
|
+
# Immutable. The full resource name of the widget config. Format: `projects/`
|
|
5272
|
+
# project`/locations/`location`/collections/`collection_id`/dataStores/`
|
|
5273
|
+
# data_store_id`/widgetConfigs/`widget_config_id``. This field must be a UTF-8
|
|
5274
|
+
# encoded string with a length limit of 1024 characters.
|
|
5275
|
+
# @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaWidgetConfig] google_cloud_discoveryengine_v1alpha_widget_config_object
|
|
5276
|
+
# @param [String] update_mask
|
|
5277
|
+
# Indicates which fields in the provided WidgetConfig to update. The following
|
|
5278
|
+
# are the only supported fields: * WidgetConfig.enable_autocomplete If not set,
|
|
5279
|
+
# all supported fields are updated.
|
|
5280
|
+
# @param [String] fields
|
|
5281
|
+
# Selector specifying which fields to include in a partial response.
|
|
5282
|
+
# @param [String] quota_user
|
|
5283
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
5284
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
5285
|
+
# @param [Google::Apis::RequestOptions] options
|
|
5286
|
+
# Request-specific options
|
|
5287
|
+
#
|
|
5288
|
+
# @yield [result, err] Result & error if block supplied
|
|
5289
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaWidgetConfig] parsed result object
|
|
5290
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
5291
|
+
#
|
|
5292
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaWidgetConfig]
|
|
5293
|
+
#
|
|
5294
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
5295
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
5296
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
5297
|
+
def patch_project_location_collection_data_store_widget_config(name, google_cloud_discoveryengine_v1alpha_widget_config_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
5298
|
+
command = make_simple_command(:patch, 'v1alpha/{+name}', options)
|
|
5299
|
+
command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaWidgetConfig::Representation
|
|
5300
|
+
command.request_object = google_cloud_discoveryengine_v1alpha_widget_config_object
|
|
5301
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaWidgetConfig::Representation
|
|
5302
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaWidgetConfig
|
|
5303
|
+
command.params['name'] = name unless name.nil?
|
|
5304
|
+
command.query['updateMask'] = update_mask unless update_mask.nil?
|
|
5305
|
+
command.query['fields'] = fields unless fields.nil?
|
|
5306
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
5307
|
+
execute_or_queue_command(command, &block)
|
|
5308
|
+
end
|
|
5309
|
+
|
|
5310
|
+
# Creates a Engine.
|
|
5311
|
+
# @param [String] parent
|
|
5312
|
+
# Required. The parent resource name, such as `projects/`project`/locations/`
|
|
5313
|
+
# location`/collections/`collection``.
|
|
5314
|
+
# @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaEngine] google_cloud_discoveryengine_v1alpha_engine_object
|
|
5315
|
+
# @param [String] engine_id
|
|
5316
|
+
# Required. The ID to use for the Engine, which will become the final component
|
|
5317
|
+
# of the Engine's resource name. This field must conform to [RFC-1034](https://
|
|
5318
|
+
# tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters.
|
|
5319
|
+
# Otherwise, an INVALID_ARGUMENT error is returned.
|
|
5320
|
+
# @param [String] fields
|
|
4911
5321
|
# Selector specifying which fields to include in a partial response.
|
|
4912
5322
|
# @param [String] quota_user
|
|
4913
5323
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
@@ -5185,12 +5595,413 @@ module Google
|
|
|
5185
5595
|
execute_or_queue_command(command, &block)
|
|
5186
5596
|
end
|
|
5187
5597
|
|
|
5188
|
-
# Tunes an existing engine. Only applicable if SolutionType is
|
|
5189
|
-
# SOLUTION_TYPE_RECOMMENDATION.
|
|
5190
|
-
# @param [String] name
|
|
5191
|
-
# Required. The resource name of the engine to tune. Format: `projects/`project`/
|
|
5192
|
-
# locations/`location`/collections/`collection_id`/engines/`engine_id``
|
|
5193
|
-
# @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaTuneEngineRequest] google_cloud_discoveryengine_v1alpha_tune_engine_request_object
|
|
5598
|
+
# Tunes an existing engine. Only applicable if SolutionType is
|
|
5599
|
+
# SOLUTION_TYPE_RECOMMENDATION.
|
|
5600
|
+
# @param [String] name
|
|
5601
|
+
# Required. The resource name of the engine to tune. Format: `projects/`project`/
|
|
5602
|
+
# locations/`location`/collections/`collection_id`/engines/`engine_id``
|
|
5603
|
+
# @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaTuneEngineRequest] google_cloud_discoveryengine_v1alpha_tune_engine_request_object
|
|
5604
|
+
# @param [String] fields
|
|
5605
|
+
# Selector specifying which fields to include in a partial response.
|
|
5606
|
+
# @param [String] quota_user
|
|
5607
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
5608
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
5609
|
+
# @param [Google::Apis::RequestOptions] options
|
|
5610
|
+
# Request-specific options
|
|
5611
|
+
#
|
|
5612
|
+
# @yield [result, err] Result & error if block supplied
|
|
5613
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation] parsed result object
|
|
5614
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
5615
|
+
#
|
|
5616
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation]
|
|
5617
|
+
#
|
|
5618
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
5619
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
5620
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
5621
|
+
def tune_project_location_collection_engine(name, google_cloud_discoveryengine_v1alpha_tune_engine_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
5622
|
+
command = make_simple_command(:post, 'v1alpha/{+name}:tune', options)
|
|
5623
|
+
command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaTuneEngineRequest::Representation
|
|
5624
|
+
command.request_object = google_cloud_discoveryengine_v1alpha_tune_engine_request_object
|
|
5625
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation::Representation
|
|
5626
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation
|
|
5627
|
+
command.params['name'] = name unless name.nil?
|
|
5628
|
+
command.query['fields'] = fields unless fields.nil?
|
|
5629
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
5630
|
+
execute_or_queue_command(command, &block)
|
|
5631
|
+
end
|
|
5632
|
+
|
|
5633
|
+
# Exports metrics.
|
|
5634
|
+
# @param [String] analytics
|
|
5635
|
+
# Required. The analytics resource name under the engine where the metrics are
|
|
5636
|
+
# created. The format is `projects/`project`/locations/`location`/collections/`
|
|
5637
|
+
# collection`/engines/`engine`/analytics`.
|
|
5638
|
+
# @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaExportMetricsRequest] google_cloud_discoveryengine_v1alpha_export_metrics_request_object
|
|
5639
|
+
# @param [String] fields
|
|
5640
|
+
# Selector specifying which fields to include in a partial response.
|
|
5641
|
+
# @param [String] quota_user
|
|
5642
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
5643
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
5644
|
+
# @param [Google::Apis::RequestOptions] options
|
|
5645
|
+
# Request-specific options
|
|
5646
|
+
#
|
|
5647
|
+
# @yield [result, err] Result & error if block supplied
|
|
5648
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation] parsed result object
|
|
5649
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
5650
|
+
#
|
|
5651
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation]
|
|
5652
|
+
#
|
|
5653
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
5654
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
5655
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
5656
|
+
def export_project_location_collection_engine_analytic_metrics(analytics, google_cloud_discoveryengine_v1alpha_export_metrics_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
5657
|
+
command = make_simple_command(:post, 'v1alpha/{+analytics}:exportMetrics', options)
|
|
5658
|
+
command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaExportMetricsRequest::Representation
|
|
5659
|
+
command.request_object = google_cloud_discoveryengine_v1alpha_export_metrics_request_object
|
|
5660
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation::Representation
|
|
5661
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation
|
|
5662
|
+
command.params['analytics'] = analytics unless analytics.nil?
|
|
5663
|
+
command.query['fields'] = fields unless fields.nil?
|
|
5664
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
5665
|
+
execute_or_queue_command(command, &block)
|
|
5666
|
+
end
|
|
5667
|
+
|
|
5668
|
+
# Gets an Assistant.
|
|
5669
|
+
# @param [String] name
|
|
5670
|
+
# Required. Resource name of Assistant. Format: `projects/`project`/locations/`
|
|
5671
|
+
# location`/collections/`collection`/engines/`engine`/assistants/`assistant``
|
|
5672
|
+
# @param [String] fields
|
|
5673
|
+
# Selector specifying which fields to include in a partial response.
|
|
5674
|
+
# @param [String] quota_user
|
|
5675
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
5676
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
5677
|
+
# @param [Google::Apis::RequestOptions] options
|
|
5678
|
+
# Request-specific options
|
|
5679
|
+
#
|
|
5680
|
+
# @yield [result, err] Result & error if block supplied
|
|
5681
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAssistant] parsed result object
|
|
5682
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
5683
|
+
#
|
|
5684
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAssistant]
|
|
5685
|
+
#
|
|
5686
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
5687
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
5688
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
5689
|
+
def get_project_location_collection_engine_assistant(name, fields: nil, quota_user: nil, options: nil, &block)
|
|
5690
|
+
command = make_simple_command(:get, 'v1alpha/{+name}', options)
|
|
5691
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAssistant::Representation
|
|
5692
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAssistant
|
|
5693
|
+
command.params['name'] = name unless name.nil?
|
|
5694
|
+
command.query['fields'] = fields unless fields.nil?
|
|
5695
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
5696
|
+
execute_or_queue_command(command, &block)
|
|
5697
|
+
end
|
|
5698
|
+
|
|
5699
|
+
# Updates an Assistant
|
|
5700
|
+
# @param [String] name
|
|
5701
|
+
# Immutable. Resource name of the assistant. Format: `projects/`project`/
|
|
5702
|
+
# locations/`location`/collections/`collection`/engines/`engine`/assistants/`
|
|
5703
|
+
# assistant`` It must be a UTF-8 encoded string with a length limit of 1024
|
|
5704
|
+
# characters.
|
|
5705
|
+
# @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAssistant] google_cloud_discoveryengine_v1alpha_assistant_object
|
|
5706
|
+
# @param [String] update_mask
|
|
5707
|
+
# The list of fields to update.
|
|
5708
|
+
# @param [String] fields
|
|
5709
|
+
# Selector specifying which fields to include in a partial response.
|
|
5710
|
+
# @param [String] quota_user
|
|
5711
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
5712
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
5713
|
+
# @param [Google::Apis::RequestOptions] options
|
|
5714
|
+
# Request-specific options
|
|
5715
|
+
#
|
|
5716
|
+
# @yield [result, err] Result & error if block supplied
|
|
5717
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAssistant] parsed result object
|
|
5718
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
5719
|
+
#
|
|
5720
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAssistant]
|
|
5721
|
+
#
|
|
5722
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
5723
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
5724
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
5725
|
+
def patch_project_location_collection_engine_assistant(name, google_cloud_discoveryengine_v1alpha_assistant_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
5726
|
+
command = make_simple_command(:patch, 'v1alpha/{+name}', options)
|
|
5727
|
+
command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAssistant::Representation
|
|
5728
|
+
command.request_object = google_cloud_discoveryengine_v1alpha_assistant_object
|
|
5729
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAssistant::Representation
|
|
5730
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAssistant
|
|
5731
|
+
command.params['name'] = name unless name.nil?
|
|
5732
|
+
command.query['updateMask'] = update_mask unless update_mask.nil?
|
|
5733
|
+
command.query['fields'] = fields unless fields.nil?
|
|
5734
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
5735
|
+
execute_or_queue_command(command, &block)
|
|
5736
|
+
end
|
|
5737
|
+
|
|
5738
|
+
# Assists the user with a query in a streaming fashion.
|
|
5739
|
+
# @param [String] name
|
|
5740
|
+
# Required. The resource name of the Assistant. Format: `projects/`project`/
|
|
5741
|
+
# locations/`location`/collections/`collection`/engines/`engine`/assistants/`
|
|
5742
|
+
# assistant``
|
|
5743
|
+
# @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaStreamAssistRequest] google_cloud_discoveryengine_v1alpha_stream_assist_request_object
|
|
5744
|
+
# @param [String] fields
|
|
5745
|
+
# Selector specifying which fields to include in a partial response.
|
|
5746
|
+
# @param [String] quota_user
|
|
5747
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
5748
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
5749
|
+
# @param [Google::Apis::RequestOptions] options
|
|
5750
|
+
# Request-specific options
|
|
5751
|
+
#
|
|
5752
|
+
# @yield [result, err] Result & error if block supplied
|
|
5753
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaStreamAssistResponse] parsed result object
|
|
5754
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
5755
|
+
#
|
|
5756
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaStreamAssistResponse]
|
|
5757
|
+
#
|
|
5758
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
5759
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
5760
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
5761
|
+
def stream_project_location_collection_engine_assistant_assist(name, google_cloud_discoveryengine_v1alpha_stream_assist_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
5762
|
+
command = make_simple_command(:post, 'v1alpha/{+name}:streamAssist', options)
|
|
5763
|
+
command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaStreamAssistRequest::Representation
|
|
5764
|
+
command.request_object = google_cloud_discoveryengine_v1alpha_stream_assist_request_object
|
|
5765
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaStreamAssistResponse::Representation
|
|
5766
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaStreamAssistResponse
|
|
5767
|
+
command.params['name'] = name unless name.nil?
|
|
5768
|
+
command.query['fields'] = fields unless fields.nil?
|
|
5769
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
5770
|
+
execute_or_queue_command(command, &block)
|
|
5771
|
+
end
|
|
5772
|
+
|
|
5773
|
+
# Creates an Agent.
|
|
5774
|
+
# @param [String] parent
|
|
5775
|
+
# Required. The parent resource name. Format: `projects/`project`/locations/`
|
|
5776
|
+
# location`/collections/`collection`/engines/`engine`/assistants/`assistant``
|
|
5777
|
+
# @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAgent] google_cloud_discoveryengine_v1alpha_agent_object
|
|
5778
|
+
# @param [String] fields
|
|
5779
|
+
# Selector specifying which fields to include in a partial response.
|
|
5780
|
+
# @param [String] quota_user
|
|
5781
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
5782
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
5783
|
+
# @param [Google::Apis::RequestOptions] options
|
|
5784
|
+
# Request-specific options
|
|
5785
|
+
#
|
|
5786
|
+
# @yield [result, err] Result & error if block supplied
|
|
5787
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAgent] parsed result object
|
|
5788
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
5789
|
+
#
|
|
5790
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAgent]
|
|
5791
|
+
#
|
|
5792
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
5793
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
5794
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
5795
|
+
def create_project_location_collection_engine_assistant_agent(parent, google_cloud_discoveryengine_v1alpha_agent_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
5796
|
+
command = make_simple_command(:post, 'v1alpha/{+parent}/agents', options)
|
|
5797
|
+
command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAgent::Representation
|
|
5798
|
+
command.request_object = google_cloud_discoveryengine_v1alpha_agent_object
|
|
5799
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAgent::Representation
|
|
5800
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAgent
|
|
5801
|
+
command.params['parent'] = parent unless parent.nil?
|
|
5802
|
+
command.query['fields'] = fields unless fields.nil?
|
|
5803
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
5804
|
+
execute_or_queue_command(command, &block)
|
|
5805
|
+
end
|
|
5806
|
+
|
|
5807
|
+
# Deletes an Agent.
|
|
5808
|
+
# @param [String] name
|
|
5809
|
+
# Required. Resource name of Agent. Format: `projects/`project`/locations/`
|
|
5810
|
+
# location`/collections/`collection`/engines/`engine`/assistants/`assistant`/
|
|
5811
|
+
# agents/`agent`` If the caller does not have permission to delete the agent,
|
|
5812
|
+
# regardless of whether or not it exists, a `PERMISSION_DENIED` error is
|
|
5813
|
+
# returned. If the agent to delete does not exist, a `NOT_FOUND` error is
|
|
5814
|
+
# returned.
|
|
5815
|
+
# @param [String] fields
|
|
5816
|
+
# Selector specifying which fields to include in a partial response.
|
|
5817
|
+
# @param [String] quota_user
|
|
5818
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
5819
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
5820
|
+
# @param [Google::Apis::RequestOptions] options
|
|
5821
|
+
# Request-specific options
|
|
5822
|
+
#
|
|
5823
|
+
# @yield [result, err] Result & error if block supplied
|
|
5824
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation] parsed result object
|
|
5825
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
5826
|
+
#
|
|
5827
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation]
|
|
5828
|
+
#
|
|
5829
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
5830
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
5831
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
5832
|
+
def delete_project_location_collection_engine_assistant_agent(name, fields: nil, quota_user: nil, options: nil, &block)
|
|
5833
|
+
command = make_simple_command(:delete, 'v1alpha/{+name}', options)
|
|
5834
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation::Representation
|
|
5835
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation
|
|
5836
|
+
command.params['name'] = name unless name.nil?
|
|
5837
|
+
command.query['fields'] = fields unless fields.nil?
|
|
5838
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
5839
|
+
execute_or_queue_command(command, &block)
|
|
5840
|
+
end
|
|
5841
|
+
|
|
5842
|
+
# Gets an Agent.
|
|
5843
|
+
# @param [String] name
|
|
5844
|
+
# Required. Resource name of Agent. Format: `projects/`project`/locations/`
|
|
5845
|
+
# location`/collections/`collection`/engines/`engine`/assistants/`assistant`/
|
|
5846
|
+
# agents/`agent``
|
|
5847
|
+
# @param [String] fields
|
|
5848
|
+
# Selector specifying which fields to include in a partial response.
|
|
5849
|
+
# @param [String] quota_user
|
|
5850
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
5851
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
5852
|
+
# @param [Google::Apis::RequestOptions] options
|
|
5853
|
+
# Request-specific options
|
|
5854
|
+
#
|
|
5855
|
+
# @yield [result, err] Result & error if block supplied
|
|
5856
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAgent] parsed result object
|
|
5857
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
5858
|
+
#
|
|
5859
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAgent]
|
|
5860
|
+
#
|
|
5861
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
5862
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
5863
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
5864
|
+
def get_project_location_collection_engine_assistant_agent(name, fields: nil, quota_user: nil, options: nil, &block)
|
|
5865
|
+
command = make_simple_command(:get, 'v1alpha/{+name}', options)
|
|
5866
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAgent::Representation
|
|
5867
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAgent
|
|
5868
|
+
command.params['name'] = name unless name.nil?
|
|
5869
|
+
command.query['fields'] = fields unless fields.nil?
|
|
5870
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
5871
|
+
execute_or_queue_command(command, &block)
|
|
5872
|
+
end
|
|
5873
|
+
|
|
5874
|
+
# Lists all Agents under an Assistant which were created by the caller.
|
|
5875
|
+
# @param [String] parent
|
|
5876
|
+
# Required. The parent resource name. Format: `projects/`project`/locations/`
|
|
5877
|
+
# location`/collections/`collection`/engines/`engine`/assistants/`assistant``
|
|
5878
|
+
# @param [String] order_by
|
|
5879
|
+
# Optional. A comma-separated list of fields to order by, sorted in ascending
|
|
5880
|
+
# order. Use "desc" after a field name for descending. Supported fields: * `
|
|
5881
|
+
# update_time` * `is_pinned` Example: * "update_time desc" * "is_pinned desc,
|
|
5882
|
+
# update_time desc": list agents by is_pinned first, then by update_time.
|
|
5883
|
+
# @param [Fixnum] page_size
|
|
5884
|
+
# Optional. Maximum number of Agents to return. If unspecified, defaults to 100.
|
|
5885
|
+
# The maximum allowed value is 1000; anything above that will be coerced down to
|
|
5886
|
+
# 1000.
|
|
5887
|
+
# @param [String] page_token
|
|
5888
|
+
# Optional. A page token ListAgentsResponse.next_page_token, received from a
|
|
5889
|
+
# previous AgentService.ListAgents call. Provide this to retrieve the subsequent
|
|
5890
|
+
# page. When paginating, all other parameters provided to ListAgents must match
|
|
5891
|
+
# the call that provided the page token.
|
|
5892
|
+
# @param [String] fields
|
|
5893
|
+
# Selector specifying which fields to include in a partial response.
|
|
5894
|
+
# @param [String] quota_user
|
|
5895
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
5896
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
5897
|
+
# @param [Google::Apis::RequestOptions] options
|
|
5898
|
+
# Request-specific options
|
|
5899
|
+
#
|
|
5900
|
+
# @yield [result, err] Result & error if block supplied
|
|
5901
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListAgentsResponse] parsed result object
|
|
5902
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
5903
|
+
#
|
|
5904
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListAgentsResponse]
|
|
5905
|
+
#
|
|
5906
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
5907
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
5908
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
5909
|
+
def list_project_location_collection_engine_assistant_agents(parent, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
5910
|
+
command = make_simple_command(:get, 'v1alpha/{+parent}/agents', options)
|
|
5911
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListAgentsResponse::Representation
|
|
5912
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListAgentsResponse
|
|
5913
|
+
command.params['parent'] = parent unless parent.nil?
|
|
5914
|
+
command.query['orderBy'] = order_by unless order_by.nil?
|
|
5915
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
|
5916
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
|
5917
|
+
command.query['fields'] = fields unless fields.nil?
|
|
5918
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
5919
|
+
execute_or_queue_command(command, &block)
|
|
5920
|
+
end
|
|
5921
|
+
|
|
5922
|
+
# Updates an Agent
|
|
5923
|
+
# @param [String] name
|
|
5924
|
+
# Identifier. Resource name of the agent. Format: `projects/`project`/locations/`
|
|
5925
|
+
# location`/collections/`collection`/engines/`engine`/assistants/`assistant`/
|
|
5926
|
+
# agents/`agent``
|
|
5927
|
+
# @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAgent] google_cloud_discoveryengine_v1alpha_agent_object
|
|
5928
|
+
# @param [String] update_mask
|
|
5929
|
+
# Optional. The list of fields to update.
|
|
5930
|
+
# @param [String] fields
|
|
5931
|
+
# Selector specifying which fields to include in a partial response.
|
|
5932
|
+
# @param [String] quota_user
|
|
5933
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
5934
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
5935
|
+
# @param [Google::Apis::RequestOptions] options
|
|
5936
|
+
# Request-specific options
|
|
5937
|
+
#
|
|
5938
|
+
# @yield [result, err] Result & error if block supplied
|
|
5939
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAgent] parsed result object
|
|
5940
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
5941
|
+
#
|
|
5942
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAgent]
|
|
5943
|
+
#
|
|
5944
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
5945
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
5946
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
5947
|
+
def patch_project_location_collection_engine_assistant_agent(name, google_cloud_discoveryengine_v1alpha_agent_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
5948
|
+
command = make_simple_command(:patch, 'v1alpha/{+name}', options)
|
|
5949
|
+
command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAgent::Representation
|
|
5950
|
+
command.request_object = google_cloud_discoveryengine_v1alpha_agent_object
|
|
5951
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAgent::Representation
|
|
5952
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAgent
|
|
5953
|
+
command.params['name'] = name unless name.nil?
|
|
5954
|
+
command.query['updateMask'] = update_mask unless update_mask.nil?
|
|
5955
|
+
command.query['fields'] = fields unless fields.nil?
|
|
5956
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
5957
|
+
execute_or_queue_command(command, &block)
|
|
5958
|
+
end
|
|
5959
|
+
|
|
5960
|
+
# Imports a file to an Agent. Currently only No-Code agents are supported.
|
|
5961
|
+
# @param [String] parent
|
|
5962
|
+
# Required. The resource name of the Agent. Format: `projects/`project`/
|
|
5963
|
+
# locations/`location`/collections/`collection`/engines/`engine`/assistants/`
|
|
5964
|
+
# assistant`/agents/`agent``
|
|
5965
|
+
# @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaImportAgentFileRequest] google_cloud_discoveryengine_v1alpha_import_agent_file_request_object
|
|
5966
|
+
# @param [String] fields
|
|
5967
|
+
# Selector specifying which fields to include in a partial response.
|
|
5968
|
+
# @param [String] quota_user
|
|
5969
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
5970
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
5971
|
+
# @param [Google::Apis::RequestOptions] options
|
|
5972
|
+
# Request-specific options
|
|
5973
|
+
#
|
|
5974
|
+
# @yield [result, err] Result & error if block supplied
|
|
5975
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaImportAgentFileResponse] parsed result object
|
|
5976
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
5977
|
+
#
|
|
5978
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaImportAgentFileResponse]
|
|
5979
|
+
#
|
|
5980
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
5981
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
5982
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
5983
|
+
def import_project_location_collection_engine_assistant_agent_file(parent, google_cloud_discoveryengine_v1alpha_import_agent_file_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
5984
|
+
command = make_simple_command(:post, 'v1alpha/{+parent}/files:import', options)
|
|
5985
|
+
command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaImportAgentFileRequest::Representation
|
|
5986
|
+
command.request_object = google_cloud_discoveryengine_v1alpha_import_agent_file_request_object
|
|
5987
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaImportAgentFileResponse::Representation
|
|
5988
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaImportAgentFileResponse
|
|
5989
|
+
command.params['parent'] = parent unless parent.nil?
|
|
5990
|
+
command.query['fields'] = fields unless fields.nil?
|
|
5991
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
5992
|
+
execute_or_queue_command(command, &block)
|
|
5993
|
+
end
|
|
5994
|
+
|
|
5995
|
+
# Creates a CannedQuery.
|
|
5996
|
+
# @param [String] parent
|
|
5997
|
+
# Required. The parent resource name. Format: `projects/`project`/locations/`
|
|
5998
|
+
# location`/collections/`collection`/engines/`engine`/assistants/`assistant``
|
|
5999
|
+
# @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaCannedQuery] google_cloud_discoveryengine_v1alpha_canned_query_object
|
|
6000
|
+
# @param [String] canned_query_id
|
|
6001
|
+
# Required. The ID to use for the canned query, which will become the final
|
|
6002
|
+
# component of the canned query's resource name. This field must conform to [RFC-
|
|
6003
|
+
# 1034](https://tools.ietf.org/html/rfc1034) with a length limit of 63
|
|
6004
|
+
# characters.
|
|
5194
6005
|
# @param [String] fields
|
|
5195
6006
|
# Selector specifying which fields to include in a partial response.
|
|
5196
6007
|
# @param [String] quota_user
|
|
@@ -5200,32 +6011,35 @@ module Google
|
|
|
5200
6011
|
# Request-specific options
|
|
5201
6012
|
#
|
|
5202
6013
|
# @yield [result, err] Result & error if block supplied
|
|
5203
|
-
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::
|
|
6014
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaCannedQuery] parsed result object
|
|
5204
6015
|
# @yieldparam err [StandardError] error object if request failed
|
|
5205
6016
|
#
|
|
5206
|
-
# @return [Google::Apis::DiscoveryengineV1alpha::
|
|
6017
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaCannedQuery]
|
|
5207
6018
|
#
|
|
5208
6019
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
5209
6020
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
5210
6021
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
5211
|
-
def
|
|
5212
|
-
command = make_simple_command(:post, 'v1alpha/{+
|
|
5213
|
-
command.request_representation = Google::Apis::DiscoveryengineV1alpha::
|
|
5214
|
-
command.request_object =
|
|
5215
|
-
command.response_representation = Google::Apis::DiscoveryengineV1alpha::
|
|
5216
|
-
command.response_class = Google::Apis::DiscoveryengineV1alpha::
|
|
5217
|
-
command.params['
|
|
6022
|
+
def create_project_location_collection_engine_assistant_canned_query(parent, google_cloud_discoveryengine_v1alpha_canned_query_object = nil, canned_query_id: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
6023
|
+
command = make_simple_command(:post, 'v1alpha/{+parent}/cannedQueries', options)
|
|
6024
|
+
command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaCannedQuery::Representation
|
|
6025
|
+
command.request_object = google_cloud_discoveryengine_v1alpha_canned_query_object
|
|
6026
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaCannedQuery::Representation
|
|
6027
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaCannedQuery
|
|
6028
|
+
command.params['parent'] = parent unless parent.nil?
|
|
6029
|
+
command.query['cannedQueryId'] = canned_query_id unless canned_query_id.nil?
|
|
5218
6030
|
command.query['fields'] = fields unless fields.nil?
|
|
5219
6031
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
5220
6032
|
execute_or_queue_command(command, &block)
|
|
5221
6033
|
end
|
|
5222
6034
|
|
|
5223
|
-
#
|
|
5224
|
-
# @param [String]
|
|
5225
|
-
# Required.
|
|
5226
|
-
#
|
|
5227
|
-
#
|
|
5228
|
-
#
|
|
6035
|
+
# Deletes a CannedQuery.
|
|
6036
|
+
# @param [String] name
|
|
6037
|
+
# Required. Resource name of CannedQuery. Format: `projects/`project`/locations/`
|
|
6038
|
+
# location`/collections/`collection`/engines/`engine`/assistants/`assistant`/
|
|
6039
|
+
# cannedQueries/`canned_query`` If the caller does not have permission to delete
|
|
6040
|
+
# the canned query, regardless of whether or not it exists, a `PERMISSION_DENIED`
|
|
6041
|
+
# error is returned. If the canned query to delete does not exist, a `NOT_FOUND`
|
|
6042
|
+
# error is returned.
|
|
5229
6043
|
# @param [String] fields
|
|
5230
6044
|
# Selector specifying which fields to include in a partial response.
|
|
5231
6045
|
# @param [String] quota_user
|
|
@@ -5235,30 +6049,29 @@ module Google
|
|
|
5235
6049
|
# Request-specific options
|
|
5236
6050
|
#
|
|
5237
6051
|
# @yield [result, err] Result & error if block supplied
|
|
5238
|
-
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::
|
|
6052
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleProtobufEmpty] parsed result object
|
|
5239
6053
|
# @yieldparam err [StandardError] error object if request failed
|
|
5240
6054
|
#
|
|
5241
|
-
# @return [Google::Apis::DiscoveryengineV1alpha::
|
|
6055
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleProtobufEmpty]
|
|
5242
6056
|
#
|
|
5243
6057
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
5244
6058
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
5245
6059
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
5246
|
-
def
|
|
5247
|
-
command = make_simple_command(:
|
|
5248
|
-
command.
|
|
5249
|
-
command.
|
|
5250
|
-
command.
|
|
5251
|
-
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation
|
|
5252
|
-
command.params['analytics'] = analytics unless analytics.nil?
|
|
6060
|
+
def delete_project_location_collection_engine_assistant_canned_query(name, fields: nil, quota_user: nil, options: nil, &block)
|
|
6061
|
+
command = make_simple_command(:delete, 'v1alpha/{+name}', options)
|
|
6062
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleProtobufEmpty::Representation
|
|
6063
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleProtobufEmpty
|
|
6064
|
+
command.params['name'] = name unless name.nil?
|
|
5253
6065
|
command.query['fields'] = fields unless fields.nil?
|
|
5254
6066
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
5255
6067
|
execute_or_queue_command(command, &block)
|
|
5256
6068
|
end
|
|
5257
6069
|
|
|
5258
|
-
# Gets
|
|
6070
|
+
# Gets a CannedQuery.
|
|
5259
6071
|
# @param [String] name
|
|
5260
|
-
# Required. Resource name of
|
|
5261
|
-
# location`/collections/`collection`/engines/`engine`/assistants/`assistant
|
|
6072
|
+
# Required. Resource name of CannedQuery. Format: `projects/`project`/locations/`
|
|
6073
|
+
# location`/collections/`collection`/engines/`engine`/assistants/`assistant`/
|
|
6074
|
+
# cannedQueries/`canned_query``
|
|
5262
6075
|
# @param [String] fields
|
|
5263
6076
|
# Selector specifying which fields to include in a partial response.
|
|
5264
6077
|
# @param [String] quota_user
|
|
@@ -5268,33 +6081,41 @@ module Google
|
|
|
5268
6081
|
# Request-specific options
|
|
5269
6082
|
#
|
|
5270
6083
|
# @yield [result, err] Result & error if block supplied
|
|
5271
|
-
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::
|
|
6084
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaCannedQuery] parsed result object
|
|
5272
6085
|
# @yieldparam err [StandardError] error object if request failed
|
|
5273
6086
|
#
|
|
5274
|
-
# @return [Google::Apis::DiscoveryengineV1alpha::
|
|
6087
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaCannedQuery]
|
|
5275
6088
|
#
|
|
5276
6089
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
5277
6090
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
5278
6091
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
5279
|
-
def
|
|
6092
|
+
def get_project_location_collection_engine_assistant_canned_query(name, fields: nil, quota_user: nil, options: nil, &block)
|
|
5280
6093
|
command = make_simple_command(:get, 'v1alpha/{+name}', options)
|
|
5281
|
-
command.response_representation = Google::Apis::DiscoveryengineV1alpha::
|
|
5282
|
-
command.response_class = Google::Apis::DiscoveryengineV1alpha::
|
|
6094
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaCannedQuery::Representation
|
|
6095
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaCannedQuery
|
|
5283
6096
|
command.params['name'] = name unless name.nil?
|
|
5284
6097
|
command.query['fields'] = fields unless fields.nil?
|
|
5285
6098
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
5286
6099
|
execute_or_queue_command(command, &block)
|
|
5287
6100
|
end
|
|
5288
6101
|
|
|
5289
|
-
#
|
|
5290
|
-
# @param [String]
|
|
5291
|
-
#
|
|
5292
|
-
#
|
|
5293
|
-
#
|
|
5294
|
-
#
|
|
5295
|
-
#
|
|
5296
|
-
#
|
|
5297
|
-
#
|
|
6102
|
+
# Lists all CannedQuerys under an Assistant.
|
|
6103
|
+
# @param [String] parent
|
|
6104
|
+
# Required. The parent resource name. Format: `projects/`project`/locations/`
|
|
6105
|
+
# location`/collections/`collection`/engines/`engine`/assistants/`assistant``
|
|
6106
|
+
# @param [String] filter
|
|
6107
|
+
# Optional. The filter expression. Supported fields: * `enabled` * `
|
|
6108
|
+
# google_defined` Examples: * `enabled=true` * `google_defined=true` * `enabled=
|
|
6109
|
+
# true AND google_defined=true`
|
|
6110
|
+
# @param [Fixnum] page_size
|
|
6111
|
+
# Maximum number of canned queries to return. If unspecified, defaults to 100.
|
|
6112
|
+
# The maximum allowed value is 1000; anything above that will be coerced down to
|
|
6113
|
+
# 1000.
|
|
6114
|
+
# @param [String] page_token
|
|
6115
|
+
# A page token received from a previous CannedQueryService.ListCannedQueries
|
|
6116
|
+
# call. Provide this to retrieve the subsequent page. When paginating, all other
|
|
6117
|
+
# parameters provided to CannedQueryService.ListCannedQueries must match the
|
|
6118
|
+
# call that provided the page token.
|
|
5298
6119
|
# @param [String] fields
|
|
5299
6120
|
# Selector specifying which fields to include in a partial response.
|
|
5300
6121
|
# @param [String] quota_user
|
|
@@ -5304,33 +6125,36 @@ module Google
|
|
|
5304
6125
|
# Request-specific options
|
|
5305
6126
|
#
|
|
5306
6127
|
# @yield [result, err] Result & error if block supplied
|
|
5307
|
-
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::
|
|
6128
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListCannedQueriesResponse] parsed result object
|
|
5308
6129
|
# @yieldparam err [StandardError] error object if request failed
|
|
5309
6130
|
#
|
|
5310
|
-
# @return [Google::Apis::DiscoveryengineV1alpha::
|
|
6131
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListCannedQueriesResponse]
|
|
5311
6132
|
#
|
|
5312
6133
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
5313
6134
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
5314
6135
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
5315
|
-
def
|
|
5316
|
-
command = make_simple_command(:
|
|
5317
|
-
command.
|
|
5318
|
-
command.
|
|
5319
|
-
command.
|
|
5320
|
-
command.
|
|
5321
|
-
command.
|
|
5322
|
-
command.query['
|
|
6136
|
+
def list_project_location_collection_engine_assistant_canned_queries(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
6137
|
+
command = make_simple_command(:get, 'v1alpha/{+parent}/cannedQueries', options)
|
|
6138
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListCannedQueriesResponse::Representation
|
|
6139
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListCannedQueriesResponse
|
|
6140
|
+
command.params['parent'] = parent unless parent.nil?
|
|
6141
|
+
command.query['filter'] = filter unless filter.nil?
|
|
6142
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
|
6143
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
|
5323
6144
|
command.query['fields'] = fields unless fields.nil?
|
|
5324
6145
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
5325
6146
|
execute_or_queue_command(command, &block)
|
|
5326
6147
|
end
|
|
5327
6148
|
|
|
5328
|
-
#
|
|
6149
|
+
# Updates a CannedQuery.
|
|
5329
6150
|
# @param [String] name
|
|
5330
|
-
#
|
|
6151
|
+
# Immutable. Resource name of the canned query. Format: `projects/`project`/
|
|
5331
6152
|
# locations/`location`/collections/`collection`/engines/`engine`/assistants/`
|
|
5332
|
-
# assistant``
|
|
5333
|
-
#
|
|
6153
|
+
# assistant`/cannedQueries/`canned_query`` It must be a UTF-8 encoded string
|
|
6154
|
+
# with a length limit of 1024 characters.
|
|
6155
|
+
# @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaCannedQuery] google_cloud_discoveryengine_v1alpha_canned_query_object
|
|
6156
|
+
# @param [String] update_mask
|
|
6157
|
+
# The list of fields to update.
|
|
5334
6158
|
# @param [String] fields
|
|
5335
6159
|
# Selector specifying which fields to include in a partial response.
|
|
5336
6160
|
# @param [String] quota_user
|
|
@@ -5340,21 +6164,22 @@ module Google
|
|
|
5340
6164
|
# Request-specific options
|
|
5341
6165
|
#
|
|
5342
6166
|
# @yield [result, err] Result & error if block supplied
|
|
5343
|
-
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::
|
|
6167
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaCannedQuery] parsed result object
|
|
5344
6168
|
# @yieldparam err [StandardError] error object if request failed
|
|
5345
6169
|
#
|
|
5346
|
-
# @return [Google::Apis::DiscoveryengineV1alpha::
|
|
6170
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaCannedQuery]
|
|
5347
6171
|
#
|
|
5348
6172
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
5349
6173
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
5350
6174
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
5351
|
-
def
|
|
5352
|
-
command = make_simple_command(:
|
|
5353
|
-
command.request_representation = Google::Apis::DiscoveryengineV1alpha::
|
|
5354
|
-
command.request_object =
|
|
5355
|
-
command.response_representation = Google::Apis::DiscoveryengineV1alpha::
|
|
5356
|
-
command.response_class = Google::Apis::DiscoveryengineV1alpha::
|
|
6175
|
+
def patch_project_location_collection_engine_assistant_canned_query(name, google_cloud_discoveryengine_v1alpha_canned_query_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
6176
|
+
command = make_simple_command(:patch, 'v1alpha/{+name}', options)
|
|
6177
|
+
command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaCannedQuery::Representation
|
|
6178
|
+
command.request_object = google_cloud_discoveryengine_v1alpha_canned_query_object
|
|
6179
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaCannedQuery::Representation
|
|
6180
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaCannedQuery
|
|
5357
6181
|
command.params['name'] = name unless name.nil?
|
|
6182
|
+
command.query['updateMask'] = update_mask unless update_mask.nil?
|
|
5358
6183
|
command.query['fields'] = fields unless fields.nil?
|
|
5359
6184
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
5360
6185
|
execute_or_queue_command(command, &block)
|
|
@@ -6590,6 +7415,47 @@ module Google
|
|
|
6590
7415
|
execute_or_queue_command(command, &block)
|
|
6591
7416
|
end
|
|
6592
7417
|
|
|
7418
|
+
# Update a WidgetConfig.
|
|
7419
|
+
# @param [String] name
|
|
7420
|
+
# Immutable. The full resource name of the widget config. Format: `projects/`
|
|
7421
|
+
# project`/locations/`location`/collections/`collection_id`/dataStores/`
|
|
7422
|
+
# data_store_id`/widgetConfigs/`widget_config_id``. This field must be a UTF-8
|
|
7423
|
+
# encoded string with a length limit of 1024 characters.
|
|
7424
|
+
# @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaWidgetConfig] google_cloud_discoveryengine_v1alpha_widget_config_object
|
|
7425
|
+
# @param [String] update_mask
|
|
7426
|
+
# Indicates which fields in the provided WidgetConfig to update. The following
|
|
7427
|
+
# are the only supported fields: * WidgetConfig.enable_autocomplete If not set,
|
|
7428
|
+
# all supported fields are updated.
|
|
7429
|
+
# @param [String] fields
|
|
7430
|
+
# Selector specifying which fields to include in a partial response.
|
|
7431
|
+
# @param [String] quota_user
|
|
7432
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
7433
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
7434
|
+
# @param [Google::Apis::RequestOptions] options
|
|
7435
|
+
# Request-specific options
|
|
7436
|
+
#
|
|
7437
|
+
# @yield [result, err] Result & error if block supplied
|
|
7438
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaWidgetConfig] parsed result object
|
|
7439
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
7440
|
+
#
|
|
7441
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaWidgetConfig]
|
|
7442
|
+
#
|
|
7443
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
7444
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
7445
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
7446
|
+
def patch_project_location_collection_engine_widget_config(name, google_cloud_discoveryengine_v1alpha_widget_config_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
7447
|
+
command = make_simple_command(:patch, 'v1alpha/{+name}', options)
|
|
7448
|
+
command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaWidgetConfig::Representation
|
|
7449
|
+
command.request_object = google_cloud_discoveryengine_v1alpha_widget_config_object
|
|
7450
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaWidgetConfig::Representation
|
|
7451
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaWidgetConfig
|
|
7452
|
+
command.params['name'] = name unless name.nil?
|
|
7453
|
+
command.query['updateMask'] = update_mask unless update_mask.nil?
|
|
7454
|
+
command.query['fields'] = fields unless fields.nil?
|
|
7455
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
7456
|
+
execute_or_queue_command(command, &block)
|
|
7457
|
+
end
|
|
7458
|
+
|
|
6593
7459
|
# Gets the latest state of a long-running operation. Clients can use this method
|
|
6594
7460
|
# to poll the operation result at intervals as recommended by the API service.
|
|
6595
7461
|
# @param [String] name
|
|
@@ -6693,9 +7559,9 @@ module Google
|
|
|
6693
7559
|
# values: * `document` is the default model for regular dataStores. * `search-
|
|
6694
7560
|
# history` is the default model for site search dataStores.
|
|
6695
7561
|
# @param [String] user_pseudo_id
|
|
6696
|
-
# A unique identifier for tracking visitors. For example, this could
|
|
6697
|
-
# implemented with an HTTP cookie, which should be able to uniquely identify
|
|
6698
|
-
# visitor on a single device. This unique identifier should not change if the
|
|
7562
|
+
# Optional. A unique identifier for tracking visitors. For example, this could
|
|
7563
|
+
# be implemented with an HTTP cookie, which should be able to uniquely identify
|
|
7564
|
+
# a visitor on a single device. This unique identifier should not change if the
|
|
6699
7565
|
# visitor logs in or out of the website. This field should NOT have a fixed
|
|
6700
7566
|
# value such as `unknown_visitor`. This should be the same identifier as
|
|
6701
7567
|
# UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a
|
|
@@ -9815,6 +10681,47 @@ module Google
|
|
|
9815
10681
|
execute_or_queue_command(command, &block)
|
|
9816
10682
|
end
|
|
9817
10683
|
|
|
10684
|
+
# Update a WidgetConfig.
|
|
10685
|
+
# @param [String] name
|
|
10686
|
+
# Immutable. The full resource name of the widget config. Format: `projects/`
|
|
10687
|
+
# project`/locations/`location`/collections/`collection_id`/dataStores/`
|
|
10688
|
+
# data_store_id`/widgetConfigs/`widget_config_id``. This field must be a UTF-8
|
|
10689
|
+
# encoded string with a length limit of 1024 characters.
|
|
10690
|
+
# @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaWidgetConfig] google_cloud_discoveryengine_v1alpha_widget_config_object
|
|
10691
|
+
# @param [String] update_mask
|
|
10692
|
+
# Indicates which fields in the provided WidgetConfig to update. The following
|
|
10693
|
+
# are the only supported fields: * WidgetConfig.enable_autocomplete If not set,
|
|
10694
|
+
# all supported fields are updated.
|
|
10695
|
+
# @param [String] fields
|
|
10696
|
+
# Selector specifying which fields to include in a partial response.
|
|
10697
|
+
# @param [String] quota_user
|
|
10698
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
10699
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
10700
|
+
# @param [Google::Apis::RequestOptions] options
|
|
10701
|
+
# Request-specific options
|
|
10702
|
+
#
|
|
10703
|
+
# @yield [result, err] Result & error if block supplied
|
|
10704
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaWidgetConfig] parsed result object
|
|
10705
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
10706
|
+
#
|
|
10707
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaWidgetConfig]
|
|
10708
|
+
#
|
|
10709
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
10710
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
10711
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
10712
|
+
def patch_project_location_data_store_widget_config(name, google_cloud_discoveryengine_v1alpha_widget_config_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
10713
|
+
command = make_simple_command(:patch, 'v1alpha/{+name}', options)
|
|
10714
|
+
command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaWidgetConfig::Representation
|
|
10715
|
+
command.request_object = google_cloud_discoveryengine_v1alpha_widget_config_object
|
|
10716
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaWidgetConfig::Representation
|
|
10717
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaWidgetConfig
|
|
10718
|
+
command.params['name'] = name unless name.nil?
|
|
10719
|
+
command.query['updateMask'] = update_mask unless update_mask.nil?
|
|
10720
|
+
command.query['fields'] = fields unless fields.nil?
|
|
10721
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
10722
|
+
execute_or_queue_command(command, &block)
|
|
10723
|
+
end
|
|
10724
|
+
|
|
9818
10725
|
# Creates a Evaluation. Upon creation, the evaluation will be automatically
|
|
9819
10726
|
# triggered and begin execution.
|
|
9820
10727
|
# @param [String] parent
|
|
@@ -11687,6 +12594,145 @@ module Google
|
|
|
11687
12594
|
execute_or_queue_command(command, &block)
|
|
11688
12595
|
end
|
|
11689
12596
|
|
|
12597
|
+
# Creates a new User Store.
|
|
12598
|
+
# @param [String] parent
|
|
12599
|
+
# Required. The parent collection resource name, such as `projects/`project`/
|
|
12600
|
+
# locations/`location``.
|
|
12601
|
+
# @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaUserStore] google_cloud_discoveryengine_v1alpha_user_store_object
|
|
12602
|
+
# @param [String] user_store_id
|
|
12603
|
+
# Required. The ID of the User Store to create. The ID must contain only letters
|
|
12604
|
+
# (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum
|
|
12605
|
+
# length is 63 characters.
|
|
12606
|
+
# @param [String] fields
|
|
12607
|
+
# Selector specifying which fields to include in a partial response.
|
|
12608
|
+
# @param [String] quota_user
|
|
12609
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
12610
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
12611
|
+
# @param [Google::Apis::RequestOptions] options
|
|
12612
|
+
# Request-specific options
|
|
12613
|
+
#
|
|
12614
|
+
# @yield [result, err] Result & error if block supplied
|
|
12615
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaUserStore] parsed result object
|
|
12616
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
12617
|
+
#
|
|
12618
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaUserStore]
|
|
12619
|
+
#
|
|
12620
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
12621
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
12622
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
12623
|
+
def create_project_location_user_store(parent, google_cloud_discoveryengine_v1alpha_user_store_object = nil, user_store_id: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
12624
|
+
command = make_simple_command(:post, 'v1alpha/{+parent}/userStores', options)
|
|
12625
|
+
command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaUserStore::Representation
|
|
12626
|
+
command.request_object = google_cloud_discoveryengine_v1alpha_user_store_object
|
|
12627
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaUserStore::Representation
|
|
12628
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaUserStore
|
|
12629
|
+
command.params['parent'] = parent unless parent.nil?
|
|
12630
|
+
command.query['userStoreId'] = user_store_id unless user_store_id.nil?
|
|
12631
|
+
command.query['fields'] = fields unless fields.nil?
|
|
12632
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
12633
|
+
execute_or_queue_command(command, &block)
|
|
12634
|
+
end
|
|
12635
|
+
|
|
12636
|
+
# Deletes the User Store.
|
|
12637
|
+
# @param [String] name
|
|
12638
|
+
# Required. The name of the User Store to delete. Format: `projects/`project`/
|
|
12639
|
+
# locations/`location`/userStores/`user_store_id``
|
|
12640
|
+
# @param [String] fields
|
|
12641
|
+
# Selector specifying which fields to include in a partial response.
|
|
12642
|
+
# @param [String] quota_user
|
|
12643
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
12644
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
12645
|
+
# @param [Google::Apis::RequestOptions] options
|
|
12646
|
+
# Request-specific options
|
|
12647
|
+
#
|
|
12648
|
+
# @yield [result, err] Result & error if block supplied
|
|
12649
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation] parsed result object
|
|
12650
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
12651
|
+
#
|
|
12652
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation]
|
|
12653
|
+
#
|
|
12654
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
12655
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
12656
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
12657
|
+
def delete_project_location_user_store(name, fields: nil, quota_user: nil, options: nil, &block)
|
|
12658
|
+
command = make_simple_command(:delete, 'v1alpha/{+name}', options)
|
|
12659
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation::Representation
|
|
12660
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation
|
|
12661
|
+
command.params['name'] = name unless name.nil?
|
|
12662
|
+
command.query['fields'] = fields unless fields.nil?
|
|
12663
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
12664
|
+
execute_or_queue_command(command, &block)
|
|
12665
|
+
end
|
|
12666
|
+
|
|
12667
|
+
# Gets the User Store.
|
|
12668
|
+
# @param [String] name
|
|
12669
|
+
# Required. The name of the User Store to get. Format: `projects/`project`/
|
|
12670
|
+
# locations/`location`/userStores/`user_store_id``
|
|
12671
|
+
# @param [String] fields
|
|
12672
|
+
# Selector specifying which fields to include in a partial response.
|
|
12673
|
+
# @param [String] quota_user
|
|
12674
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
12675
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
12676
|
+
# @param [Google::Apis::RequestOptions] options
|
|
12677
|
+
# Request-specific options
|
|
12678
|
+
#
|
|
12679
|
+
# @yield [result, err] Result & error if block supplied
|
|
12680
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaUserStore] parsed result object
|
|
12681
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
12682
|
+
#
|
|
12683
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaUserStore]
|
|
12684
|
+
#
|
|
12685
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
12686
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
12687
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
12688
|
+
def get_project_location_user_store(name, fields: nil, quota_user: nil, options: nil, &block)
|
|
12689
|
+
command = make_simple_command(:get, 'v1alpha/{+name}', options)
|
|
12690
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaUserStore::Representation
|
|
12691
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaUserStore
|
|
12692
|
+
command.params['name'] = name unless name.nil?
|
|
12693
|
+
command.query['fields'] = fields unless fields.nil?
|
|
12694
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
12695
|
+
execute_or_queue_command(command, &block)
|
|
12696
|
+
end
|
|
12697
|
+
|
|
12698
|
+
# Updates the User Store.
|
|
12699
|
+
# @param [String] name
|
|
12700
|
+
# Immutable. The full resource name of the User Store, in the format of `
|
|
12701
|
+
# projects/`project`/locations/`location`/userStores/`user_store``. This field
|
|
12702
|
+
# must be a UTF-8 encoded string with a length limit of 1024 characters.
|
|
12703
|
+
# @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaUserStore] google_cloud_discoveryengine_v1alpha_user_store_object
|
|
12704
|
+
# @param [String] update_mask
|
|
12705
|
+
# Optional. The list of fields to update.
|
|
12706
|
+
# @param [String] fields
|
|
12707
|
+
# Selector specifying which fields to include in a partial response.
|
|
12708
|
+
# @param [String] quota_user
|
|
12709
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
12710
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
12711
|
+
# @param [Google::Apis::RequestOptions] options
|
|
12712
|
+
# Request-specific options
|
|
12713
|
+
#
|
|
12714
|
+
# @yield [result, err] Result & error if block supplied
|
|
12715
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaUserStore] parsed result object
|
|
12716
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
12717
|
+
#
|
|
12718
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaUserStore]
|
|
12719
|
+
#
|
|
12720
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
12721
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
12722
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
12723
|
+
def patch_project_location_user_store(name, google_cloud_discoveryengine_v1alpha_user_store_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
12724
|
+
command = make_simple_command(:patch, 'v1alpha/{+name}', options)
|
|
12725
|
+
command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaUserStore::Representation
|
|
12726
|
+
command.request_object = google_cloud_discoveryengine_v1alpha_user_store_object
|
|
12727
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaUserStore::Representation
|
|
12728
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaUserStore
|
|
12729
|
+
command.params['name'] = name unless name.nil?
|
|
12730
|
+
command.query['updateMask'] = update_mask unless update_mask.nil?
|
|
12731
|
+
command.query['fields'] = fields unless fields.nil?
|
|
12732
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
12733
|
+
execute_or_queue_command(command, &block)
|
|
12734
|
+
end
|
|
12735
|
+
|
|
11690
12736
|
# Gets the latest state of a long-running operation. Clients can use this method
|
|
11691
12737
|
# to poll the operation result at intervals as recommended by the API service.
|
|
11692
12738
|
# @param [String] name
|