google-apis-discoveryengine_v1 0.57.0 → 0.59.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.
@@ -51,51 +51,6 @@ module Google
51
51
  @batch_path = 'batch'
52
52
  end
53
53
 
54
- # Downloads a file from the session.
55
- # @param [String] name
56
- # Required. The resource name of the Session. Format: `projects/`project`/
57
- # locations/`location`/collections/`collection`/engines/`engine`/sessions/`
58
- # session``
59
- # @param [String] file_id
60
- # Required. The ID of the file to be downloaded.
61
- # @param [String] view_id
62
- # Optional. The ID of the view to be downloaded.
63
- # @param [String] fields
64
- # Selector specifying which fields to include in a partial response.
65
- # @param [String] quota_user
66
- # Available to use for quota purposes for server-side applications. Can be any
67
- # arbitrary string assigned to a user, but should not exceed 40 characters.
68
- # @param [IO, String] download_dest
69
- # IO stream or filename to receive content download
70
- # @param [Google::Apis::RequestOptions] options
71
- # Request-specific options
72
- #
73
- # @yield [result, err] Result & error if block supplied
74
- # @yieldparam result [Google::Apis::DiscoveryengineV1::GdataMedia] parsed result object
75
- # @yieldparam err [StandardError] error object if request failed
76
- #
77
- # @return [Google::Apis::DiscoveryengineV1::GdataMedia]
78
- #
79
- # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
80
- # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
81
- # @raise [Google::Apis::AuthorizationError] Authorization is required
82
- def download_medium(name, file_id: nil, view_id: nil, fields: nil, quota_user: nil, download_dest: nil, options: nil, &block)
83
- if download_dest.nil?
84
- command = make_simple_command(:get, 'v1/{+name}:downloadFile', options)
85
- else
86
- command = make_download_command(:get, 'v1/{+name}:downloadFile', options)
87
- command.download_dest = download_dest
88
- end
89
- command.response_representation = Google::Apis::DiscoveryengineV1::GdataMedia::Representation
90
- command.response_class = Google::Apis::DiscoveryengineV1::GdataMedia
91
- command.params['name'] = name unless name.nil?
92
- command.query['fileId'] = file_id unless file_id.nil?
93
- command.query['viewId'] = view_id unless view_id.nil?
94
- command.query['fields'] = fields unless fields.nil?
95
- command.query['quotaUser'] = quota_user unless quota_user.nil?
96
- execute_or_queue_command(command, &block)
97
- end
98
-
99
54
  # Provisions the project resource. During the process, related systems will get
100
55
  # prepared and initialized. Caller must read the [Terms for data use](https://
101
56
  # cloud.google.com/retail/data-use-terms), and optionally specify in request to
@@ -650,11 +605,12 @@ module Google
650
605
  # The standard list page token.
651
606
  # @param [Boolean] return_partial_success
652
607
  # When set to `true`, operations that are reachable are returned as normal, and
653
- # those that are unreachable are returned in the [ListOperationsResponse.
654
- # unreachable] field. This can only be `true` when reading across collections e.
655
- # g. when `parent` is set to `"projects/example/locations/-"`. This field is not
656
- # by default supported and will result in an `UNIMPLEMENTED` error if set unless
657
- # explicitly documented otherwise in service or product specific documentation.
608
+ # those that are unreachable are returned in the ListOperationsResponse.
609
+ # unreachable field. This can only be `true` when reading across collections.
610
+ # For example, when `parent` is set to `"projects/example/locations/-"`. This
611
+ # field is not supported by default and will result in an `UNIMPLEMENTED` error
612
+ # if set unless explicitly documented otherwise in service or product specific
613
+ # documentation.
658
614
  # @param [String] fields
659
615
  # Selector specifying which fields to include in a partial response.
660
616
  # @param [String] quota_user
@@ -1440,11 +1396,12 @@ module Google
1440
1396
  # The standard list page token.
1441
1397
  # @param [Boolean] return_partial_success
1442
1398
  # When set to `true`, operations that are reachable are returned as normal, and
1443
- # those that are unreachable are returned in the [ListOperationsResponse.
1444
- # unreachable] field. This can only be `true` when reading across collections e.
1445
- # g. when `parent` is set to `"projects/example/locations/-"`. This field is not
1446
- # by default supported and will result in an `UNIMPLEMENTED` error if set unless
1447
- # explicitly documented otherwise in service or product specific documentation.
1399
+ # those that are unreachable are returned in the ListOperationsResponse.
1400
+ # unreachable field. This can only be `true` when reading across collections.
1401
+ # For example, when `parent` is set to `"projects/example/locations/-"`. This
1402
+ # field is not supported by default and will result in an `UNIMPLEMENTED` error
1403
+ # if set unless explicitly documented otherwise in service or product specific
1404
+ # documentation.
1448
1405
  # @param [String] fields
1449
1406
  # Selector specifying which fields to include in a partial response.
1450
1407
  # @param [String] quota_user
@@ -2077,11 +2034,12 @@ module Google
2077
2034
  # The standard list page token.
2078
2035
  # @param [Boolean] return_partial_success
2079
2036
  # When set to `true`, operations that are reachable are returned as normal, and
2080
- # those that are unreachable are returned in the [ListOperationsResponse.
2081
- # unreachable] field. This can only be `true` when reading across collections e.
2082
- # g. when `parent` is set to `"projects/example/locations/-"`. This field is not
2083
- # by default supported and will result in an `UNIMPLEMENTED` error if set unless
2084
- # explicitly documented otherwise in service or product specific documentation.
2037
+ # those that are unreachable are returned in the ListOperationsResponse.
2038
+ # unreachable field. This can only be `true` when reading across collections.
2039
+ # For example, when `parent` is set to `"projects/example/locations/-"`. This
2040
+ # field is not supported by default and will result in an `UNIMPLEMENTED` error
2041
+ # if set unless explicitly documented otherwise in service or product specific
2042
+ # documentation.
2085
2043
  # @param [String] fields
