google-apis-discoveryengine_v1alpha 0.38.0 → 0.40.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -1056,6 +1056,87 @@ module Google
1056
1056
  execute_or_queue_command(command, &block)
1057
1057
  end
1058
1058
 
1059
+ # Gets a Document.
1060
+ # @param [String] name
1061
+ # Required. Full resource name of Chunk, such as `projects/`project`/locations/`
1062
+ # location`/collections/`collection`/dataStores/`data_store`/branches/`branch`/
1063
+ # documents/`document`/chunks/`chunk``. If the caller does not have permission
1064
+ # to access the Chunk, regardless of whether or not it exists, a `
1065
+ # PERMISSION_DENIED` error is returned. If the requested Chunk does not exist, a
1066
+ # `NOT_FOUND` error is returned.
1067
+ # @param [String] fields
1068
+ # Selector specifying which fields to include in a partial response.
1069
+ # @param [String] quota_user
1070
+ # Available to use for quota purposes for server-side applications. Can be any
1071
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1072
+ # @param [Google::Apis::RequestOptions] options
1073
+ # Request-specific options
1074
+ #
1075
+ # @yield [result, err] Result & error if block supplied
1076
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaChunk] parsed result object
1077
+ # @yieldparam err [StandardError] error object if request failed
1078
+ #
1079
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaChunk]
1080
+ #
1081
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1082
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1083
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1084
+ def get_project_location_collection_data_store_branch_document_chunk(name, fields: nil, quota_user: nil, options: nil, &block)
1085
+ command = make_simple_command(:get, 'v1alpha/{+name}', options)
1086
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaChunk::Representation
1087
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaChunk
1088
+ command.params['name'] = name unless name.nil?
1089
+ command.query['fields'] = fields unless fields.nil?
1090
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1091
+ execute_or_queue_command(command, &block)
1092
+ end
1093
+
1094
+ # Gets a list of Chunks.
1095
+ # @param [String] parent
1096
+ # Required. The parent document resource name, such as `projects/`project`/
1097
+ # locations/`location`/collections/`collection`/dataStores/`data_store`/branches/
1098
+ # `branch`/documents/`document``. If the caller does not have permission to list
1099
+ # Chunks under this document, regardless of whether or not this document exists,
1100
+ # a `PERMISSION_DENIED` error is returned.
1101
+ # @param [Fixnum] page_size
1102
+ # Maximum number of Chunks to return. If unspecified, defaults to 100. The
1103
+ # maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If
1104
+ # this field is negative, an `INVALID_ARGUMENT` error is returned.
1105
+ # @param [String] page_token
1106
+ # A page token ListChunksResponse.next_page_token, received from a previous
1107
+ # ChunkService.ListChunks call. Provide this to retrieve the subsequent page.
1108
+ # When paginating, all other parameters provided to ChunkService.ListChunks must
1109
+ # match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT`
1110
+ # error is returned.
1111
+ # @param [String] fields
1112
+ # Selector specifying which fields to include in a partial response.
1113
+ # @param [String] quota_user
1114
+ # Available to use for quota purposes for server-side applications. Can be any
1115
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1116
+ # @param [Google::Apis::RequestOptions] options
1117
+ # Request-specific options
1118
+ #
1119
+ # @yield [result, err] Result & error if block supplied
1120
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListChunksResponse] parsed result object
1121
+ # @yieldparam err [StandardError] error object if request failed
1122
+ #
1123
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListChunksResponse]
1124
+ #
1125
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1126
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1127
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1128
+ def list_project_location_collection_data_store_branch_document_chunks(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
1129
+ command = make_simple_command(:get, 'v1alpha/{+parent}/chunks', options)
1130
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListChunksResponse::Representation
1131
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListChunksResponse
1132
+ command.params['parent'] = parent unless parent.nil?
1133
+ command.query['pageSize'] = page_size unless page_size.nil?
1134
+ command.query['pageToken'] = page_token unless page_token.nil?
1135
+ command.query['fields'] = fields unless fields.nil?
1136
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1137
+ execute_or_queue_command(command, &block)
1138
+ end
1139
+
1059
1140
  # Gets the latest state of a long-running operation. Clients can use this method
1060
1141
  # to poll the operation result at intervals as recommended by the API service.
1061
1142
  # @param [String] name
@@ -1759,8 +1840,8 @@ module Google
1759
1840
  # exist.
1760
1841
  # @param [String] name
1761
1842
  # Required. The resource name of the ServingConfig to get. Format: `projects/`
1762
- # project_number`/locations/`location`/collections/`collection`/dataStores/`
1763
- # data_store`/servingConfigs/`serving_config_id``
1843
+ # project_number`/locations/`location`/collections/`collection`/engines/`engine`/
1844
+ # servingConfigs/`serving_config_id``
1764
1845
  # @param [String] fields
1765
1846
  # Selector specifying which fields to include in a partial response.
1766
1847
  # @param [String] quota_user
@@ -1790,8 +1871,8 @@ module Google
1790
1871
 
1791
1872
  # Lists all ServingConfigs linked to this dataStore.
1792
1873
  # @param [String] parent
1793
- # Required. The dataStore resource name. Format: `projects/`project_number`/
1794
- # locations/`location`/collections/`collection`/dataStores/`data_store``
1874
+ # Required. Full resource name of the parent resource. Format: `projects/`
1875
+ # project_number`/locations/`location`/collections/`collection`/engines/`engine``
1795
1876
  # @param [Fixnum] page_size
1796
1877
  # Optional. Maximum number of results to return. If unspecified, defaults to 100.
1797
1878
  # If a value greater than 100 is provided, at most 100 results are returned.
@@ -1831,7 +1912,7 @@ module Google
1831
1912
  # not exist.
1832
1913
  # @param [String] name
1833
1914
  # Immutable. Fully qualified name `projects/`project`/locations/`location`/
1834
- # collections/`collection_id`/dataStores/`data_store_id`/servingConfigs/`
1915
+ # collections/`collection_id`/engines/`engine_id`/servingConfigs/`
1835
1916
  # serving_config_id``
1836
1917
  # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaServingConfig] google_cloud_discoveryengine_v1alpha_serving_config_object
1837
1918
  # @param [String] update_mask
@@ -3315,8 +3396,8 @@ module Google
3315
3396
  # exist.
3316
3397
  # @param [String] name
3317
3398
  # Required. The resource name of the ServingConfig to get. Format: `projects/`
3318
- # project_number`/locations/`location`/collections/`collection`/dataStores/`
3319
- # data_store`/servingConfigs/`serving_config_id``
3399
+ # project_number`/locations/`location`/collections/`collection`/engines/`engine`/
3400
+ # servingConfigs/`serving_config_id``
3320
3401
  # @param [String] fields
3321
3402
  # Selector specifying which fields to include in a partial response.
3322
3403
  # @param [String] quota_user
@@ -3346,8 +3427,8 @@ module Google
3346
3427
 
3347
3428
  # Lists all ServingConfigs linked to this dataStore.
3348
3429
  # @param [String] parent
3349
- # Required. The dataStore resource name. Format: `projects/`project_number`/
3350
- # locations/`location`/collections/`collection`/dataStores/`data_store``
3430
+ # Required. Full resource name of the parent resource. Format: `projects/`
3431
+ # project_number`/locations/`location`/collections/`collection`/engines/`engine``
3351
3432
  # @param [Fixnum] page_size
3352
3433
  # Optional. Maximum number of results to return. If unspecified, defaults to 100.
3353
3434
  # If a value greater than 100 is provided, at most 100 results are returned.
@@ -3387,7 +3468,7 @@ module Google
3387
3468
  # not exist.
3388
3469
  # @param [String] name
3389
3470
  # Immutable. Fully qualified name `projects/`project`/locations/`location`/
3390
- # collections/`collection_id`/dataStores/`data_store_id`/servingConfigs/`
3471
+ # collections/`collection_id`/engines/`engine_id`/servingConfigs/`
3391
3472
  # serving_config_id``
3392
3473
  # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaServingConfig] google_cloud_discoveryengine_v1alpha_serving_config_object
3393
3474
  # @param [String] update_mask
@@ -4228,6 +4309,87 @@ module Google
4228
4309
  execute_or_queue_command(command, &block)
4229
4310
  end
4230
4311
 
4312
+ # Gets a Document.
4313
+ # @param [String] name
4314
+ # Required. Full resource name of Chunk, such as `projects/`project`/locations/`
4315
+ # location`/collections/`collection`/dataStores/`data_store`/branches/`branch`/
4316
+ # documents/`document`/chunks/`chunk``. If the caller does not have permission
4317
+ # to access the Chunk, regardless of whether or not it exists, a `
4318
+ # PERMISSION_DENIED` error is returned. If the requested Chunk does not exist, a
4319
+ # `NOT_FOUND` error is returned.
4320
+ # @param [String] fields
4321
+ # Selector specifying which fields to include in a partial response.
4322
+ # @param [String] quota_user
4323
+ # Available to use for quota purposes for server-side applications. Can be any
4324
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
4325
+ # @param [Google::Apis::RequestOptions] options
4326
+ # Request-specific options
4327
+ #
4328
+ # @yield [result, err] Result & error if block supplied
4329
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaChunk] parsed result object
4330
+ # @yieldparam err [StandardError] error object if request failed
4331
+ #
4332
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaChunk]
4333
+ #
4334
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
4335
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
4336
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
4337
+ def get_project_location_data_store_branch_document_chunk(name, fields: nil, quota_user: nil, options: nil, &block)
4338
+ command = make_simple_command(:get, 'v1alpha/{+name}', options)
4339
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaChunk::Representation
4340
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaChunk
4341
+ command.params['name'] = name unless name.nil?
4342
+ command.query['fields'] = fields unless fields.nil?
4343
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
4344
+ execute_or_queue_command(command, &block)
4345
+ end
4346
+
4347
+ # Gets a list of Chunks.
4348
+ # @param [String] parent
4349
+ # Required. The parent document resource name, such as `projects/`project`/
4350
+ # locations/`location`/collections/`collection`/dataStores/`data_store`/branches/
4351
+ # `branch`/documents/`document``. If the caller does not have permission to list
4352
+ # Chunks under this document, regardless of whether or not this document exists,
4353
+ # a `PERMISSION_DENIED` error is returned.
4354
+ # @param [Fixnum] page_size
4355
+ # Maximum number of Chunks to return. If unspecified, defaults to 100. The
4356
+ # maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If
4357
+ # this field is negative, an `INVALID_ARGUMENT` error is returned.
4358
+ # @param [String] page_token
4359
+ # A page token ListChunksResponse.next_page_token, received from a previous
4360
+ # ChunkService.ListChunks call. Provide this to retrieve the subsequent page.
4361
+ # When paginating, all other parameters provided to ChunkService.ListChunks must
4362
+ # match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT`
4363
+ # error is returned.
4364
+ # @param [String] fields
4365
+ # Selector specifying which fields to include in a partial response.
4366
+ # @param [String] quota_user
4367
+ # Available to use for quota purposes for server-side applications. Can be any
4368
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
4369
+ # @param [Google::Apis::RequestOptions] options
4370
+ # Request-specific options
4371
+ #
4372
+ # @yield [result, err] Result & error if block supplied
4373
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListChunksResponse] parsed result object
4374
+ # @yieldparam err [StandardError] error object if request failed
4375
+ #
4376
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListChunksResponse]
4377
+ #
4378
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
4379
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
4380
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
4381
+ def list_project_location_data_store_branch_document_chunks(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
4382
+ command = make_simple_command(:get, 'v1alpha/{+parent}/chunks', options)
4383
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListChunksResponse::Representation
4384
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListChunksResponse
4385
+ command.params['parent'] = parent unless parent.nil?
4386
+ command.query['pageSize'] = page_size unless page_size.nil?
4387
+ command.query['pageToken'] = page_token unless page_token.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
+
4231
4393
  # Gets the latest state of a long-running operation. Clients can use this method
4232
4394
  # to poll the operation result at intervals as recommended by the API service.
4233
4395
  # @param [String] name
@@ -4860,8 +5022,8 @@ module Google
4860
5022
  # exist.
4861
5023
  # @param [String] name
4862
5024
  # Required. The resource name of the ServingConfig to get. Format: `projects/`
4863
- # project_number`/locations/`location`/collections/`collection`/dataStores/`
4864
- # data_store`/servingConfigs/`serving_config_id``
5025
+ # project_number`/locations/`location`/collections/`collection`/engines/`engine`/
5026
+ # servingConfigs/`serving_config_id``
4865
5027
  # @param [String] fields
4866
5028
  # Selector specifying which fields to include in a partial response.
4867
5029
  # @param [String] quota_user
@@ -4891,8 +5053,8 @@ module Google
4891
5053
 
4892
5054
  # Lists all ServingConfigs linked to this dataStore.
4893
5055
  # @param [String] parent
4894
- # Required. The dataStore resource name. Format: `projects/`project_number`/
4895
- # locations/`location`/collections/`collection`/dataStores/`data_store``
5056
+ # Required. Full resource name of the parent resource. Format: `projects/`
5057
+ # project_number`/locations/`location`/collections/`collection`/engines/`engine``
4896
5058
  # @param [Fixnum] page_size
4897
5059
  # Optional. Maximum number of results to return. If unspecified, defaults to 100.
4898
5060
  # If a value greater than 100 is provided, at most 100 results are returned.
@@ -4932,7 +5094,7 @@ module Google
4932
5094
  # not exist.
4933
5095
  # @param [String] name
4934
5096
  # Immutable. Fully qualified name `projects/`project`/locations/`location`/
4935
- # collections/`collection_id`/dataStores/`data_store_id`/servingConfigs/`
5097
+ # collections/`collection_id`/engines/`engine_id`/servingConfigs/`
4936
5098
  # serving_config_id``
4937
5099
  # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaServingConfig] google_cloud_discoveryengine_v1alpha_serving_config_object
4938
5100
  # @param [String] update_mask
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-apis-discoveryengine_v1alpha
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.38.0
4
+ version: 0.40.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2024-03-03 00:00:00.000000000 Z
11
+ date: 2024-03-17 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: google-apis-core
@@ -58,7 +58,7 @@ licenses:
58
58
  metadata:
59
59
  bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
60
60
  changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-discoveryengine_v1alpha/CHANGELOG.md
61
- documentation_uri: https://googleapis.dev/ruby/google-apis-discoveryengine_v1alpha/v0.38.0
61
+ documentation_uri: https://googleapis.dev/ruby/google-apis-discoveryengine_v1alpha/v0.40.0
62
62
  source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-discoveryengine_v1alpha
63
63
  post_install_message:
64
64
  rdoc_options: []