google-apis-discoveryengine_v1alpha 0.81.0 → 0.83.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 +1659 -65
- data/lib/google/apis/discoveryengine_v1alpha/gem_version.rb +2 -2
- data/lib/google/apis/discoveryengine_v1alpha/representations.rb +602 -1
- data/lib/google/apis/discoveryengine_v1alpha/service.rb +1131 -158
- metadata +2 -2
|
@@ -86,6 +86,74 @@ module Google
|
|
|
86
86
|
execute_or_queue_command(command, &block)
|
|
87
87
|
end
|
|
88
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
|
+
|
|
89
157
|
# This method is called from the billing account side to retract the
|
|
90
158
|
# LicenseConfig from the given project back to the billing account.
|
|
91
159
|
# @param [String] billing_account_license_config
|
|
@@ -167,6 +235,52 @@ module Google
|
|
|
167
235
|
execute_or_queue_command(command, &block)
|
|
168
236
|
end
|
|
169
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
|
+
|
|
170
284
|
# Gets a Project. Returns NOT_FOUND when the project is not yet created.
|
|
171
285
|
# @param [String] name
|
|
172
286
|
# Required. Full resource name of a Project, such as `projects/`
|
|
@@ -742,6 +856,190 @@ module Google
|
|
|
742
856
|
execute_or_queue_command(command, &block)
|
|
743
857
|
end
|
|
744
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
|
+
|
|
745
1043
|
# De-provisions a CmekConfig.
|
|
746
1044
|
# @param [String] name
|
|
747
1045
|
# Required. The resource name of the CmekConfig to delete, such as `projects/`
|
|
@@ -1394,9 +1692,9 @@ module Google
|
|
|
1394
1692
|
# values: * `document` is the default model for regular dataStores. * `search-
|
|
1395
1693
|
# history` is the default model for site search dataStores.
|
|
1396
1694
|
# @param [String] user_pseudo_id
|
|
1397
|
-
# A unique identifier for tracking visitors. For example, this could
|
|
1398
|
-
# implemented with an HTTP cookie, which should be able to uniquely identify
|
|
1399
|
-
# 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
|
|
1400
1698
|
# visitor logs in or out of the website. This field should NOT have a fixed
|
|
1401
1699
|
# value such as `unknown_visitor`. This should be the same identifier as
|
|
1402
1700
|
# UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a
|
|
@@ -4968,6 +5266,47 @@ module Google
|
|
|
4968
5266
|
execute_or_queue_command(command, &block)
|
|
4969
5267
|
end
|
|
4970
5268
|
|
|
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
|
+
|
|
4971
5310
|
# Creates a Engine.
|
|
4972
5311
|
# @param [String] parent
|
|
4973
5312
|
# Required. The parent resource name, such as `projects/`project`/locations/`
|
|
@@ -5086,35 +5425,528 @@ module Google
|
|
|
5086
5425
|
# Request-specific options
|
|
5087
5426
|
#
|
|
5088
5427
|
# @yield [result, err] Result & error if block supplied
|
|
5089
|
-
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaWorkspaceSettings] parsed result object
|
|
5428
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaWorkspaceSettings] parsed result object
|
|
5429
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
5430
|
+
#
|
|
5431
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaWorkspaceSettings]
|
|
5432
|
+
#
|
|
5433
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
5434
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
5435
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
5436
|
+
def get_project_location_collection_engine_workspace_settings(name, fields: nil, quota_user: nil, options: nil, &block)
|
|
5437
|
+
command = make_simple_command(:get, 'v1alpha/{+name}:getWorkspaceSettings', options)
|
|
5438
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaWorkspaceSettings::Representation
|
|
5439
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaWorkspaceSettings
|
|
5440
|
+
command.params['name'] = name unless name.nil?
|
|
5441
|
+
command.query['fields'] = fields unless fields.nil?
|
|
5442
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
5443
|
+
execute_or_queue_command(command, &block)
|
|
5444
|
+
end
|
|
5445
|
+
|
|
5446
|
+
# Lists all the Engines associated with the project.
|
|
5447
|
+
# @param [String] parent
|
|
5448
|
+
# Required. The parent resource name, such as `projects/`project`/locations/`
|
|
5449
|
+
# location`/collections/`collection_id``.
|
|
5450
|
+
# @param [String] filter
|
|
5451
|
+
# Optional. Filter by solution type. For example: solution_type=
|
|
5452
|
+
# SOLUTION_TYPE_SEARCH
|
|
5453
|
+
# @param [Fixnum] page_size
|
|
5454
|
+
# Optional. Not supported.
|
|
5455
|
+
# @param [String] page_token
|
|
5456
|
+
# Optional. Not supported.
|
|
5457
|
+
# @param [String] fields
|
|
5458
|
+
# Selector specifying which fields to include in a partial response.
|
|
5459
|
+
# @param [String] quota_user
|
|
5460
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
5461
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
5462
|
+
# @param [Google::Apis::RequestOptions] options
|
|
5463
|
+
# Request-specific options
|
|
5464
|
+
#
|
|
5465
|
+
# @yield [result, err] Result & error if block supplied
|
|
5466
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListEnginesResponse] parsed result object
|
|
5467
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
5468
|
+
#
|
|
5469
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListEnginesResponse]
|
|
5470
|
+
#
|
|
5471
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
5472
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
5473
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
5474
|
+
def list_project_location_collection_engines(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
5475
|
+
command = make_simple_command(:get, 'v1alpha/{+parent}/engines', options)
|
|
5476
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListEnginesResponse::Representation
|
|
5477
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListEnginesResponse
|
|
5478
|
+
command.params['parent'] = parent unless parent.nil?
|
|
5479
|
+
command.query['filter'] = filter unless filter.nil?
|
|
5480
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
|
5481
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
|
5482
|
+
command.query['fields'] = fields unless fields.nil?
|
|
5483
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
5484
|
+
execute_or_queue_command(command, &block)
|
|
5485
|
+
end
|
|
5486
|
+
|
|
5487
|
+
# Updates an Engine
|
|
5488
|
+
# @param [String] name
|
|
5489
|
+
# Immutable. Identifier. The fully qualified resource name of the engine. This
|
|
5490
|
+
# field must be a UTF-8 encoded string with a length limit of 1024 characters.
|
|
5491
|
+
# Format: `projects/`project`/locations/`location`/collections/`collection`/
|
|
5492
|
+
# engines/`engine`` engine should be 1-63 characters, and valid characters are /
|
|
5493
|
+
# a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned.
|
|
5494
|
+
# @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaEngine] google_cloud_discoveryengine_v1alpha_engine_object
|
|
5495
|
+
# @param [String] update_mask
|
|
5496
|
+
# Indicates which fields in the provided Engine to update. If an unsupported or
|
|
5497
|
+
# unknown field is provided, an INVALID_ARGUMENT error is returned.
|
|
5498
|
+
# @param [String] fields
|
|
5499
|
+
# Selector specifying which fields to include in a partial response.
|
|
5500
|
+
# @param [String] quota_user
|
|
5501
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
5502
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
5503
|
+
# @param [Google::Apis::RequestOptions] options
|
|
5504
|
+
# Request-specific options
|
|
5505
|
+
#
|
|
5506
|
+
# @yield [result, err] Result & error if block supplied
|
|
5507
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaEngine] parsed result object
|
|
5508
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
5509
|
+
#
|
|
5510
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaEngine]
|
|
5511
|
+
#
|
|
5512
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
5513
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
5514
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
5515
|
+
def patch_project_location_collection_engine(name, google_cloud_discoveryengine_v1alpha_engine_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
5516
|
+
command = make_simple_command(:patch, 'v1alpha/{+name}', options)
|
|
5517
|
+
command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaEngine::Representation
|
|
5518
|
+
command.request_object = google_cloud_discoveryengine_v1alpha_engine_object
|
|
5519
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaEngine::Representation
|
|
5520
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaEngine
|
|
5521
|
+
command.params['name'] = name unless name.nil?
|
|
5522
|
+
command.query['updateMask'] = update_mask unless update_mask.nil?
|
|
5523
|
+
command.query['fields'] = fields unless fields.nil?
|
|
5524
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
5525
|
+
execute_or_queue_command(command, &block)
|
|
5526
|
+
end
|
|
5527
|
+
|
|
5528
|
+
# Pauses the training of an existing engine. Only applicable if SolutionType is
|
|
5529
|
+
# SOLUTION_TYPE_RECOMMENDATION.
|
|
5530
|
+
# @param [String] name
|
|
5531
|
+
# Required. The name of the engine to pause. Format: `projects/`project`/
|
|
5532
|
+
# locations/`location`/collections/`collection_id`/engines/`engine_id``
|
|
5533
|
+
# @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaPauseEngineRequest] google_cloud_discoveryengine_v1alpha_pause_engine_request_object
|
|
5534
|
+
# @param [String] fields
|
|
5535
|
+
# Selector specifying which fields to include in a partial response.
|
|
5536
|
+
# @param [String] quota_user
|
|
5537
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
5538
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
5539
|
+
# @param [Google::Apis::RequestOptions] options
|
|
5540
|
+
# Request-specific options
|
|
5541
|
+
#
|
|
5542
|
+
# @yield [result, err] Result & error if block supplied
|
|
5543
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaEngine] parsed result object
|
|
5544
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
5545
|
+
#
|
|
5546
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaEngine]
|
|
5547
|
+
#
|
|
5548
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
5549
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
5550
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
5551
|
+
def pause_project_location_collection_engine(name, google_cloud_discoveryengine_v1alpha_pause_engine_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
5552
|
+
command = make_simple_command(:post, 'v1alpha/{+name}:pause', options)
|
|
5553
|
+
command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaPauseEngineRequest::Representation
|
|
5554
|
+
command.request_object = google_cloud_discoveryengine_v1alpha_pause_engine_request_object
|
|
5555
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaEngine::Representation
|
|
5556
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaEngine
|
|
5557
|
+
command.params['name'] = name unless name.nil?
|
|
5558
|
+
command.query['fields'] = fields unless fields.nil?
|
|
5559
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
5560
|
+
execute_or_queue_command(command, &block)
|
|
5561
|
+
end
|
|
5562
|
+
|
|
5563
|
+
# Resumes the training of an existing engine. Only applicable if SolutionType is
|
|
5564
|
+
# SOLUTION_TYPE_RECOMMENDATION.
|
|
5565
|
+
# @param [String] name
|
|
5566
|
+
# Required. The name of the engine to resume. Format: `projects/`project`/
|
|
5567
|
+
# locations/`location`/collections/`collection_id`/engines/`engine_id``
|
|
5568
|
+
# @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaResumeEngineRequest] google_cloud_discoveryengine_v1alpha_resume_engine_request_object
|
|
5569
|
+
# @param [String] fields
|
|
5570
|
+
# Selector specifying which fields to include in a partial response.
|
|
5571
|
+
# @param [String] quota_user
|
|
5572
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
5573
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
5574
|
+
# @param [Google::Apis::RequestOptions] options
|
|
5575
|
+
# Request-specific options
|
|
5576
|
+
#
|
|
5577
|
+
# @yield [result, err] Result & error if block supplied
|
|
5578
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaEngine] parsed result object
|
|
5579
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
5580
|
+
#
|
|
5581
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaEngine]
|
|
5582
|
+
#
|
|
5583
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
5584
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
5585
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
5586
|
+
def resume_project_location_collection_engine(name, google_cloud_discoveryengine_v1alpha_resume_engine_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
5587
|
+
command = make_simple_command(:post, 'v1alpha/{+name}:resume', options)
|
|
5588
|
+
command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaResumeEngineRequest::Representation
|
|
5589
|
+
command.request_object = google_cloud_discoveryengine_v1alpha_resume_engine_request_object
|
|
5590
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaEngine::Representation
|
|
5591
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaEngine
|
|
5592
|
+
command.params['name'] = name unless name.nil?
|
|
5593
|
+
command.query['fields'] = fields unless fields.nil?
|
|
5594
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
5595
|
+
execute_or_queue_command(command, &block)
|
|
5596
|
+
end
|
|
5597
|
+
|
|
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
|
+
# Lists the data for displaying the Agents under an Assistant which are
|
|
5700
|
+
# available to the caller.
|
|
5701
|
+
# @param [String] parent
|
|
5702
|
+
# Required. The parent resource name. Format: `projects/`project`/locations/`
|
|
5703
|
+
# location`/collections/`collection`/engines/`engine`/assistants/`assistant``
|
|
5704
|
+
# @param [String] agent_origin
|
|
5705
|
+
# Optional. The origin of the Agent.
|
|
5706
|
+
# @param [String] filter
|
|
5707
|
+
# Optional. The filter syntax consists of an expression language for
|
|
5708
|
+
# constructing a predicate from one or more fields of the files being filtered.
|
|
5709
|
+
# Filter expression is case-sensitive. Allowed fields are: * `display_name` * `
|
|
5710
|
+
# state` Some examples of filters would be: * `display_name = 'agent_1'` * `
|
|
5711
|
+
# display_name = 'agent_1' AND state = ENABLED` For a full description of the
|
|
5712
|
+
# filter format, please see https://google.aip.dev/160.
|
|
5713
|
+
# @param [String] language_code
|
|
5714
|
+
# Optional. The UI language currently shown to the user. Specifying this field
|
|
5715
|
+
# request that the texts in the AgentViews in the response should be translated
|
|
5716
|
+
# to this language.
|
|
5717
|
+
# @param [Fixnum] max_suggested_prompts
|
|
5718
|
+
# Optional. The maximum number of suggested prompts to return per agent.
|
|
5719
|
+
# @param [Fixnum] page_size
|
|
5720
|
+
# Optional. Maximum number of AgentViewss to return. If unspecified, defaults to
|
|
5721
|
+
# 100. The maximum allowed value is 1000; anything above that will be coerced
|
|
5722
|
+
# down to 1000.
|
|
5723
|
+
# @param [String] page_token
|
|
5724
|
+
# Optional. A page token ListAvailableAgentViewsResponse.next_page_token,
|
|
5725
|
+
# received from a previous AgentService.ListAvailableAgentViews call. Provide
|
|
5726
|
+
# this to retrieve the subsequent page. When paginating, all other parameters
|
|
5727
|
+
# provided to ListAvailableAgentViews must match the call that provided the page
|
|
5728
|
+
# token.
|
|
5729
|
+
# @param [String] sort_by
|
|
5730
|
+
# Optional. The field to sort by. Can have the following values: - display-name:
|
|
5731
|
+
# The display name of the agent. - description: The description of the agent. -
|
|
5732
|
+
# create-time: The creation time of the agent. - state: The state of the agent.
|
|
5733
|
+
# @param [String] fields
|
|
5734
|
+
# Selector specifying which fields to include in a partial response.
|
|
5735
|
+
# @param [String] quota_user
|
|
5736
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
5737
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
5738
|
+
# @param [Google::Apis::RequestOptions] options
|
|
5739
|
+
# Request-specific options
|
|
5740
|
+
#
|
|
5741
|
+
# @yield [result, err] Result & error if block supplied
|
|
5742
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListAvailableAgentViewsResponse] parsed result object
|
|
5743
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
5744
|
+
#
|
|
5745
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListAvailableAgentViewsResponse]
|
|
5746
|
+
#
|
|
5747
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
5748
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
5749
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
5750
|
+
def list_project_location_collection_engine_assistant_available_agent_views(parent, agent_origin: nil, filter: nil, language_code: nil, max_suggested_prompts: nil, page_size: nil, page_token: nil, sort_by: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
5751
|
+
command = make_simple_command(:post, 'v1alpha/{+parent}:listAvailableAgentViews', options)
|
|
5752
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListAvailableAgentViewsResponse::Representation
|
|
5753
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListAvailableAgentViewsResponse
|
|
5754
|
+
command.params['parent'] = parent unless parent.nil?
|
|
5755
|
+
command.query['agentOrigin'] = agent_origin unless agent_origin.nil?
|
|
5756
|
+
command.query['filter'] = filter unless filter.nil?
|
|
5757
|
+
command.query['languageCode'] = language_code unless language_code.nil?
|
|
5758
|
+
command.query['maxSuggestedPrompts'] = max_suggested_prompts unless max_suggested_prompts.nil?
|
|
5759
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
|
5760
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
|
5761
|
+
command.query['sortBy'] = sort_by unless sort_by.nil?
|
|
5762
|
+
command.query['fields'] = fields unless fields.nil?
|
|
5763
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
5764
|
+
execute_or_queue_command(command, &block)
|
|
5765
|
+
end
|
|
5766
|
+
|
|
5767
|
+
# Updates an Assistant
|
|
5768
|
+
# @param [String] name
|
|
5769
|
+
# Immutable. Resource name of the assistant. Format: `projects/`project`/
|
|
5770
|
+
# locations/`location`/collections/`collection`/engines/`engine`/assistants/`
|
|
5771
|
+
# assistant`` It must be a UTF-8 encoded string with a length limit of 1024
|
|
5772
|
+
# characters.
|
|
5773
|
+
# @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAssistant] google_cloud_discoveryengine_v1alpha_assistant_object
|
|
5774
|
+
# @param [String] update_mask
|
|
5775
|
+
# The list of fields to update.
|
|
5776
|
+
# @param [String] fields
|
|
5777
|
+
# Selector specifying which fields to include in a partial response.
|
|
5778
|
+
# @param [String] quota_user
|
|
5779
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
5780
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
5781
|
+
# @param [Google::Apis::RequestOptions] options
|
|
5782
|
+
# Request-specific options
|
|
5783
|
+
#
|
|
5784
|
+
# @yield [result, err] Result & error if block supplied
|
|
5785
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAssistant] parsed result object
|
|
5786
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
5787
|
+
#
|
|
5788
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAssistant]
|
|
5789
|
+
#
|
|
5790
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
5791
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
5792
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
5793
|
+
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)
|
|
5794
|
+
command = make_simple_command(:patch, 'v1alpha/{+name}', options)
|
|
5795
|
+
command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAssistant::Representation
|
|
5796
|
+
command.request_object = google_cloud_discoveryengine_v1alpha_assistant_object
|
|
5797
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAssistant::Representation
|
|
5798
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAssistant
|
|
5799
|
+
command.params['name'] = name unless name.nil?
|
|
5800
|
+
command.query['updateMask'] = update_mask unless update_mask.nil?
|
|
5801
|
+
command.query['fields'] = fields unless fields.nil?
|
|
5802
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
5803
|
+
execute_or_queue_command(command, &block)
|
|
5804
|
+
end
|
|
5805
|
+
|
|
5806
|
+
# Assists the user with a query in a streaming fashion.
|
|
5807
|
+
# @param [String] name
|
|
5808
|
+
# Required. The resource name of the Assistant. Format: `projects/`project`/
|
|
5809
|
+
# locations/`location`/collections/`collection`/engines/`engine`/assistants/`
|
|
5810
|
+
# assistant``
|
|
5811
|
+
# @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaStreamAssistRequest] google_cloud_discoveryengine_v1alpha_stream_assist_request_object
|
|
5812
|
+
# @param [String] fields
|
|
5813
|
+
# Selector specifying which fields to include in a partial response.
|
|
5814
|
+
# @param [String] quota_user
|
|
5815
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
5816
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
5817
|
+
# @param [Google::Apis::RequestOptions] options
|
|
5818
|
+
# Request-specific options
|
|
5819
|
+
#
|
|
5820
|
+
# @yield [result, err] Result & error if block supplied
|
|
5821
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaStreamAssistResponse] parsed result object
|
|
5822
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
5823
|
+
#
|
|
5824
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaStreamAssistResponse]
|
|
5825
|
+
#
|
|
5826
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
5827
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
5828
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
5829
|
+
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)
|
|
5830
|
+
command = make_simple_command(:post, 'v1alpha/{+name}:streamAssist', options)
|
|
5831
|
+
command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaStreamAssistRequest::Representation
|
|
5832
|
+
command.request_object = google_cloud_discoveryengine_v1alpha_stream_assist_request_object
|
|
5833
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaStreamAssistResponse::Representation
|
|
5834
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaStreamAssistResponse
|
|
5835
|
+
command.params['name'] = name unless name.nil?
|
|
5836
|
+
command.query['fields'] = fields unless fields.nil?
|
|
5837
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
5838
|
+
execute_or_queue_command(command, &block)
|
|
5839
|
+
end
|
|
5840
|
+
|
|
5841
|
+
# Creates an Agent.
|
|
5842
|
+
# @param [String] parent
|
|
5843
|
+
# Required. The parent resource name. Format: `projects/`project`/locations/`
|
|
5844
|
+
# location`/collections/`collection`/engines/`engine`/assistants/`assistant``
|
|
5845
|
+
# @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAgent] google_cloud_discoveryengine_v1alpha_agent_object
|
|
5846
|
+
# @param [String] fields
|
|
5847
|
+
# Selector specifying which fields to include in a partial response.
|
|
5848
|
+
# @param [String] quota_user
|
|
5849
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
5850
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
5851
|
+
# @param [Google::Apis::RequestOptions] options
|
|
5852
|
+
# Request-specific options
|
|
5853
|
+
#
|
|
5854
|
+
# @yield [result, err] Result & error if block supplied
|
|
5855
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAgent] parsed result object
|
|
5856
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
5857
|
+
#
|
|
5858
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAgent]
|
|
5859
|
+
#
|
|
5860
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
5861
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
5862
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
5863
|
+
def create_project_location_collection_engine_assistant_agent(parent, google_cloud_discoveryengine_v1alpha_agent_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
5864
|
+
command = make_simple_command(:post, 'v1alpha/{+parent}/agents', options)
|
|
5865
|
+
command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAgent::Representation
|
|
5866
|
+
command.request_object = google_cloud_discoveryengine_v1alpha_agent_object
|
|
5867
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAgent::Representation
|
|
5868
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAgent
|
|
5869
|
+
command.params['parent'] = parent unless parent.nil?
|
|
5870
|
+
command.query['fields'] = fields unless fields.nil?
|
|
5871
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
5872
|
+
execute_or_queue_command(command, &block)
|
|
5873
|
+
end
|
|
5874
|
+
|
|
5875
|
+
# Deletes an Agent.
|
|
5876
|
+
# @param [String] name
|
|
5877
|
+
# Required. Resource name of Agent. Format: `projects/`project`/locations/`
|
|
5878
|
+
# location`/collections/`collection`/engines/`engine`/assistants/`assistant`/
|
|
5879
|
+
# agents/`agent`` If the caller does not have permission to delete the agent,
|
|
5880
|
+
# regardless of whether or not it exists, a `PERMISSION_DENIED` error is
|
|
5881
|
+
# returned. If the agent to delete does not exist, a `NOT_FOUND` error is
|
|
5882
|
+
# returned.
|
|
5883
|
+
# @param [String] fields
|
|
5884
|
+
# Selector specifying which fields to include in a partial response.
|
|
5885
|
+
# @param [String] quota_user
|
|
5886
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
5887
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
5888
|
+
# @param [Google::Apis::RequestOptions] options
|
|
5889
|
+
# Request-specific options
|
|
5890
|
+
#
|
|
5891
|
+
# @yield [result, err] Result & error if block supplied
|
|
5892
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation] parsed result object
|
|
5893
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
5894
|
+
#
|
|
5895
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation]
|
|
5896
|
+
#
|
|
5897
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
5898
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
5899
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
5900
|
+
def delete_project_location_collection_engine_assistant_agent(name, fields: nil, quota_user: nil, options: nil, &block)
|
|
5901
|
+
command = make_simple_command(:delete, 'v1alpha/{+name}', options)
|
|
5902
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation::Representation
|
|
5903
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation
|
|
5904
|
+
command.params['name'] = name unless name.nil?
|
|
5905
|
+
command.query['fields'] = fields unless fields.nil?
|
|
5906
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
5907
|
+
execute_or_queue_command(command, &block)
|
|
5908
|
+
end
|
|
5909
|
+
|
|
5910
|
+
# Disables an Agent. The `state` of the Agent becomes `DISABLED`. Can be called
|
|
5911
|
+
# on an Agent in the state `ENABLED` or`SUSPENDED`, otherwise it returns an
|
|
5912
|
+
# error.
|
|
5913
|
+
# @param [String] name
|
|
5914
|
+
# Required. The name of the Agent to disable. Format: `projects/`project`/
|
|
5915
|
+
# locations/`location`/collections/`collection`/engines/`engine`/assistants/`
|
|
5916
|
+
# assistant`/agents/`agent``
|
|
5917
|
+
# @param [String] fields
|
|
5918
|
+
# Selector specifying which fields to include in a partial response.
|
|
5919
|
+
# @param [String] quota_user
|
|
5920
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
5921
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
5922
|
+
# @param [Google::Apis::RequestOptions] options
|
|
5923
|
+
# Request-specific options
|
|
5924
|
+
#
|
|
5925
|
+
# @yield [result, err] Result & error if block supplied
|
|
5926
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAgent] parsed result object
|
|
5090
5927
|
# @yieldparam err [StandardError] error object if request failed
|
|
5091
5928
|
#
|
|
5092
|
-
# @return [Google::Apis::DiscoveryengineV1alpha::
|
|
5929
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAgent]
|
|
5093
5930
|
#
|
|
5094
5931
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
5095
5932
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
5096
5933
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
5097
|
-
def
|
|
5098
|
-
command = make_simple_command(:
|
|
5099
|
-
command.response_representation = Google::Apis::DiscoveryengineV1alpha::
|
|
5100
|
-
command.response_class = Google::Apis::DiscoveryengineV1alpha::
|
|
5934
|
+
def disable_project_location_collection_engine_assistant_agent_agent(name, fields: nil, quota_user: nil, options: nil, &block)
|
|
5935
|
+
command = make_simple_command(:post, 'v1alpha/{+name}:disableAgent', options)
|
|
5936
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAgent::Representation
|
|
5937
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAgent
|
|
5101
5938
|
command.params['name'] = name unless name.nil?
|
|
5102
5939
|
command.query['fields'] = fields unless fields.nil?
|
|
5103
5940
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
5104
5941
|
execute_or_queue_command(command, &block)
|
|
5105
5942
|
end
|
|
5106
5943
|
|
|
5107
|
-
#
|
|
5108
|
-
#
|
|
5109
|
-
#
|
|
5110
|
-
#
|
|
5111
|
-
#
|
|
5112
|
-
#
|
|
5113
|
-
# SOLUTION_TYPE_SEARCH
|
|
5114
|
-
# @param [Fixnum] page_size
|
|
5115
|
-
# Optional. Not supported.
|
|
5116
|
-
# @param [String] page_token
|
|
5117
|
-
# Optional. Not supported.
|
|
5944
|
+
# Enables an Agent. The `state` of the Agent becomes `ENABLED`. Can be called on
|
|
5945
|
+
# an Agent in the state `DISABLED` or 'SUSPENDED', otherwise it returns an error.
|
|
5946
|
+
# @param [String] name
|
|
5947
|
+
# Required. The name of the Agent to enable. Format: `projects/`project`/
|
|
5948
|
+
# locations/`location`/collections/`collection`/engines/`engine`/assistants/`
|
|
5949
|
+
# assistant`/agents/`agent``
|
|
5118
5950
|
# @param [String] fields
|
|
5119
5951
|
# Selector specifying which fields to include in a partial response.
|
|
5120
5952
|
# @param [String] quota_user
|
|
@@ -5124,38 +5956,29 @@ module Google
|
|
|
5124
5956
|
# Request-specific options
|
|
5125
5957
|
#
|
|
5126
5958
|
# @yield [result, err] Result & error if block supplied
|
|
5127
|
-
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::
|
|
5959
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAgent] parsed result object
|
|
5128
5960
|
# @yieldparam err [StandardError] error object if request failed
|
|
5129
5961
|
#
|
|
5130
|
-
# @return [Google::Apis::DiscoveryengineV1alpha::
|
|
5962
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAgent]
|
|
5131
5963
|
#
|
|
5132
5964
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
5133
5965
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
5134
5966
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
5135
|
-
def
|
|
5136
|
-
command = make_simple_command(:
|
|
5137
|
-
command.response_representation = Google::Apis::DiscoveryengineV1alpha::
|
|
5138
|
-
command.response_class = Google::Apis::DiscoveryengineV1alpha::
|
|
5139
|
-
command.params['
|
|
5140
|
-
command.query['filter'] = filter unless filter.nil?
|
|
5141
|
-
command.query['pageSize'] = page_size unless page_size.nil?
|
|
5142
|
-
command.query['pageToken'] = page_token unless page_token.nil?
|
|
5967
|
+
def enable_project_location_collection_engine_assistant_agent_agent(name, fields: nil, quota_user: nil, options: nil, &block)
|
|
5968
|
+
command = make_simple_command(:post, 'v1alpha/{+name}:enableAgent', options)
|
|
5969
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAgent::Representation
|
|
5970
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAgent
|
|
5971
|
+
command.params['name'] = name unless name.nil?
|
|
5143
5972
|
command.query['fields'] = fields unless fields.nil?
|
|
5144
5973
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
5145
5974
|
execute_or_queue_command(command, &block)
|
|
5146
5975
|
end
|
|
5147
5976
|
|
|
5148
|
-
#
|
|
5977
|
+
# Gets an Agent.
|
|
5149
5978
|
# @param [String] name
|
|
5150
|
-
#
|
|
5151
|
-
#
|
|
5152
|
-
#
|
|
5153
|
-
# engines/`engine`` engine should be 1-63 characters, and valid characters are /
|
|
5154
|
-
# a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned.
|
|
5155
|
-
# @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaEngine] google_cloud_discoveryengine_v1alpha_engine_object
|
|
5156
|
-
# @param [String] update_mask
|
|
5157
|
-
# Indicates which fields in the provided Engine to update. If an unsupported or
|
|
5158
|
-
# unknown field is provided, an INVALID_ARGUMENT error is returned.
|
|
5979
|
+
# Required. Resource name of Agent. Format: `projects/`project`/locations/`
|
|
5980
|
+
# location`/collections/`collection`/engines/`engine`/assistants/`assistant`/
|
|
5981
|
+
# agents/`agent``
|
|
5159
5982
|
# @param [String] fields
|
|
5160
5983
|
# Selector specifying which fields to include in a partial response.
|
|
5161
5984
|
# @param [String] quota_user
|
|
@@ -5165,33 +5988,36 @@ module Google
|
|
|
5165
5988
|
# Request-specific options
|
|
5166
5989
|
#
|
|
5167
5990
|
# @yield [result, err] Result & error if block supplied
|
|
5168
|
-
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::
|
|
5991
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAgent] parsed result object
|
|
5169
5992
|
# @yieldparam err [StandardError] error object if request failed
|
|
5170
5993
|
#
|
|
5171
|
-
# @return [Google::Apis::DiscoveryengineV1alpha::
|
|
5994
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAgent]
|
|
5172
5995
|
#
|
|
5173
5996
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
5174
5997
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
5175
5998
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
5176
|
-
def
|
|
5177
|
-
command = make_simple_command(:
|
|
5178
|
-
command.
|
|
5179
|
-
command.
|
|
5180
|
-
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaEngine::Representation
|
|
5181
|
-
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaEngine
|
|
5999
|
+
def get_project_location_collection_engine_assistant_agent(name, fields: nil, quota_user: nil, options: nil, &block)
|
|
6000
|
+
command = make_simple_command(:get, 'v1alpha/{+name}', options)
|
|
6001
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAgent::Representation
|
|
6002
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAgent
|
|
5182
6003
|
command.params['name'] = name unless name.nil?
|
|
5183
|
-
command.query['updateMask'] = update_mask unless update_mask.nil?
|
|
5184
6004
|
command.query['fields'] = fields unless fields.nil?
|
|
5185
6005
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
5186
6006
|
execute_or_queue_command(command, &block)
|
|
5187
6007
|
end
|
|
5188
6008
|
|
|
5189
|
-
#
|
|
5190
|
-
#
|
|
6009
|
+
# Returns a AgentView for a given Agent, which contains additional information
|
|
6010
|
+
# about the Agent.
|
|
5191
6011
|
# @param [String] name
|
|
5192
|
-
# Required. The name of the
|
|
5193
|
-
#
|
|
5194
|
-
#
|
|
6012
|
+
# Required. The name of the Agent to get. Format: `projects/`project`/locations/`
|
|
6013
|
+
# location`/collections/`collection`/engines/`engine`/assistants/`assistant`/
|
|
6014
|
+
# agents/`agent``
|
|
6015
|
+
# @param [String] language_code
|
|
6016
|
+
# Optional. The UI language currently shown to the user. Specifying this field
|
|
6017
|
+
# request that the texts in the AgentView in the response should be translated
|
|
6018
|
+
# to this language.
|
|
6019
|
+
# @param [Fixnum] max_suggested_prompts
|
|
6020
|
+
# Optional. The maximum number of suggested prompts to return per agent.
|
|
5195
6021
|
# @param [String] fields
|
|
5196
6022
|
# Selector specifying which fields to include in a partial response.
|
|
5197
6023
|
# @param [String] quota_user
|
|
@@ -5201,32 +6027,44 @@ module Google
|
|
|
5201
6027
|
# Request-specific options
|
|
5202
6028
|
#
|
|
5203
6029
|
# @yield [result, err] Result & error if block supplied
|
|
5204
|
-
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::
|
|
6030
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaGetAgentViewResponse] parsed result object
|
|
5205
6031
|
# @yieldparam err [StandardError] error object if request failed
|
|
5206
6032
|
#
|
|
5207
|
-
# @return [Google::Apis::DiscoveryengineV1alpha::
|
|
6033
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaGetAgentViewResponse]
|
|
5208
6034
|
#
|
|
5209
6035
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
5210
6036
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
5211
6037
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
5212
|
-
def
|
|
5213
|
-
command = make_simple_command(:
|
|
5214
|
-
command.
|
|
5215
|
-
command.
|
|
5216
|
-
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaEngine::Representation
|
|
5217
|
-
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaEngine
|
|
6038
|
+
def get_project_location_collection_engine_assistant_agent_agent_view(name, language_code: nil, max_suggested_prompts: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
6039
|
+
command = make_simple_command(:get, 'v1alpha/{+name}:getAgentView', options)
|
|
6040
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaGetAgentViewResponse::Representation
|
|
6041
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaGetAgentViewResponse
|
|
5218
6042
|
command.params['name'] = name unless name.nil?
|
|
6043
|
+
command.query['languageCode'] = language_code unless language_code.nil?
|
|
6044
|
+
command.query['maxSuggestedPrompts'] = max_suggested_prompts unless max_suggested_prompts.nil?
|
|
5219
6045
|
command.query['fields'] = fields unless fields.nil?
|
|
5220
6046
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
5221
6047
|
execute_or_queue_command(command, &block)
|
|
5222
6048
|
end
|
|
5223
6049
|
|
|
5224
|
-
#
|
|
5225
|
-
#
|
|
5226
|
-
#
|
|
5227
|
-
#
|
|
5228
|
-
#
|
|
5229
|
-
#
|
|
6050
|
+
# Gets the access control policy for an agent resource. A `NOT_FOUND` error is
|
|
6051
|
+
# returned if the resource does not exist. An empty policy is returned if the
|
|
6052
|
+
# resource exists but does not have a policy set on it.
|
|
6053
|
+
# @param [String] resource
|
|
6054
|
+
# REQUIRED: The resource for which the policy is being requested. See [Resource
|
|
6055
|
+
# names](https://cloud.google.com/apis/design/resource_names) for the
|
|
6056
|
+
# appropriate value for this field.
|
|
6057
|
+
# @param [Fixnum] options_requested_policy_version
|
|
6058
|
+
# Optional. The maximum policy version that will be used to format the policy.
|
|
6059
|
+
# Valid values are 0, 1, and 3. Requests specifying an invalid value will be
|
|
6060
|
+
# rejected. Requests for policies with any conditional role bindings must
|
|
6061
|
+
# specify version 3. Policies with no conditional role bindings may specify any
|
|
6062
|
+
# valid value or leave the field unset. The policy in the response might use the
|
|
6063
|
+
# policy version that you specified, or it might use a lower policy version. For
|
|
6064
|
+
# example, if you specify version 3, but the policy has no conditional role
|
|
6065
|
+
# bindings, the response uses version 1. To learn which resources support
|
|
6066
|
+
# conditions in their IAM policies, see the [IAM documentation](https://cloud.
|
|
6067
|
+
# google.com/iam/help/conditions/resource-policies).
|
|
5230
6068
|
# @param [String] fields
|
|
5231
6069
|
# Selector specifying which fields to include in a partial response.
|
|
5232
6070
|
# @param [String] quota_user
|
|
@@ -5236,32 +6074,43 @@ module Google
|
|
|
5236
6074
|
# Request-specific options
|
|
5237
6075
|
#
|
|
5238
6076
|
# @yield [result, err] Result & error if block supplied
|
|
5239
|
-
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::
|
|
6077
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleIamV1Policy] parsed result object
|
|
5240
6078
|
# @yieldparam err [StandardError] error object if request failed
|
|
5241
6079
|
#
|
|
5242
|
-
# @return [Google::Apis::DiscoveryengineV1alpha::
|
|
6080
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleIamV1Policy]
|
|
5243
6081
|
#
|
|
5244
6082
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
5245
6083
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
5246
6084
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
5247
|
-
def
|
|
5248
|
-
command = make_simple_command(:
|
|
5249
|
-
command.
|
|
5250
|
-
command.
|
|
5251
|
-
command.
|
|
5252
|
-
command.
|
|
5253
|
-
command.params['name'] = name unless name.nil?
|
|
6085
|
+
def get_project_location_collection_engine_assistant_agent_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
6086
|
+
command = make_simple_command(:get, 'v1alpha/{+resource}:getIamPolicy', options)
|
|
6087
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleIamV1Policy::Representation
|
|
6088
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleIamV1Policy
|
|
6089
|
+
command.params['resource'] = resource unless resource.nil?
|
|
6090
|
+
command.query['options.requestedPolicyVersion'] = options_requested_policy_version unless options_requested_policy_version.nil?
|
|
5254
6091
|
command.query['fields'] = fields unless fields.nil?
|
|
5255
6092
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
5256
6093
|
execute_or_queue_command(command, &block)
|
|
5257
6094
|
end
|
|
5258
6095
|
|
|
5259
|
-
#
|
|
5260
|
-
#
|
|
5261
|
-
#
|
|
5262
|
-
#
|
|
5263
|
-
#
|
|
5264
|
-
#
|
|
6096
|
+
# Lists all Agents under an Assistant which were created by the caller.
|
|
6097
|
+
# @param [String] parent
|
|
6098
|
+
# Required. The parent resource name. Format: `projects/`project`/locations/`
|
|
6099
|
+
# location`/collections/`collection`/engines/`engine`/assistants/`assistant``
|
|
6100
|
+
# @param [String] order_by
|
|
6101
|
+
# Optional. A comma-separated list of fields to order by, sorted in ascending
|
|
6102
|
+
# order. Use "desc" after a field name for descending. Supported fields: * `
|
|
6103
|
+
# update_time` * `is_pinned` Example: * "update_time desc" * "is_pinned desc,
|
|
6104
|
+
# update_time desc": list agents by is_pinned first, then by update_time.
|
|
6105
|
+
# @param [Fixnum] page_size
|
|
6106
|
+
# Optional. Maximum number of Agents to return. If unspecified, defaults to 100.
|
|
6107
|
+
# The maximum allowed value is 1000; anything above that will be coerced down to
|
|
6108
|
+
# 1000.
|
|
6109
|
+
# @param [String] page_token
|
|
6110
|
+
# Optional. A page token ListAgentsResponse.next_page_token, received from a
|
|
6111
|
+
# previous AgentService.ListAgents call. Provide this to retrieve the subsequent
|
|
6112
|
+
# page. When paginating, all other parameters provided to ListAgents must match
|
|
6113
|
+
# the call that provided the page token.
|
|
5265
6114
|
# @param [String] fields
|
|
5266
6115
|
# Selector specifying which fields to include in a partial response.
|
|
5267
6116
|
# @param [String] quota_user
|
|
@@ -5271,32 +6120,35 @@ module Google
|
|
|
5271
6120
|
# Request-specific options
|
|
5272
6121
|
#
|
|
5273
6122
|
# @yield [result, err] Result & error if block supplied
|
|
5274
|
-
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::
|
|
6123
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListAgentsResponse] parsed result object
|
|
5275
6124
|
# @yieldparam err [StandardError] error object if request failed
|
|
5276
6125
|
#
|
|
5277
|
-
# @return [Google::Apis::DiscoveryengineV1alpha::
|
|
6126
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListAgentsResponse]
|
|
5278
6127
|
#
|
|
5279
6128
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
5280
6129
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
5281
6130
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
5282
|
-
def
|
|
5283
|
-
command = make_simple_command(:
|
|
5284
|
-
command.
|
|
5285
|
-
command.
|
|
5286
|
-
command.
|
|
5287
|
-
command.
|
|
5288
|
-
command.
|
|
6131
|
+
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)
|
|
6132
|
+
command = make_simple_command(:get, 'v1alpha/{+parent}/agents', options)
|
|
6133
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListAgentsResponse::Representation
|
|
6134
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListAgentsResponse
|
|
6135
|
+
command.params['parent'] = parent unless parent.nil?
|
|
6136
|
+
command.query['orderBy'] = order_by unless order_by.nil?
|
|
6137
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
|
6138
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
|
5289
6139
|
command.query['fields'] = fields unless fields.nil?
|
|
5290
6140
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
5291
6141
|
execute_or_queue_command(command, &block)
|
|
5292
6142
|
end
|
|
5293
6143
|
|
|
5294
|
-
#
|
|
5295
|
-
# @param [String]
|
|
5296
|
-
#
|
|
5297
|
-
#
|
|
5298
|
-
#
|
|
5299
|
-
# @param [Google::Apis::DiscoveryengineV1alpha::
|
|
6144
|
+
# Updates an Agent
|
|
6145
|
+
# @param [String] name
|
|
6146
|
+
# Identifier. Resource name of the agent. Format: `projects/`project`/locations/`
|
|
6147
|
+
# location`/collections/`collection`/engines/`engine`/assistants/`assistant`/
|
|
6148
|
+
# agents/`agent``
|
|
6149
|
+
# @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAgent] google_cloud_discoveryengine_v1alpha_agent_object
|
|
6150
|
+
# @param [String] update_mask
|
|
6151
|
+
# Optional. The list of fields to update.
|
|
5300
6152
|
# @param [String] fields
|
|
5301
6153
|
# Selector specifying which fields to include in a partial response.
|
|
5302
6154
|
# @param [String] quota_user
|
|
@@ -5306,30 +6158,36 @@ module Google
|
|
|
5306
6158
|
# Request-specific options
|
|
5307
6159
|
#
|
|
5308
6160
|
# @yield [result, err] Result & error if block supplied
|
|
5309
|
-
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::
|
|
6161
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAgent] parsed result object
|
|
5310
6162
|
# @yieldparam err [StandardError] error object if request failed
|
|
5311
6163
|
#
|
|
5312
|
-
# @return [Google::Apis::DiscoveryengineV1alpha::
|
|
6164
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAgent]
|
|
5313
6165
|
#
|
|
5314
6166
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
5315
6167
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
5316
6168
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
5317
|
-
def
|
|
5318
|
-
command = make_simple_command(:
|
|
5319
|
-
command.request_representation = Google::Apis::DiscoveryengineV1alpha::
|
|
5320
|
-
command.request_object =
|
|
5321
|
-
command.response_representation = Google::Apis::DiscoveryengineV1alpha::
|
|
5322
|
-
command.response_class = Google::Apis::DiscoveryengineV1alpha::
|
|
5323
|
-
command.params['
|
|
6169
|
+
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)
|
|
6170
|
+
command = make_simple_command(:patch, 'v1alpha/{+name}', options)
|
|
6171
|
+
command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAgent::Representation
|
|
6172
|
+
command.request_object = google_cloud_discoveryengine_v1alpha_agent_object
|
|
6173
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAgent::Representation
|
|
6174
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAgent
|
|
6175
|
+
command.params['name'] = name unless name.nil?
|
|
6176
|
+
command.query['updateMask'] = update_mask unless update_mask.nil?
|
|
5324
6177
|
command.query['fields'] = fields unless fields.nil?
|
|
5325
6178
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
5326
6179
|
execute_or_queue_command(command, &block)
|
|
5327
6180
|
end
|
|
5328
6181
|
|
|
5329
|
-
#
|
|
5330
|
-
#
|
|
5331
|
-
#
|
|
5332
|
-
#
|
|
6182
|
+
# Sets the access control policy for an agent resource. A `NOT_FOUND` error is
|
|
6183
|
+
# returned if the resource does not exist. Policy can only contain `roles/
|
|
6184
|
+
# discoveryengine.agentUser`, `roles/discoveryengine.agentViewer` and `roles/
|
|
6185
|
+
# discoveryengine.agentEditor` roles.
|
|
6186
|
+
# @param [String] resource
|
|
6187
|
+
# REQUIRED: The resource for which the policy is being specified. See [Resource
|
|
6188
|
+
# names](https://cloud.google.com/apis/design/resource_names) for the
|
|
6189
|
+
# appropriate value for this field.
|
|
6190
|
+
# @param [Google::Apis::DiscoveryengineV1alpha::GoogleIamV1SetIamPolicyRequest] google_iam_v1_set_iam_policy_request_object
|
|
5333
6191
|
# @param [String] fields
|
|
5334
6192
|
# Selector specifying which fields to include in a partial response.
|
|
5335
6193
|
# @param [String] quota_user
|
|
@@ -5339,33 +6197,36 @@ module Google
|
|
|
5339
6197
|
# Request-specific options
|
|
5340
6198
|
#
|
|
5341
6199
|
# @yield [result, err] Result & error if block supplied
|
|
5342
|
-
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::
|
|
6200
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleIamV1Policy] parsed result object
|
|
5343
6201
|
# @yieldparam err [StandardError] error object if request failed
|
|
5344
6202
|
#
|
|
5345
|
-
# @return [Google::Apis::DiscoveryengineV1alpha::
|
|
6203
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleIamV1Policy]
|
|
5346
6204
|
#
|
|
5347
6205
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
5348
6206
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
5349
6207
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
5350
|
-
def
|
|
5351
|
-
command = make_simple_command(:
|
|
5352
|
-
command.
|
|
5353
|
-
command.
|
|
5354
|
-
command.
|
|
6208
|
+
def set_project_location_collection_engine_assistant_agent_iam_policy(resource, google_iam_v1_set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
6209
|
+
command = make_simple_command(:post, 'v1alpha/{+resource}:setIamPolicy', options)
|
|
6210
|
+
command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleIamV1SetIamPolicyRequest::Representation
|
|
6211
|
+
command.request_object = google_iam_v1_set_iam_policy_request_object
|
|
6212
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleIamV1Policy::Representation
|
|
6213
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleIamV1Policy
|
|
6214
|
+
command.params['resource'] = resource unless resource.nil?
|
|
5355
6215
|
command.query['fields'] = fields unless fields.nil?
|
|
5356
6216
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
5357
6217
|
execute_or_queue_command(command, &block)
|
|
5358
6218
|
end
|
|
5359
6219
|
|
|
5360
|
-
#
|
|
6220
|
+
# Suspends an Agent. It is still available for viewing but not for use. The `
|
|
6221
|
+
# state` of the Agent becomes `SUSPENDED`. Can be called on an Agent in the
|
|
6222
|
+
# state `ENABLED`, otherwise it returns an error.
|
|
5361
6223
|
# @param [String] name
|
|
5362
|
-
#
|
|
6224
|
+
# Required. The name of the Agent to suspend. Format: `projects/`project`/
|
|
5363
6225
|
# locations/`location`/collections/`collection`/engines/`engine`/assistants/`
|
|
5364
|
-
# assistant``
|
|
5365
|
-
#
|
|
5366
|
-
#
|
|
5367
|
-
#
|
|
5368
|
-
# The list of fields to update.
|
|
6226
|
+
# assistant`/agents/`agent``
|
|
6227
|
+
# @param [String] suspension_reason
|
|
6228
|
+
# Required. The reason for suspending the Agent. This will be shown to the users
|
|
6229
|
+
# of the Agent.
|
|
5369
6230
|
# @param [String] fields
|
|
5370
6231
|
# Selector specifying which fields to include in a partial response.
|
|
5371
6232
|
# @param [String] quota_user
|
|
@@ -5375,33 +6236,31 @@ module Google
|
|
|
5375
6236
|
# Request-specific options
|
|
5376
6237
|
#
|
|
5377
6238
|
# @yield [result, err] Result & error if block supplied
|
|
5378
|
-
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::
|
|
6239
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAgent] parsed result object
|
|
5379
6240
|
# @yieldparam err [StandardError] error object if request failed
|
|
5380
6241
|
#
|
|
5381
|
-
# @return [Google::Apis::DiscoveryengineV1alpha::
|
|
6242
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAgent]
|
|
5382
6243
|
#
|
|
5383
6244
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
5384
6245
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
5385
6246
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
5386
|
-
def
|
|
5387
|
-
command = make_simple_command(:
|
|
5388
|
-
command.
|
|
5389
|
-
command.
|
|
5390
|
-
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAssistant::Representation
|
|
5391
|
-
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAssistant
|
|
6247
|
+
def suspend_project_location_collection_engine_assistant_agent_agent(name, suspension_reason: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
6248
|
+
command = make_simple_command(:post, 'v1alpha/{+name}:suspendAgent', options)
|
|
6249
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAgent::Representation
|
|
6250
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAgent
|
|
5392
6251
|
command.params['name'] = name unless name.nil?
|
|
5393
|
-
command.query['
|
|
6252
|
+
command.query['suspensionReason'] = suspension_reason unless suspension_reason.nil?
|
|
5394
6253
|
command.query['fields'] = fields unless fields.nil?
|
|
5395
6254
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
5396
6255
|
execute_or_queue_command(command, &block)
|
|
5397
6256
|
end
|
|
5398
6257
|
|
|
5399
|
-
#
|
|
5400
|
-
# @param [String]
|
|
5401
|
-
# Required. The resource name of the
|
|
6258
|
+
# Imports a file to an Agent. Currently only No-Code agents are supported.
|
|
6259
|
+
# @param [String] parent
|
|
6260
|
+
# Required. The resource name of the Agent. Format: `projects/`project`/
|
|
5402
6261
|
# locations/`location`/collections/`collection`/engines/`engine`/assistants/`
|
|
5403
|
-
# assistant``
|
|
5404
|
-
# @param [Google::Apis::DiscoveryengineV1alpha::
|
|
6262
|
+
# assistant`/agents/`agent``
|
|
6263
|
+
# @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaImportAgentFileRequest] google_cloud_discoveryengine_v1alpha_import_agent_file_request_object
|
|
5405
6264
|
# @param [String] fields
|
|
5406
6265
|
# Selector specifying which fields to include in a partial response.
|
|
5407
6266
|
# @param [String] quota_user
|
|
@@ -5411,21 +6270,21 @@ module Google
|
|
|
5411
6270
|
# Request-specific options
|
|
5412
6271
|
#
|
|
5413
6272
|
# @yield [result, err] Result & error if block supplied
|
|
5414
|
-
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::
|
|
6273
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaImportAgentFileResponse] parsed result object
|
|
5415
6274
|
# @yieldparam err [StandardError] error object if request failed
|
|
5416
6275
|
#
|
|
5417
|
-
# @return [Google::Apis::DiscoveryengineV1alpha::
|
|
6276
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaImportAgentFileResponse]
|
|
5418
6277
|
#
|
|
5419
6278
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
5420
6279
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
5421
6280
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
5422
|
-
def
|
|
5423
|
-
command = make_simple_command(:post, 'v1alpha/{+
|
|
5424
|
-
command.request_representation = Google::Apis::DiscoveryengineV1alpha::
|
|
5425
|
-
command.request_object =
|
|
5426
|
-
command.response_representation = Google::Apis::DiscoveryengineV1alpha::
|
|
5427
|
-
command.response_class = Google::Apis::DiscoveryengineV1alpha::
|
|
5428
|
-
command.params['
|
|
6281
|
+
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)
|
|
6282
|
+
command = make_simple_command(:post, 'v1alpha/{+parent}/files:import', options)
|
|
6283
|
+
command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaImportAgentFileRequest::Representation
|
|
6284
|
+
command.request_object = google_cloud_discoveryengine_v1alpha_import_agent_file_request_object
|
|
6285
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaImportAgentFileResponse::Representation
|
|
6286
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaImportAgentFileResponse
|
|
6287
|
+
command.params['parent'] = parent unless parent.nil?
|
|
5429
6288
|
command.query['fields'] = fields unless fields.nil?
|
|
5430
6289
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
5431
6290
|
execute_or_queue_command(command, &block)
|
|
@@ -6854,6 +7713,47 @@ module Google
|
|
|
6854
7713
|
execute_or_queue_command(command, &block)
|
|
6855
7714
|
end
|
|
6856
7715
|
|
|
7716
|
+
# Update a WidgetConfig.
|
|
7717
|
+
# @param [String] name
|
|
7718
|
+
# Immutable. The full resource name of the widget config. Format: `projects/`
|
|
7719
|
+
# project`/locations/`location`/collections/`collection_id`/dataStores/`
|
|
7720
|
+
# data_store_id`/widgetConfigs/`widget_config_id``. This field must be a UTF-8
|
|
7721
|
+
# encoded string with a length limit of 1024 characters.
|
|
7722
|
+
# @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaWidgetConfig] google_cloud_discoveryengine_v1alpha_widget_config_object
|
|
7723
|
+
# @param [String] update_mask
|
|
7724
|
+
# Indicates which fields in the provided WidgetConfig to update. The following
|
|
7725
|
+
# are the only supported fields: * WidgetConfig.enable_autocomplete If not set,
|
|
7726
|
+
# all supported fields are updated.
|
|
7727
|
+
# @param [String] fields
|
|
7728
|
+
# Selector specifying which fields to include in a partial response.
|
|
7729
|
+
# @param [String] quota_user
|
|
7730
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
7731
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
7732
|
+
# @param [Google::Apis::RequestOptions] options
|
|
7733
|
+
# Request-specific options
|
|
7734
|
+
#
|
|
7735
|
+
# @yield [result, err] Result & error if block supplied
|
|
7736
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaWidgetConfig] parsed result object
|
|
7737
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
7738
|
+
#
|
|
7739
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaWidgetConfig]
|
|
7740
|
+
#
|
|
7741
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
7742
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
7743
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
7744
|
+
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)
|
|
7745
|
+
command = make_simple_command(:patch, 'v1alpha/{+name}', options)
|
|
7746
|
+
command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaWidgetConfig::Representation
|
|
7747
|
+
command.request_object = google_cloud_discoveryengine_v1alpha_widget_config_object
|
|
7748
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaWidgetConfig::Representation
|
|
7749
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaWidgetConfig
|
|
7750
|
+
command.params['name'] = name unless name.nil?
|
|
7751
|
+
command.query['updateMask'] = update_mask unless update_mask.nil?
|
|
7752
|
+
command.query['fields'] = fields unless fields.nil?
|
|
7753
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
7754
|
+
execute_or_queue_command(command, &block)
|
|
7755
|
+
end
|
|
7756
|
+
|
|
6857
7757
|
# Gets the latest state of a long-running operation. Clients can use this method
|
|
6858
7758
|
# to poll the operation result at intervals as recommended by the API service.
|
|
6859
7759
|
# @param [String] name
|
|
@@ -6957,9 +7857,9 @@ module Google
|
|
|
6957
7857
|
# values: * `document` is the default model for regular dataStores. * `search-
|
|
6958
7858
|
# history` is the default model for site search dataStores.
|
|
6959
7859
|
# @param [String] user_pseudo_id
|
|
6960
|
-
# A unique identifier for tracking visitors. For example, this could
|
|
6961
|
-
# implemented with an HTTP cookie, which should be able to uniquely identify
|
|
6962
|
-
# visitor on a single device. This unique identifier should not change if the
|
|
7860
|
+
# Optional. A unique identifier for tracking visitors. For example, this could
|
|
7861
|
+
# be implemented with an HTTP cookie, which should be able to uniquely identify
|
|
7862
|
+
# a visitor on a single device. This unique identifier should not change if the
|
|
6963
7863
|
# visitor logs in or out of the website. This field should NOT have a fixed
|
|
6964
7864
|
# value such as `unknown_visitor`. This should be the same identifier as
|
|
6965
7865
|
# UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a
|
|
@@ -10079,6 +10979,47 @@ module Google
|
|
|
10079
10979
|
execute_or_queue_command(command, &block)
|
|
10080
10980
|
end
|
|
10081
10981
|
|
|
10982
|
+
# Update a WidgetConfig.
|
|
10983
|
+
# @param [String] name
|
|
10984
|
+
# Immutable. The full resource name of the widget config. Format: `projects/`
|
|
10985
|
+
# project`/locations/`location`/collections/`collection_id`/dataStores/`
|
|
10986
|
+
# data_store_id`/widgetConfigs/`widget_config_id``. This field must be a UTF-8
|
|
10987
|
+
# encoded string with a length limit of 1024 characters.
|
|
10988
|
+
# @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaWidgetConfig] google_cloud_discoveryengine_v1alpha_widget_config_object
|
|
10989
|
+
# @param [String] update_mask
|
|
10990
|
+
# Indicates which fields in the provided WidgetConfig to update. The following
|
|
10991
|
+
# are the only supported fields: * WidgetConfig.enable_autocomplete If not set,
|
|
10992
|
+
# all supported fields are updated.
|
|
10993
|
+
# @param [String] fields
|
|
10994
|
+
# Selector specifying which fields to include in a partial response.
|
|
10995
|
+
# @param [String] quota_user
|
|
10996
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
10997
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
10998
|
+
# @param [Google::Apis::RequestOptions] options
|
|
10999
|
+
# Request-specific options
|
|
11000
|
+
#
|
|
11001
|
+
# @yield [result, err] Result & error if block supplied
|
|
11002
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaWidgetConfig] parsed result object
|
|
11003
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
11004
|
+
#
|
|
11005
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaWidgetConfig]
|
|
11006
|
+
#
|
|
11007
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
11008
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
11009
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
11010
|
+
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)
|
|
11011
|
+
command = make_simple_command(:patch, 'v1alpha/{+name}', options)
|
|
11012
|
+
command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaWidgetConfig::Representation
|
|
11013
|
+
command.request_object = google_cloud_discoveryengine_v1alpha_widget_config_object
|
|
11014
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaWidgetConfig::Representation
|
|
11015
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaWidgetConfig
|
|
11016
|
+
command.params['name'] = name unless name.nil?
|
|
11017
|
+
command.query['updateMask'] = update_mask unless update_mask.nil?
|
|
11018
|
+
command.query['fields'] = fields unless fields.nil?
|
|
11019
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
11020
|
+
execute_or_queue_command(command, &block)
|
|
11021
|
+
end
|
|
11022
|
+
|
|
10082
11023
|
# Creates a Evaluation. Upon creation, the evaluation will be automatically
|
|
10083
11024
|
# triggered and begin execution.
|
|
10084
11025
|
# @param [String] parent
|
|
@@ -12090,6 +13031,37 @@ module Google
|
|
|
12090
13031
|
execute_or_queue_command(command, &block)
|
|
12091
13032
|
end
|
|
12092
13033
|
|
|
13034
|
+
# Lists all the LicenseConfigUsageStatss associated with the project.
|
|
13035
|
+
# @param [String] parent
|
|
13036
|
+
# Required. The parent branch resource name, such as `projects/`project`/
|
|
13037
|
+
# locations/`location`/userStores/`user_store_id``.
|
|
13038
|
+
# @param [String] fields
|
|
13039
|
+
# Selector specifying which fields to include in a partial response.
|
|
13040
|
+
# @param [String] quota_user
|
|
13041
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
13042
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
13043
|
+
# @param [Google::Apis::RequestOptions] options
|
|
13044
|
+
# Request-specific options
|
|
13045
|
+
#
|
|
13046
|
+
# @yield [result, err] Result & error if block supplied
|
|
13047
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListLicenseConfigsUsageStatsResponse] parsed result object
|
|
13048
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
13049
|
+
#
|
|
13050
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListLicenseConfigsUsageStatsResponse]
|
|
13051
|
+
#
|
|
13052
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
13053
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
13054
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
13055
|
+
def list_project_location_user_store_license_configs_usage_stats(parent, fields: nil, quota_user: nil, options: nil, &block)
|
|
13056
|
+
command = make_simple_command(:get, 'v1alpha/{+parent}/licenseConfigsUsageStats', options)
|
|
13057
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListLicenseConfigsUsageStatsResponse::Representation
|
|
13058
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListLicenseConfigsUsageStatsResponse
|
|
13059
|
+
command.params['parent'] = parent unless parent.nil?
|
|
13060
|
+
command.query['fields'] = fields unless fields.nil?
|
|
13061
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
13062
|
+
execute_or_queue_command(command, &block)
|
|
13063
|
+
end
|
|
13064
|
+
|
|
12093
13065
|
# Gets the latest state of a long-running operation. Clients can use this method
|
|
12094
13066
|
# to poll the operation result at intervals as recommended by the API service.
|
|
12095
13067
|
# @param [String] name
|
|
@@ -12174,13 +13146,14 @@ module Google
|
|
|
12174
13146
|
# Required. The parent UserStore resource name, format: `projects/`project`/
|
|
12175
13147
|
# locations/`location`/userStores/`user_store_id``.
|
|
12176
13148
|
# @param [String] filter
|
|
12177
|
-
# Optional. Filter for the list request. Supported fields: * `
|
|
12178
|
-
#
|
|
12179
|
-
# list assigned user licenses. * `
|
|
12180
|
-
# not licensed users. * `
|
|
12181
|
-
# to list users who attempted
|
|
12182
|
-
#
|
|
12183
|
-
# who attempted login but no
|
|
13149
|
+
# Optional. Filter for the list request. Supported fields: * `license`_`
|
|
13150
|
+
# assignment`_`state` * `user_principal` * `user_profile` Examples: * `license`_`
|
|
13151
|
+
# assignment`_`state = ASSIGNED` to list assigned user licenses. * `license`_`
|
|
13152
|
+
# assignment`_`state = NO_LICENSE` to list not licensed users. * `license`_`
|
|
13153
|
+
# assignment`_`state = NO_LICENSE_ATTEMPTED_LOGIN` to list users who attempted
|
|
13154
|
+
# login but no license assigned. * `license`_`assignment`_`state !=
|
|
13155
|
+
# NO_LICENSE_ATTEMPTED_LOGIN` to filter out users who attempted login but no
|
|
13156
|
+
# license assigned.
|
|
12184
13157
|
# @param [Fixnum] page_size
|
|
12185
13158
|
# Optional. Requested page size. Server may return fewer items than requested.
|
|
12186
13159
|
# If unspecified, defaults to 10. The maximum value is 50; values above 50 will
|