2086
2044
  # Selector specifying which fields to include in a partial response.
2087
2045
  # @param [String] quota_user
@@ -2156,11 +2114,12 @@ module Google
2156
2114
  # The standard list page token.
2157
2115
  # @param [Boolean] return_partial_success
2158
2116
  # When set to `true`, operations that are reachable are returned as normal, and
2159
- # those that are unreachable are returned in the [ListOperationsResponse.
2160
- # unreachable] field. This can only be `true` when reading across collections e.
2161
- # g. when `parent` is set to `"projects/example/locations/-"`. This field is not
2162
- # by default supported and will result in an `UNIMPLEMENTED` error if set unless
2163
- # explicitly documented otherwise in service or product specific documentation.
2117
+ # those that are unreachable are returned in the ListOperationsResponse.
2118
+ # unreachable field. This can only be `true` when reading across collections.
2119
+ # For example, when `parent` is set to `"projects/example/locations/-"`. This
2120
+ # field is not supported by default and will result in an `UNIMPLEMENTED` error
2121
+ # if set unless explicitly documented otherwise in service or product specific
2122
+ # documentation.
2164
2123
  # @param [String] fields
2165
2124
  # Selector specifying which fields to include in a partial response.
2166
2125
  # @param [String] quota_user
@@ -2422,11 +2381,12 @@ module Google
2422
2381
  # The standard list page token.
2423
2382
  # @param [Boolean] return_partial_success
2424
2383
  # When set to `true`, operations that are reachable are returned as normal, and
2425
- # those that are unreachable are returned in the [ListOperationsResponse.
2426
- # unreachable] field. This can only be `true` when reading across collections e.
2427
- # g. when `parent` is set to `"projects/example/locations/-"`. This field is not
2428
- # by default supported and will result in an `UNIMPLEMENTED` error if set unless
2429
- # explicitly documented otherwise in service or product specific documentation.
2384
+ # those that are unreachable are returned in the ListOperationsResponse.
2385
+ # unreachable field. This can only be `true` when reading across collections.
2386
+ # For example, when `parent` is set to `"projects/example/locations/-"`. This
2387
+ # field is not supported by default and will result in an `UNIMPLEMENTED` error
2388
+ # if set unless explicitly documented otherwise in service or product specific
2389
+ # documentation.
2430
2390
  # @param [String] fields
2431
2391
  # Selector specifying which fields to include in a partial response.
2432
2392
  # @param [String] quota_user
@@ -3227,11 +3187,12 @@ module Google
3227
3187
  # The standard list page token.
3228
3188
  # @param [Boolean] return_partial_success
3229
3189
  # When set to `true`, operations that are reachable are returned as normal, and
3230
- # those that are unreachable are returned in the [ListOperationsResponse.
3231
- # unreachable] field. This can only be `true` when reading across collections e.
3232
- # g. when `parent` is set to `"projects/example/locations/-"`. This field is not
3233
- # by default supported and will result in an `UNIMPLEMENTED` error if set unless
3234
- # explicitly documented otherwise in service or product specific documentation.
3190
+ # those that are unreachable are returned in the ListOperationsResponse.
3191
+ # unreachable field. This can only be `true` when reading across collections.
3192
+ # For example, when `parent` is set to `"projects/example/locations/-"`. This
3193
+ # field is not supported by default and will result in an `UNIMPLEMENTED` error
3194
+ # if set unless explicitly documented otherwise in service or product specific
3195
+ # documentation.
3235
3196
  # @param [String] fields
3236
3197
  # Selector specifying which fields to include in a partial response.
3237
3198
  # @param [String] quota_user
@@ -3631,11 +3592,12 @@ module Google
3631
3592
  # The standard list page token.
3632
3593
  # @param [Boolean] return_partial_success
3633
3594
  # When set to `true`, operations that are reachable are returned as normal, and
3634
- # those that are unreachable are returned in the [ListOperationsResponse.
3635
- # unreachable] field. This can only be `true` when reading across collections e.
3636
- # g. when `parent` is set to `"projects/example/locations/-"`. This field is not
3637
- # by default supported and will result in an `UNIMPLEMENTED` error if set unless
3638
- # explicitly documented otherwise in service or product specific documentation.
3595
+ # those that are unreachable are returned in the ListOperationsResponse.
3596
+ # unreachable field. This can only be `true` when reading across collections.
3597
+ # For example, when `parent` is set to `"projects/example/locations/-"`. This
3598
+ # field is not supported by default and will result in an `UNIMPLEMENTED` error
3599
+ # if set unless explicitly documented otherwise in service or product specific
3600
+ # documentation.
3639
3601
  # @param [String] fields
3640
3602
  # Selector specifying which fields to include in a partial response.
3641
3603
  # @param [String] quota_user
@@ -3905,6 +3867,90 @@ module Google
3905
3867
  execute_or_queue_command(command, &block)
3906
3868
  end
3907
3869
 
3870
+ # Gets a WidgetConfig.
3871
+ # @param [String] name
3872
+ # Required. Full WidgetConfig resource name. Format: `projects/`project`/
3873
+ # locations/`location`/collections/`collection_id`/dataStores/`data_store_id`/
3874
+ # widgetConfigs/`widget_config_id``
3875
+ # @param [Boolean] accept_cache
3876
+ # Optional. Whether it's acceptable to load the widget config from cache. If set
3877
+ # to true, recent changes on widget configs may take a few minutes to reflect on
3878
+ # the end user's view. It's recommended to set to true for maturely developed
3879
+ # widgets, as it improves widget performance. Set to false to see changes
3880
+ # reflected in prod right away, if your widget is under development.
3881
+ # @param [Boolean] get_widget_config_request_option_turn_off_collection_components
3882
+ # Optional. Whether to turn off collection_components in WidgetConfig to reduce
3883
+ # latency and data transmission.
3884
+ # @param [String] fields
3885
+ # Selector specifying which fields to include in a partial response.
3886
+ # @param [String] quota_user
3887
+ # Available to use for quota purposes for server-side applications. Can be any
3888
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
3889
+ # @param [Google::Apis::RequestOptions] options
3890
+ # Request-specific options
3891
+ #
3892
+ # @yield [result, err] Result & error if block supplied
3893
+ # @yieldparam result [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1WidgetConfig] parsed result object
3894
+ # @yieldparam err [StandardError] error object if request failed
3895
+ #
3896
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1WidgetConfig]
3897
+ #
3898
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3899
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3900
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3901
+ def get_project_location_collection_data_store_widget_config(name, accept_cache: nil, get_widget_config_request_option_turn_off_collection_components: nil, fields: nil, quota_user: nil, options: nil, &block)
3902
+ command = make_simple_command(:get, 'v1/{+name}', options)
3903
+ command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1WidgetConfig::Representation
3904
+ command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1WidgetConfig
3905
+ command.params['name'] = name unless name.nil?
3906
+ command.query['acceptCache'] = accept_cache unless accept_cache.nil?
3907
+ command.query['getWidgetConfigRequestOption.turnOffCollectionComponents'] = get_widget_config_request_option_turn_off_collection_components unless get_widget_config_request_option_turn_off_collection_components.nil?
3908
+ command.query['fields'] = fields unless fields.nil?
3909
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3910
+ execute_or_queue_command(command, &block)
3911
+ end
3912
+
3913
+ # Update a WidgetConfig.
3914
+ # @param [String] name
3915
+ # Immutable. The full resource name of the widget config. Format: `projects/`
3916
+ # project`/locations/`location`/collections/`collection_id`/dataStores/`
3917
+ # data_store_id`/widgetConfigs/`widget_config_id``. This field must be a UTF-8
3918
+ # encoded string with a length limit of 1024 characters.
3919
+ # @param [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1WidgetConfig] google_cloud_discoveryengine_v1_widget_config_object
3920
+ # @param [String] update_mask
3921
+ # Indicates which fields in the provided WidgetConfig to update. The following
3922
+ # are the only supported fields: * WidgetConfig.enable_autocomplete If not set,
3923
+ # all supported fields are updated.
3924
+ # @param [String] fields
3925
+ # Selector specifying which fields to include in a partial response.
3926
+ # @param [String] quota_user
3927
+ # Available to use for quota purposes for server-side applications. Can be any
3928
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
3929
+ # @param [Google::Apis::RequestOptions] options
3930
+ # Request-specific options
3931
+ #
3932
+ # @yield [result, err] Result & error if block supplied
3933
+ # @yieldparam result [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1WidgetConfig] parsed result object
3934
+ # @yieldparam err [StandardError] error object if request failed
3935
+ #
3936
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1WidgetConfig]
3937
+ #
3938
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3939
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3940
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3941
+ def patch_project_location_collection_data_store_widget_config(name, google_cloud_discoveryengine_v1_widget_config_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
3942
+ command = make_simple_command(:patch, 'v1/{+name}', options)
3943
+ command.request_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1WidgetConfig::Representation
3944
+ command.request_object = google_cloud_discoveryengine_v1_widget_config_object
3945
+ command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1WidgetConfig::Representation
3946
+ command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1WidgetConfig
3947
+ command.params['name'] = name unless name.nil?
3948
+ command.query['updateMask'] = update_mask unless update_mask.nil?
3949
+ command.query['fields'] = fields unless fields.nil?
3950
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3951
+ execute_or_queue_command(command, &block)
3952
+ end
3953
+
3908
3954
  # Creates a Engine.
3909
3955
  # @param [String] parent
3910
3956
  # Required. The parent resource name, such as `projects/`project`/locations/`
@@ -4092,6 +4138,80 @@ module Google
4092
4138
  execute_or_queue_command(command, &block)
4093
4139
  end
4094
4140
 
4141
+ # Creates an Assistant.
4142
+ # @param [String] parent
4143
+ # Required. The parent resource name. Format: `projects/`project`/locations/`
4144
+ # location`/collections/`collection`/engines/`engine``
4145
+ # @param [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Assistant] google_cloud_discoveryengine_v1_assistant_object
4146
+ # @param [String] assistant_id
4147
+ # Required. The ID to use for the Assistant, which will become the final
4148
+ # component of the Assistant's resource name. This field must conform to [RFC-
4149
+ # 1034](https://tools.ietf.org/html/rfc1034) with a length limit of 63
4150
+ # characters.
4151
+ # @param [String] fields
4152
+ # Selector specifying which fields to include in a partial response.
4153
+ # @param [String] quota_user
4154
+ # Available to use for quota purposes for server-side applications. Can be any
4155
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
4156
+ # @param [Google::Apis::RequestOptions] options
4157
+ # Request-specific options
4158
+ #
4159
+ # @yield [result, err] Result & error if block supplied
4160
+ # @yieldparam result [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Assistant] parsed result object
4161
+ # @yieldparam err [StandardError] error object if request failed
4162
+ #
4163
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Assistant]
4164
+ #
4165
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
4166
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
4167
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
4168
+ def create_project_location_collection_engine_assistant(parent, google_cloud_discoveryengine_v1_assistant_object = nil, assistant_id: nil, fields: nil, quota_user: nil, options: nil, &block)
4169
+ command = make_simple_command(:post, 'v1/{+parent}/assistants', options)
4170
+ command.request_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Assistant::Representation
4171
+ command.request_object = google_cloud_discoveryengine_v1_assistant_object
4172
+ command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Assistant::Representation
4173
+ command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Assistant
4174
+ command.params['parent'] = parent unless parent.nil?
4175
+ command.query['assistantId'] = assistant_id unless assistant_id.nil?
4176
+ command.query['fields'] = fields unless fields.nil?
4177
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
4178
+ execute_or_queue_command(command, &block)
4179
+ end
4180
+
4181
+ # Deletes an Assistant.
4182
+ # @param [String] name
4183
+ # Required. Resource name of Assistant. Format: `projects/`project`/locations/`
4184
+ # location`/collections/`collection`/engines/`engine`/assistants/`assistant`` If
4185
+ # the caller does not have permission to delete the Assistant, regardless of
4186
+ # whether or not it exists, a PERMISSION_DENIED error is returned. If the
4187
+ # Assistant to delete does not exist, a NOT_FOUND error is returned.
4188
+ # @param [String] fields
4189
+ # Selector specifying which fields to include in a partial response.
4190
+ # @param [String] quota_user
4191
+ # Available to use for quota purposes for server-side applications. Can be any
4192
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
4193
+ # @param [Google::Apis::RequestOptions] options
4194
+ # Request-specific options
4195
+ #
4196
+ # @yield [result, err] Result & error if block supplied
4197
+ # @yieldparam result [Google::Apis::DiscoveryengineV1::GoogleProtobufEmpty] parsed result object
4198
+ # @yieldparam err [StandardError] error object if request failed
4199
+ #
4200
+ # @return [Google::Apis::DiscoveryengineV1::GoogleProtobufEmpty]
4201
+ #
4202
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
4203
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
4204
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
4205
+ def delete_project_location_collection_engine_assistant(name, fields: nil, quota_user: nil, options: nil, &block)
4206
+ command = make_simple_command(:delete, 'v1/{+name}', options)
4207
+ command.response_representation = Google::Apis::DiscoveryengineV1::GoogleProtobufEmpty::Representation
4208
+ command.response_class = Google::Apis::DiscoveryengineV1::GoogleProtobufEmpty
4209
+ command.params['name'] = name unless name.nil?
4210
+ command.query['fields'] = fields unless fields.nil?
4211
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
4212
+ execute_or_queue_command(command, &block)
4213
+ end
4214
+
4095
4215
  # Gets an Assistant.
4096
4216
  # @param [String] name
4097
4217
  # Required. Resource name of Assistant. Format: `projects/`project`/locations/`
@@ -4123,6 +4243,48 @@ module Google
4123
4243
  execute_or_queue_command(command, &block)
4124
4244
  end
4125
4245
 
4246
+ # Lists all Assistants under an Engine.
4247
+ # @param [String] parent
4248
+ # Required. The parent resource name. Format: `projects/`project`/locations/`
4249
+ # location`/collections/`collection`/engines/`engine``
4250
+ # @param [Fixnum] page_size
4251
+ # Maximum number of Assistants to return. If unspecified, defaults to 100. The
4252
+ # maximum allowed value is 1000; anything above that will be coerced down to
4253
+ # 1000.
4254
+ # @param [String] page_token
4255
+ # A page token ListAssistantsResponse.next_page_token, received from a previous
4256
+ # AssistantService.ListAssistants call. Provide this to retrieve the subsequent
4257
+ # page. When paginating, all other parameters provided to ListAssistants must
4258
+ # match the call that provided the page token.
4259
+ # @param [String] fields
4260
+ # Selector specifying which fields to include in a partial response.
4261
+ # @param [String] quota_user
4262
+ # Available to use for quota purposes for server-side applications. Can be any
4263
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
4264
+ # @param [Google::Apis::RequestOptions] options
4265
+ # Request-specific options
4266
+ #
4267
+ # @yield [result, err] Result & error if block supplied
4268
+ # @yieldparam result [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ListAssistantsResponse] parsed result object
4269
+ # @yieldparam err [StandardError] error object if request failed
4270
+ #
4271
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ListAssistantsResponse]
4272
+ #
4273
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
4274
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
4275
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
4276
+ def list_project_location_collection_engine_assistants(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
4277
+ command = make_simple_command(:get, 'v1/{+parent}/assistants', options)
4278
+ command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ListAssistantsResponse::Representation
4279
+ command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ListAssistantsResponse
4280
+ command.params['parent'] = parent unless parent.nil?
4281
+ command.query['pageSize'] = page_size unless page_size.nil?
4282
+ command.query['pageToken'] = page_token unless page_token.nil?
4283
+ command.query['fields'] = fields unless fields.nil?
4284
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
4285
+ execute_or_queue_command(command, &block)
4286
+ end
4287
+
4126
4288
  # Updates an Assistant
4127
4289
  # @param [String] name
4128
4290
  # Immutable. Resource name of the assistant. Format: `projects/`project`/
@@ -4197,6 +4359,37 @@ module Google
4197
4359
  execute_or_queue_command(command, &block)
4198
4360
  end
4199
4361
 
4362
+ # Gets the latest state of a long-running operation. Clients can use this method
4363
+ # to poll the operation result at intervals as recommended by the API service.
4364
+ # @param [String] name
4365
+ # The name of the operation resource.
4366
+ # @param [String] fields
4367
+ # Selector specifying which fields to include in a partial response.
4368
+ # @param [String] quota_user
4369
+ # Available to use for quota purposes for server-side applications. Can be any
4370
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
4371
+ # @param [Google::Apis::RequestOptions] options
4372
+ # Request-specific options
4373
+ #
4374
+ # @yield [result, err] Result & error if block supplied
4375
+ # @yieldparam result [Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation] parsed result object
4376
+ # @yieldparam err [StandardError] error object if request failed
4377
+ #
4378
+ # @return [Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation]
4379
+ #
4380
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
4381
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
4382
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
4383
+ def get_project_location_collection_engine_assistant_agent_operation(name, fields: nil, quota_user: nil, options: nil, &block)
4384
+ command = make_simple_command(:get, 'v1/{+name}', options)
4385
+ command.response_representation = Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation::Representation
4386
+ command.response_class = Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation
4387
+ command.params['name'] = name unless name.nil?
4388
+ command.query['fields'] = fields unless fields.nil?
4389
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
4390
+ execute_or_queue_command(command, &block)
4391
+ end
4392
+
4200
4393
  # Completes the user input with advanced keyword suggestions.
4201
4394
  # @param [String] completion_config
4202
4395
  # Required. The completion_config of the parent dataStore or engine resource
@@ -4737,11 +4930,12 @@ module Google
4737
4930
  # The standard list page token.
4738
4931
  # @param [Boolean] return_partial_success
4739
4932
  # When set to `true`, operations that are reachable are returned as normal, and
4740
- # those that are unreachable are returned in the [ListOperationsResponse.
4741
- # unreachable] field. This can only be `true` when reading across collections e.
4742
- # g. when `parent` is set to `"projects/example/locations/-"`. This field is not
4743
- # by default supported and will result in an `UNIMPLEMENTED` error if set unless
4744
- # explicitly documented otherwise in service or product specific documentation.
4933
+ # those that are unreachable are returned in the ListOperationsResponse.
4934
+ # unreachable field. This can only be `true` when reading across collections.
4935
+ # For example, when `parent` is set to `"projects/example/locations/-"`. This
4936
+ # field is not supported by default and will result in an `UNIMPLEMENTED` error
4937
+ # if set unless explicitly documented otherwise in service or product specific
4938
+ # documentation.
4745
4939
  # @param [String] fields
4746
4940
  # Selector specifying which fields to include in a partial response.
4747
4941
  # @param [String] quota_user
@@ -5316,6 +5510,90 @@ module Google
5316
5510
  execute_or_queue_command(command, &block)
5317
5511
  end
5318
5512
 
5513
+ # Gets a WidgetConfig.
5514
+ # @param [String] name
5515
+ # Required. Full WidgetConfig resource name. Format: `projects/`project`/
5516
+ # locations/`location`/collections/`collection_id`/dataStores/`data_store_id`/
5517
+ # widgetConfigs/`widget_config_id``
5518
+ # @param [Boolean] accept_cache
5519
+ # Optional. Whether it's acceptable to load the widget config from cache. If set
5520
+ # to true, recent changes on widget configs may take a few minutes to reflect on
5521
+ # the end user's view. It's recommended to set to true for maturely developed
5522
+ # widgets, as it improves widget performance. Set to false to see changes
5523
+ # reflected in prod right away, if your widget is under development.
5524
+ # @param [Boolean] get_widget_config_request_option_turn_off_collection_components
5525
+ # Optional. Whether to turn off collection_components in WidgetConfig to reduce
5526
+ # latency and data transmission.
5527
+ # @param [String] fields
5528
+ # Selector specifying which fields to include in a partial response.
5529
+ # @param [String] quota_user
5530
+ # Available to use for quota purposes for server-side applications. Can be any
5531
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
5532
+ # @param [Google::Apis::RequestOptions] options
5533
+ # Request-specific options
5534
+ #
5535
+ # @yield [result, err] Result & error if block supplied
5536
+ # @yieldparam result [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1WidgetConfig] parsed result object
5537
+ # @yieldparam err [StandardError] error object if request failed
5538
+ #
5539
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1WidgetConfig]
5540
+ #
5541
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
5542
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
5543
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
5544
+ def get_project_location_collection_engine_widget_config(name, accept_cache: nil, get_widget_config_request_option_turn_off_collection_components: nil, fields: nil, quota_user: nil, options: nil, &block)
5545
+ command = make_simple_command(:get, 'v1/{+name}', options)
5546
+ command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1WidgetConfig::Representation
5547
+ command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1WidgetConfig
5548
+ command.params['name'] = name unless name.nil?
5549
+ command.query['acceptCache'] = accept_cache unless accept_cache.nil?
5550
+ command.query['getWidgetConfigRequestOption.turnOffCollectionComponents'] = get_widget_config_request_option_turn_off_collection_components unless get_widget_config_request_option_turn_off_collection_components.nil?
5551
+ command.query['fields'] = fields unless fields.nil?
5552
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
5553
+ execute_or_queue_command(command, &block)
5554
+ end
5555
+
5556
+ # Update a WidgetConfig.
5557
+ # @param [String] name
5558
+ # Immutable. The full resource name of the widget config. Format: `projects/`
5559
+ # project`/locations/`location`/collections/`collection_id`/dataStores/`
5560
+ # data_store_id`/widgetConfigs/`widget_config_id``. This field must be a UTF-8
5561
+ # encoded string with a length limit of 1024 characters.
5562
+ # @param [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1WidgetConfig] google_cloud_discoveryengine_v1_widget_config_object
5563
+ # @param [String] update_mask
5564
+ # Indicates which fields in the provided WidgetConfig to update. The following
5565
+ # are the only supported fields: * WidgetConfig.enable_autocomplete If not set,
5566
+ # all supported fields are updated.
5567
+ # @param [String] fields
5568
+ # Selector specifying which fields to include in a partial response.
5569
+ # @param [String] quota_user
5570
+ # Available to use for quota purposes for server-side applications. Can be any
5571
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
5572
+ # @param [Google::Apis::RequestOptions] options
5573
+ # Request-specific options
5574
+ #
5575
+ # @yield [result, err] Result & error if block supplied
5576
+ # @yieldparam result [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1WidgetConfig] parsed result object
5577
+ # @yieldparam err [StandardError] error object if request failed
5578
+ #
5579
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1WidgetConfig]
5580
+ #
5581
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
5582
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
5583
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
5584
+ def patch_project_location_collection_engine_widget_config(name, google_cloud_discoveryengine_v1_widget_config_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
5585
+ command = make_simple_command(:patch, 'v1/{+name}', options)
5586
+ command.request_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1WidgetConfig::Representation
5587
+ command.request_object = google_cloud_discoveryengine_v1_widget_config_object
5588
+ command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1WidgetConfig::Representation
5589
+ command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1WidgetConfig
5590
+ command.params['name'] = name unless name.nil?
5591
+ command.query['updateMask'] = update_mask unless update_mask.nil?
5592
+ command.query['fields'] = fields unless fields.nil?
5593
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
5594
+ execute_or_queue_command(command, &block)
5595
+ end
5596
+
5319
5597
  # Gets the latest state of a long-running operation. Clients can use this method
5320
5598
  # to poll the operation result at intervals as recommended by the API service.
5321
5599
  # @param [String] name
@@ -5359,11 +5637,12 @@ module Google
5359
5637
  # The standard list page token.
5360
5638
  # @param [Boolean] return_partial_success
5361
5639
  # When set to `true`, operations that are reachable are returned as normal, and
5362
- # those that are unreachable are returned in the [ListOperationsResponse.
5363
- # unreachable] field. This can only be `true` when reading across collections e.
5364
- # g. when `parent` is set to `"projects/example/locations/-"`. This field is not
5365
- # by default supported and will result in an `UNIMPLEMENTED` error if set unless
5366
- # explicitly documented otherwise in service or product specific documentation.
5640
+ # those that are unreachable are returned in the ListOperationsResponse.
5641
+ # unreachable field. This can only be `true` when reading across collections.
5642
+ # For example, when `parent` is set to `"projects/example/locations/-"`. This
5643
+ # field is not supported by default and will result in an `UNIMPLEMENTED` error
5644
+ # if set unless explicitly documented otherwise in service or product specific
5645
+ # documentation.
5367
5646
  # @param [String] fields
5368
5647
  # Selector specifying which fields to include in a partial response.
5369
5648
  # @param [String] quota_user
@@ -6114,11 +6393,12 @@ module Google
6114
6393
  # The standard list page token.
6115
6394
  # @param [Boolean] return_partial_success
6116
6395
  # When set to `true`, operations that are reachable are returned as normal, and
6117
- # those that are unreachable are returned in the [ListOperationsResponse.
6118
- # unreachable] field. This can only be `true` when reading across collections e.
6119
- # g. when `parent` is set to `"projects/example/locations/-"`. This field is not
6120
- # by default supported and will result in an `UNIMPLEMENTED` error if set unless
6121
- # explicitly documented otherwise in service or product specific documentation.
6396
+ # those that are unreachable are returned in the ListOperationsResponse.
6397
+ # unreachable field. This can only be `true` when reading across collections.
6398
+ # For example, when `parent` is set to `"projects/example/locations/-"`. This
6399
+ # field is not supported by default and will result in an `UNIMPLEMENTED` error
6400
+ # if set unless explicitly documented otherwise in service or product specific
6401
+ # documentation.
6122
6402
  # @param [String] fields
6123
6403
  # Selector specifying which fields to include in a partial response.
6124
6404
  # @param [String] quota_user
@@ -6719,11 +6999,12 @@ module Google
6719
6999
  # The standard list page token.
6720
7000
  # @param [Boolean] return_partial_success
6721
7001
  # When set to `true`, operations that are reachable are returned as normal, and
6722
- # those that are unreachable are returned in the [ListOperationsResponse.
6723
- # unreachable] field. This can only be `true` when reading across collections e.
6724
- # g. when `parent` is set to `"projects/example/locations/-"`. This field is not
6725
- # by default supported and will result in an `UNIMPLEMENTED` error if set unless
6726
- # explicitly documented otherwise in service or product specific documentation.
7002
+ # those that are unreachable are returned in the ListOperationsResponse.
7003
+ # unreachable field. This can only be `true` when reading across collections.
7004
+ # For example, when `parent` is set to `"projects/example/locations/-"`. This
7005
+ # field is not supported by default and will result in an `UNIMPLEMENTED` error
7006
+ # if set unless explicitly documented otherwise in service or product specific
7007
+ # documentation.
6727
7008
  # @param [String] fields
6728
7009
  # Selector specifying which fields to include in a partial response.
6729
7010
  # @param [String] quota_user
@@ -6798,11 +7079,12 @@ module Google
6798
7079
  # The standard list page token.
6799
7080
  # @param [Boolean] return_partial_success
6800
7081
  # When set to `true`, operations that are reachable are returned as normal, and
6801
- # those that are unreachable are returned in the [ListOperationsResponse.
6802
- # unreachable] field. This can only be `true` when reading across collections e.
6803
- # g. when `parent` is set to `"projects/example/locations/-"`. This field is not
6804
- # by default supported and will result in an `UNIMPLEMENTED` error if set unless
6805
- # explicitly documented otherwise in service or product specific documentation.
7082
+ # those that are unreachable are returned in the ListOperationsResponse.
7083
+ # unreachable field. This can only be `true` when reading across collections.
7084
+ # For example, when `parent` is set to `"projects/example/locations/-"`. This
7085
+ # field is not supported by default and will result in an `UNIMPLEMENTED` error
7086
+ # if set unless explicitly documented otherwise in service or product specific
7087
+ # documentation.
6806
7088
  # @param [String] fields
6807
7089
  # Selector specifying which fields to include in a partial response.
6808
7090
  # @param [String] quota_user
@@ -8229,6 +8511,90 @@ module Google
8229
8511
  execute_or_queue_command(command, &block)
8230
8512
  end
8231
8513
 
8514
+ # Gets a WidgetConfig.
8515
+ # @param [String] name
8516
+ # Required. Full WidgetConfig resource name. Format: `projects/`project`/
8517
+ # locations/`location`/collections/`collection_id`/dataStores/`data_store_id`/
8518
+ # widgetConfigs/`widget_config_id``
8519
+ # @param [Boolean] accept_cache
8520
+ # Optional. Whether it's acceptable to load the widget config from cache. If set
8521
+ # to true, recent changes on widget configs may take a few minutes to reflect on
8522
+ # the end user's view. It's recommended to set to true for maturely developed
8523
+ # widgets, as it improves widget performance. Set to false to see changes
8524
+ # reflected in prod right away, if your widget is under development.
8525
+ # @param [Boolean] get_widget_config_request_option_turn_off_collection_components
8526
+ # Optional. Whether to turn off collection_components in WidgetConfig to reduce
8527
+ # latency and data transmission.
8528
+ # @param [String] fields
8529
+ # Selector specifying which fields to include in a partial response.
8530
+ # @param [String] quota_user
8531
+ # Available to use for quota purposes for server-side applications. Can be any
8532
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
8533
+ # @param [Google::Apis::RequestOptions] options
8534
+ # Request-specific options
8535
+ #
8536
+ # @yield [result, err] Result & error if block supplied
8537
+ # @yieldparam result [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1WidgetConfig] parsed result object
8538
+ # @yieldparam err [StandardError] error object if request failed
8539
+ #
8540
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1WidgetConfig]
8541
+ #
8542
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
8543
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
8544
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
8545
+ def get_project_location_data_store_widget_config(name, accept_cache: nil, get_widget_config_request_option_turn_off_collection_components: nil, fields: nil, quota_user: nil, options: nil, &block)
8546
+ command = make_simple_command(:get, 'v1/{+name}', options)
8547
+ command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1WidgetConfig::Representation
8548
+ command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1WidgetConfig
8549
+ command.params['name'] = name unless name.nil?
8550
+ command.query['acceptCache'] = accept_cache unless accept_cache.nil?
8551
+ command.query['getWidgetConfigRequestOption.turnOffCollectionComponents'] = get_widget_config_request_option_turn_off_collection_components unless get_widget_config_request_option_turn_off_collection_components.nil?
8552
+ command.query['fields'] = fields unless fields.nil?
8553
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
8554
+ execute_or_queue_command(command, &block)
8555
+ end
8556
+
8557
+ # Update a WidgetConfig.
8558
+ # @param [String] name
8559
+ # Immutable. The full resource name of the widget config. Format: `projects/`
8560
+ # project`/locations/`location`/collections/`collection_id`/dataStores/`
8561
+ # data_store_id`/widgetConfigs/`widget_config_id``. This field must be a UTF-8
8562
+ # encoded string with a length limit of 1024 characters.
8563
+ # @param [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1WidgetConfig] google_cloud_discoveryengine_v1_widget_config_object
8564
+ # @param [String] update_mask
8565
+ # Indicates which fields in the provided WidgetConfig to update. The following
8566
+ # are the only supported fields: * WidgetConfig.enable_autocomplete If not set,
8567
+ # all supported fields are updated.
8568
+ # @param [String] fields
8569
+ # Selector specifying which fields to include in a partial response.
8570
+ # @param [String] quota_user
8571
+ # Available to use for quota purposes for server-side applications. Can be any
8572
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
8573
+ # @param [Google::Apis::RequestOptions] options
8574
+ # Request-specific options
8575
+ #
8576
+ # @yield [result, err] Result & error if block supplied
8577
+ # @yieldparam result [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1WidgetConfig] parsed result object
8578
+ # @yieldparam err [StandardError] error object if request failed
8579
+ #
8580
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1WidgetConfig]
8581
+ #
8582
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
8583
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
8584
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
8585
+ def patch_project_location_data_store_widget_config(name, google_cloud_discoveryengine_v1_widget_config_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
8586
+ command = make_simple_command(:patch, 'v1/{+name}', options)
8587
+ command.request_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1WidgetConfig::Representation
8588
+ command.request_object = google_cloud_discoveryengine_v1_widget_config_object
8589
+ command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1WidgetConfig::Representation
8590
+ command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1WidgetConfig
8591
+ command.params['name'] = name unless name.nil?
8592
+ command.query['updateMask'] = update_mask unless update_mask.nil?
8593
+ command.query['fields'] = fields unless fields.nil?
8594
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
8595
+ execute_or_queue_command(command, &block)
8596
+ end
8597
+
8232
8598
  # Performs a grounding check.
8233
8599
  # @param [String] grounding_config
8234
8600
  # Required. The resource name of the grounding config, such as `projects/*/
@@ -8572,11 +8938,12 @@ module Google
8572
8938
  # The standard list page token.
8573
8939
  # @param [Boolean] return_partial_success
8574
8940
  # When set to `true`, operations that are reachable are returned as normal, and
8575
- # those that are unreachable are returned in the [ListOperationsResponse.
8576
- # unreachable] field. This can only be `true` when reading across collections e.
8577
- # g. when `parent` is set to `"projects/example/locations/-"`. This field is not
8578
- # by default supported and will result in an `UNIMPLEMENTED` error if set unless
8579
- # explicitly documented otherwise in service or product specific documentation.
8941
+ # those that are unreachable are returned in the ListOperationsResponse.
8942
+ # unreachable field. This can only be `true` when reading across collections.
8943
+ # For example, when `parent` is set to `"projects/example/locations/-"`. This
8944
+ # field is not supported by default and will result in an `UNIMPLEMENTED` error
8945
+ # if set unless explicitly documented otherwise in service or product specific
8946
+ # documentation.
8580
8947
  # @param [String] fields
8581
8948
  # Selector specifying which fields to include in a partial response.
8582
8949
  # @param [String] quota_user
@@ -8765,11 +9132,12 @@ module Google
8765
9132
  # The standard list page token.
8766
9133
  # @param [Boolean] return_partial_success
8767
9134
  # When set to `true`, operations that are reachable are returned as normal, and
8768
- # those that are unreachable are returned in the [ListOperationsResponse.
8769
- # unreachable] field. This can only be `true` when reading across collections e.
8770
- # g. when `parent` is set to `"projects/example/locations/-"`. This field is not
8771
- # by default supported and will result in an `UNIMPLEMENTED` error if set unless
8772
- # explicitly documented otherwise in service or product specific documentation.
9135
+ # those that are unreachable are returned in the ListOperationsResponse.
9136
+ # unreachable field. This can only be `true` when reading across collections.
9137
+ # For example, when `parent` is set to `"projects/example/locations/-"`. This
9138
+ # field is not supported by default and will result in an `UNIMPLEMENTED` error
9139
+ # if set unless explicitly documented otherwise in service or product specific
9140
+ # documentation.
8773
9141
  # @param [String] fields
8774
9142
  # Selector specifying which fields to include in a partial response.
8775
9143
  # @param [String] quota_user
@@ -9172,18 +9540,55 @@ module Google
9172
9540
  execute_or_queue_command(command, &block)
9173
9541
  end
9174
9542
 
9543
+ # Lists all the LicenseConfigUsageStatss associated with the project.
9544
+ # @param [String] parent
9545
+ # Required. The parent branch resource name, such as `projects/`project`/
9546
+ # locations/`location`/userStores/`user_store_id``.
9547
+ # @param [String] fields
9548
+ # Selector specifying which fields to include in a partial response.
9549
+ # @param [String] quota_user
9550
+ # Available to use for quota purposes for server-side applications. Can be any
9551
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
9552
+ # @param [Google::Apis::RequestOptions] options
9553
+ # Request-specific options
9554
+ #
9555
+ # @yield [result, err] Result & error if block supplied
9556
+ # @yieldparam result [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ListLicenseConfigsUsageStatsResponse] parsed result object
9557
+ # @yieldparam err [StandardError] error object if request failed
9558
+ #
9559
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ListLicenseConfigsUsageStatsResponse]
9560
+ #
9561
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
9562
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
9563
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
9564
+ def list_project_location_user_store_license_configs_usage_stats(parent, fields: nil, quota_user: nil, options: nil, &block)
9565
+ command = make_simple_command(:get, 'v1/{+parent}/licenseConfigsUsageStats', options)
9566
+ command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ListLicenseConfigsUsageStatsResponse::Representation
9567
+ command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ListLicenseConfigsUsageStatsResponse
9568
+ command.params['parent'] = parent unless parent.nil?
9569
+ command.query['fields'] = fields unless fields.nil?
9570
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
9571
+ execute_or_queue_command(command, &block)
9572
+ end
9573
+
9175
9574
  # Lists the User Licenses.
9176
9575
  # @param [String] parent
9177
9576
  # Required. The parent UserStore resource name, format: `projects/`project`/
9178
9577
  # locations/`location`/userStores/`user_store_id``.
9179
- # @param [String] filter
9180
- # Optional. Filter for the list request. Supported fields: * `
9181
- # license_assignment_state` Examples: * `license_assignment_state = ASSIGNED` to
9182
- # list assigned user licenses. * `license_assignment_state = NO_LICENSE` to list
9183
- # not licensed users. * `license_assignment_state = NO_LICENSE_ATTEMPTED_LOGIN`
9184
- # to list users who attempted login but no license assigned. * `
9185
- # license_assignment_state != NO_LICENSE_ATTEMPTED_LOGIN` to filter out users
9186
- # who attempted login but no license assigned.
9578
+ # @param [String] order_by
9579
+ # Optional. The order in which the UserLicenses are listed. The value must be a
9580
+ # comma-separated list of fields. Default sorting order is ascending. To specify
9581
+ # descending order for a field, append a " desc" suffix. Redundant space
9582
+ # characters in the syntax are insignificant. Supported fields: * `
9583
+ # license_assignment_state` * `user_principal` * `user_profile` * `
9584
+ # last_login_date` * `update_time` If not set, the default ordering is by `
9585
+ # user_principal`. Examples: * `user_principal desc` to order by `user_principal`
9586
+ # in descending order. * `license_assignment_state` to order by `
9587
+ # license_assignment_state` in ascending order. * `last_login_date desc` to
9588
+ # order by `last_login_date` in descending order. * `update_time desc` to order
9589
+ # by `update_time` in descending order. * `last_login_date desc, user_principal`
9590
+ # to order by `last_login_date` in descending order and then by `user_principal`
9591
+ # in ascending order.
9187
9592
  # @param [Fixnum] page_size
9188
9593
  # Optional. Requested page size. Server may return fewer items than requested.
9189
9594
  # If unspecified, defaults to 10. The maximum value is 50; values above 50 will
@@ -9211,12 +9616,12 @@ module Google
9211
9616
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
9212
9617
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
9213
9618
  # @raise [Google::Apis::AuthorizationError] Authorization is required
9214
- def list_project_location_user_store_user_licenses(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
9619
+ def list_project_location_user_store_user_licenses(parent, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
9215
9620
  command = make_simple_command(:get, 'v1/{+parent}/userLicenses', options)
9216
9621
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ListUserLicensesResponse::Representation
9217
9622
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ListUserLicensesResponse
9218
9623
  command.params['parent'] = parent unless parent.nil?
9219
- command.query['filter'] = filter unless filter.nil?
9624
+ command.query['orderBy'] = order_by unless order_by.nil?
9220
9625
  command.query['pageSize'] = page_size unless page_size.nil?
9221
9626
  command.query['pageToken'] = page_token unless page_token.nil?
9222
9627
  command.query['fields'] = fields unless fields.nil?
@@ -9307,11 +9712,12 @@ module Google
9307
9712
  # The standard list page token.
9308
9713
  # @param [Boolean] return_partial_success
9309
9714
  # When set to `true`, operations that are reachable are returned as normal, and
9310
- # those that are unreachable are returned in the [ListOperationsResponse.
9311
- # unreachable] field. This can only be `true` when reading across collections e.
9312
- # g. when `parent` is set to `"projects/example/locations/-"`. This field is not
9313
- # by default supported and will result in an `UNIMPLEMENTED` error if set unless
9314
- # explicitly documented otherwise in service or product specific documentation.
9715
+ # those that are unreachable are returned in the ListOperationsResponse.
9716
+ # unreachable field. This can only be `true` when reading across collections.
9717
+ # For example, when `parent` is set to `"projects/example/locations/-"`. This
9718
+ # field is not supported by default and will result in an `UNIMPLEMENTED` error
9719
+ # if set unless explicitly documented otherwise in service or product specific
9720
+ # documentation.
9315
9721
  # @param [String] fields
9316
9722
  # Selector specifying which fields to include in a partial response.
9317
9723
  # @param [String] quota_user