1<html><body> 2<style> 3 4body, h1, h2, h3, div, span, p, pre, a { 5 margin: 0; 6 padding: 0; 7 border: 0; 8 font-weight: inherit; 9 font-style: inherit; 10 font-size: 100%; 11 font-family: inherit; 12 vertical-align: baseline; 13} 14 15body { 16 font-size: 13px; 17 padding: 1em; 18} 19 20h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23} 24 25h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28} 29 30h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34} 35 36pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39} 40 41pre { 42 margin-top: 0.5em; 43} 44 45h1, h2, h3, p { 46 font-family: Arial, sans serif; 47} 48 49h1, h2, h3 { 50 border-bottom: solid #CCC 1px; 51} 52 53.toc_element { 54 margin-top: 0.5em; 55} 56 57.firstline { 58 margin-left: 2 em; 59} 60 61.method { 62 margin-top: 1em; 63 border: solid 1px #CCC; 64 padding: 1em; 65 background: #EEE; 66} 67 68.details { 69 font-weight: bold; 70 font-size: 14px; 71} 72 73</style> 74 75<h1><a href="vision_v1.html">Cloud Vision API</a> . <a href="vision_v1.projects.html">projects</a> . <a href="vision_v1.projects.locations.html">locations</a> . <a href="vision_v1.projects.locations.productSets.html">productSets</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="vision_v1.projects.locations.productSets.products.html">products()</a></code> 79</p> 80<p class="firstline">Returns the products Resource.</p> 81 82<p class="toc_element"> 83 <code><a href="#addProduct">addProduct(name, body, x__xgafv=None)</a></code></p> 84<p class="firstline">Adds a Product to the specified ProductSet. If the Product is already</p> 85<p class="toc_element"> 86 <code><a href="#create">create(parent, body, productSetId=None, x__xgafv=None)</a></code></p> 87<p class="firstline">Creates and returns a new ProductSet resource.</p> 88<p class="toc_element"> 89 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p> 90<p class="firstline">Permanently deletes a ProductSet. Products and ReferenceImages in the</p> 91<p class="toc_element"> 92 <code><a href="#get">get(name, x__xgafv=None)</a></code></p> 93<p class="firstline">Gets information associated with a ProductSet.</p> 94<p class="toc_element"> 95 <code><a href="#import_">import_(parent, body, x__xgafv=None)</a></code></p> 96<p class="firstline">Asynchronous API that imports a list of reference images to specified</p> 97<p class="toc_element"> 98 <code><a href="#list">list(parent, pageToken=None, x__xgafv=None, pageSize=None)</a></code></p> 99<p class="firstline">Lists ProductSets in an unspecified order.</p> 100<p class="toc_element"> 101 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 102<p class="firstline">Retrieves the next page of results.</p> 103<p class="toc_element"> 104 <code><a href="#patch">patch(name, body, updateMask=None, x__xgafv=None)</a></code></p> 105<p class="firstline">Makes changes to a ProductSet resource.</p> 106<p class="toc_element"> 107 <code><a href="#removeProduct">removeProduct(name, body, x__xgafv=None)</a></code></p> 108<p class="firstline">Removes a Product from the specified ProductSet.</p> 109<h3>Method Details</h3> 110<div class="method"> 111 <code class="details" id="addProduct">addProduct(name, body, x__xgafv=None)</code> 112 <pre>Adds a Product to the specified ProductSet. If the Product is already 113present, no change is made. 114 115One Product can be added to at most 100 ProductSets. 116 117Possible errors: 118 119* Returns NOT_FOUND if the Product or the ProductSet doesn't exist. 120 121Args: 122 name: string, The resource name for the ProductSet to modify. 123 124Format is: 125`projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID` (required) 126 body: object, The request body. (required) 127 The object takes the form of: 128 129{ # Request message for the `AddProductToProductSet` method. 130 "product": "A String", # The resource name for the Product to be added to this ProductSet. 131 # 132 # Format is: 133 # `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID` 134 } 135 136 x__xgafv: string, V1 error format. 137 Allowed values 138 1 - v1 error format 139 2 - v2 error format 140 141Returns: 142 An object of the form: 143 144 { # A generic empty message that you can re-use to avoid defining duplicated 145 # empty messages in your APIs. A typical example is to use it as the request 146 # or the response type of an API method. For instance: 147 # 148 # service Foo { 149 # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); 150 # } 151 # 152 # The JSON representation for `Empty` is empty JSON object `{}`. 153 }</pre> 154</div> 155 156<div class="method"> 157 <code class="details" id="create">create(parent, body, productSetId=None, x__xgafv=None)</code> 158 <pre>Creates and returns a new ProductSet resource. 159 160Possible errors: 161 162* Returns INVALID_ARGUMENT if display_name is missing, or is longer than 163 4096 characters. 164 165Args: 166 parent: string, The project in which the ProductSet should be created. 167 168Format is `projects/PROJECT_ID/locations/LOC_ID`. (required) 169 body: object, The request body. (required) 170 The object takes the form of: 171 172{ # A ProductSet contains Products. A ProductSet can contain a maximum of 1 173 # million reference images. If the limit is exceeded, periodic indexing will 174 # fail. 175 "indexError": { # The `Status` type defines a logical error model that is suitable for # Output only. If there was an error with indexing the product set, the field 176 # is populated. 177 # 178 # This field is ignored when creating a ProductSet. 179 # different programming environments, including REST APIs and RPC APIs. It is 180 # used by [gRPC](https://github.com/grpc). Each `Status` message contains 181 # three pieces of data: error code, error message, and error details. 182 # 183 # You can find out more about this error model and how to work with it in the 184 # [API Design Guide](https://cloud.google.com/apis/design/errors). 185 "message": "A String", # A developer-facing error message, which should be in English. Any 186 # user-facing error message should be localized and sent in the 187 # google.rpc.Status.details field, or localized by the client. 188 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 189 "details": [ # A list of messages that carry the error details. There is a common set of 190 # message types for APIs to use. 191 { 192 "a_key": "", # Properties of the object. Contains field @type with type URL. 193 }, 194 ], 195 }, 196 "displayName": "A String", # The user-provided name for this ProductSet. Must not be empty. Must be at 197 # most 4096 characters long. 198 "name": "A String", # The resource name of the ProductSet. 199 # 200 # Format is: 201 # `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`. 202 # 203 # This field is ignored when creating a ProductSet. 204 "indexTime": "A String", # Output only. The time at which this ProductSet was last indexed. Query 205 # results will reflect all updates before this time. If this ProductSet has 206 # never been indexed, this timestamp is the default value 207 # "1970-01-01T00:00:00Z". 208 # 209 # This field is ignored when creating a ProductSet. 210} 211 212 productSetId: string, A user-supplied resource id for this ProductSet. If set, the server will 213attempt to use this value as the resource id. If it is already in use, an 214error is returned with code ALREADY_EXISTS. Must be at most 128 characters 215long. It cannot contain the character `/`. 216 x__xgafv: string, V1 error format. 217 Allowed values 218 1 - v1 error format 219 2 - v2 error format 220 221Returns: 222 An object of the form: 223 224 { # A ProductSet contains Products. A ProductSet can contain a maximum of 1 225 # million reference images. If the limit is exceeded, periodic indexing will 226 # fail. 227 "indexError": { # The `Status` type defines a logical error model that is suitable for # Output only. If there was an error with indexing the product set, the field 228 # is populated. 229 # 230 # This field is ignored when creating a ProductSet. 231 # different programming environments, including REST APIs and RPC APIs. It is 232 # used by [gRPC](https://github.com/grpc). Each `Status` message contains 233 # three pieces of data: error code, error message, and error details. 234 # 235 # You can find out more about this error model and how to work with it in the 236 # [API Design Guide](https://cloud.google.com/apis/design/errors). 237 "message": "A String", # A developer-facing error message, which should be in English. Any 238 # user-facing error message should be localized and sent in the 239 # google.rpc.Status.details field, or localized by the client. 240 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 241 "details": [ # A list of messages that carry the error details. There is a common set of 242 # message types for APIs to use. 243 { 244 "a_key": "", # Properties of the object. Contains field @type with type URL. 245 }, 246 ], 247 }, 248 "displayName": "A String", # The user-provided name for this ProductSet. Must not be empty. Must be at 249 # most 4096 characters long. 250 "name": "A String", # The resource name of the ProductSet. 251 # 252 # Format is: 253 # `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`. 254 # 255 # This field is ignored when creating a ProductSet. 256 "indexTime": "A String", # Output only. The time at which this ProductSet was last indexed. Query 257 # results will reflect all updates before this time. If this ProductSet has 258 # never been indexed, this timestamp is the default value 259 # "1970-01-01T00:00:00Z". 260 # 261 # This field is ignored when creating a ProductSet. 262 }</pre> 263</div> 264 265<div class="method"> 266 <code class="details" id="delete">delete(name, x__xgafv=None)</code> 267 <pre>Permanently deletes a ProductSet. Products and ReferenceImages in the 268ProductSet are not deleted. 269 270The actual image files are not deleted from Google Cloud Storage. 271 272Args: 273 name: string, Resource name of the ProductSet to delete. 274 275Format is: 276`projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID` (required) 277 x__xgafv: string, V1 error format. 278 Allowed values 279 1 - v1 error format 280 2 - v2 error format 281 282Returns: 283 An object of the form: 284 285 { # A generic empty message that you can re-use to avoid defining duplicated 286 # empty messages in your APIs. A typical example is to use it as the request 287 # or the response type of an API method. For instance: 288 # 289 # service Foo { 290 # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); 291 # } 292 # 293 # The JSON representation for `Empty` is empty JSON object `{}`. 294 }</pre> 295</div> 296 297<div class="method"> 298 <code class="details" id="get">get(name, x__xgafv=None)</code> 299 <pre>Gets information associated with a ProductSet. 300 301Possible errors: 302 303* Returns NOT_FOUND if the ProductSet does not exist. 304 305Args: 306 name: string, Resource name of the ProductSet to get. 307 308Format is: 309`projects/PROJECT_ID/locations/LOG_ID/productSets/PRODUCT_SET_ID` (required) 310 x__xgafv: string, V1 error format. 311 Allowed values 312 1 - v1 error format 313 2 - v2 error format 314 315Returns: 316 An object of the form: 317 318 { # A ProductSet contains Products. A ProductSet can contain a maximum of 1 319 # million reference images. If the limit is exceeded, periodic indexing will 320 # fail. 321 "indexError": { # The `Status` type defines a logical error model that is suitable for # Output only. If there was an error with indexing the product set, the field 322 # is populated. 323 # 324 # This field is ignored when creating a ProductSet. 325 # different programming environments, including REST APIs and RPC APIs. It is 326 # used by [gRPC](https://github.com/grpc). Each `Status` message contains 327 # three pieces of data: error code, error message, and error details. 328 # 329 # You can find out more about this error model and how to work with it in the 330 # [API Design Guide](https://cloud.google.com/apis/design/errors). 331 "message": "A String", # A developer-facing error message, which should be in English. Any 332 # user-facing error message should be localized and sent in the 333 # google.rpc.Status.details field, or localized by the client. 334 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 335 "details": [ # A list of messages that carry the error details. There is a common set of 336 # message types for APIs to use. 337 { 338 "a_key": "", # Properties of the object. Contains field @type with type URL. 339 }, 340 ], 341 }, 342 "displayName": "A String", # The user-provided name for this ProductSet. Must not be empty. Must be at 343 # most 4096 characters long. 344 "name": "A String", # The resource name of the ProductSet. 345 # 346 # Format is: 347 # `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`. 348 # 349 # This field is ignored when creating a ProductSet. 350 "indexTime": "A String", # Output only. The time at which this ProductSet was last indexed. Query 351 # results will reflect all updates before this time. If this ProductSet has 352 # never been indexed, this timestamp is the default value 353 # "1970-01-01T00:00:00Z". 354 # 355 # This field is ignored when creating a ProductSet. 356 }</pre> 357</div> 358 359<div class="method"> 360 <code class="details" id="import_">import_(parent, body, x__xgafv=None)</code> 361 <pre>Asynchronous API that imports a list of reference images to specified 362product sets based on a list of image information. 363 364The google.longrunning.Operation API can be used to keep track of the 365progress and results of the request. 366`Operation.metadata` contains `BatchOperationMetadata`. (progress) 367`Operation.response` contains `ImportProductSetsResponse`. (results) 368 369The input source of this method is a csv file on Google Cloud Storage. 370For the format of the csv file please see 371ImportProductSetsGcsSource.csv_file_uri. 372 373Args: 374 parent: string, The project in which the ProductSets should be imported. 375 376Format is `projects/PROJECT_ID/locations/LOC_ID`. (required) 377 body: object, The request body. (required) 378 The object takes the form of: 379 380{ # Request message for the `ImportProductSets` method. 381 "inputConfig": { # The input content for the `ImportProductSets` method. # The input content for the list of requests. 382 "gcsSource": { # The Google Cloud Storage location for a csv file which preserves a list of # The Google Cloud Storage location for a csv file which preserves a list 383 # of ImportProductSetRequests in each line. 384 # ImportProductSetRequests in each line. 385 "csvFileUri": "A String", # The Google Cloud Storage URI of the input csv file. 386 # 387 # The URI must start with `gs://`. 388 # 389 # The format of the input csv file should be one image per line. 390 # In each line, there are 8 columns. 391 # 392 # 1. image-uri 393 # 2. image-id 394 # 3. product-set-id 395 # 4. product-id 396 # 5. product-category 397 # 6. product-display-name 398 # 7. labels 399 # 8. bounding-poly 400 # 401 # The `image-uri`, `product-set-id`, `product-id`, and `product-category` 402 # columns are required. All other columns are optional. 403 # 404 # If the `ProductSet` or `Product` specified by the `product-set-id` and 405 # `product-id` values does not exist, then the system will create a new 406 # `ProductSet` or `Product` for the image. In this case, the 407 # `product-display-name` column refers to 408 # display_name, the 409 # `product-category` column refers to 410 # product_category, and the 411 # `labels` column refers to product_labels. 412 # 413 # The `image-id` column is optional but must be unique if provided. If it is 414 # empty, the system will automatically assign a unique id to the image. 415 # 416 # The `product-display-name` column is optional. If it is empty, the system 417 # sets the display_name field for the product to a 418 # space (" "). You can update the `display_name` later by using the API. 419 # 420 # If a `Product` with the specified `product-id` already exists, then the 421 # system ignores the `product-display-name`, `product-category`, and `labels` 422 # columns. 423 # 424 # The `labels` column (optional) is a line containing a list of 425 # comma-separated key-value pairs, in the following format: 426 # 427 # "key_1=value_1,key_2=value_2,...,key_n=value_n" 428 # 429 # The `bounding-poly` column (optional) identifies one region of 430 # interest from the image in the same manner as `CreateReferenceImage`. If 431 # you do not specify the `bounding-poly` column, then the system will try to 432 # detect regions of interest automatically. 433 # 434 # At most one `bounding-poly` column is allowed per line. If the image 435 # contains multiple regions of interest, add a line to the CSV file that 436 # includes the same product information, and the `bounding-poly` values for 437 # each region of interest. 438 # 439 # The `bounding-poly` column must contain an even number of comma-separated 440 # numbers, in the format "p1_x,p1_y,p2_x,p2_y,...,pn_x,pn_y". Use 441 # non-negative integers for absolute bounding polygons, and float values 442 # in [0, 1] for normalized bounding polygons. 443 # 444 # The system will resize the image if the image resolution is too 445 # large to process (larger than 20MP). 446 }, 447 }, 448 } 449 450 x__xgafv: string, V1 error format. 451 Allowed values 452 1 - v1 error format 453 2 - v2 error format 454 455Returns: 456 An object of the form: 457 458 { # This resource represents a long-running operation that is the result of a 459 # network API call. 460 "response": { # The normal response of the operation in case of success. If the original 461 # method returns no data on success, such as `Delete`, the response is 462 # `google.protobuf.Empty`. If the original method is standard 463 # `Get`/`Create`/`Update`, the response should be the resource. For other 464 # methods, the response should have the type `XxxResponse`, where `Xxx` 465 # is the original method name. For example, if the original method name 466 # is `TakeSnapshot()`, the inferred response type is 467 # `TakeSnapshotResponse`. 468 "a_key": "", # Properties of the object. Contains field @type with type URL. 469 }, 470 "metadata": { # Service-specific metadata associated with the operation. It typically 471 # contains progress information and common metadata such as create time. 472 # Some services might not provide such metadata. Any method that returns a 473 # long-running operation should document the metadata type, if any. 474 "a_key": "", # Properties of the object. Contains field @type with type URL. 475 }, 476 "done": True or False, # If the value is `false`, it means the operation is still in progress. 477 # If `true`, the operation is completed, and either `error` or `response` is 478 # available. 479 "name": "A String", # The server-assigned name, which is only unique within the same service that 480 # originally returns it. If you use the default HTTP mapping, the 481 # `name` should be a resource name ending with `operations/{unique_id}`. 482 "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation. 483 # different programming environments, including REST APIs and RPC APIs. It is 484 # used by [gRPC](https://github.com/grpc). Each `Status` message contains 485 # three pieces of data: error code, error message, and error details. 486 # 487 # You can find out more about this error model and how to work with it in the 488 # [API Design Guide](https://cloud.google.com/apis/design/errors). 489 "message": "A String", # A developer-facing error message, which should be in English. Any 490 # user-facing error message should be localized and sent in the 491 # google.rpc.Status.details field, or localized by the client. 492 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 493 "details": [ # A list of messages that carry the error details. There is a common set of 494 # message types for APIs to use. 495 { 496 "a_key": "", # Properties of the object. Contains field @type with type URL. 497 }, 498 ], 499 }, 500 }</pre> 501</div> 502 503<div class="method"> 504 <code class="details" id="list">list(parent, pageToken=None, x__xgafv=None, pageSize=None)</code> 505 <pre>Lists ProductSets in an unspecified order. 506 507Possible errors: 508 509* Returns INVALID_ARGUMENT if page_size is greater than 100, or less 510 than 1. 511 512Args: 513 parent: string, The project from which ProductSets should be listed. 514 515Format is `projects/PROJECT_ID/locations/LOC_ID`. (required) 516 pageToken: string, The next_page_token returned from a previous List request, if any. 517 x__xgafv: string, V1 error format. 518 Allowed values 519 1 - v1 error format 520 2 - v2 error format 521 pageSize: integer, The maximum number of items to return. Default 10, maximum 100. 522 523Returns: 524 An object of the form: 525 526 { # Response message for the `ListProductSets` method. 527 "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more 528 # results in the list. 529 "productSets": [ # List of ProductSets. 530 { # A ProductSet contains Products. A ProductSet can contain a maximum of 1 531 # million reference images. If the limit is exceeded, periodic indexing will 532 # fail. 533 "indexError": { # The `Status` type defines a logical error model that is suitable for # Output only. If there was an error with indexing the product set, the field 534 # is populated. 535 # 536 # This field is ignored when creating a ProductSet. 537 # different programming environments, including REST APIs and RPC APIs. It is 538 # used by [gRPC](https://github.com/grpc). Each `Status` message contains 539 # three pieces of data: error code, error message, and error details. 540 # 541 # You can find out more about this error model and how to work with it in the 542 # [API Design Guide](https://cloud.google.com/apis/design/errors). 543 "message": "A String", # A developer-facing error message, which should be in English. Any 544 # user-facing error message should be localized and sent in the 545 # google.rpc.Status.details field, or localized by the client. 546 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 547 "details": [ # A list of messages that carry the error details. There is a common set of 548 # message types for APIs to use. 549 { 550 "a_key": "", # Properties of the object. Contains field @type with type URL. 551 }, 552 ], 553 }, 554 "displayName": "A String", # The user-provided name for this ProductSet. Must not be empty. Must be at 555 # most 4096 characters long. 556 "name": "A String", # The resource name of the ProductSet. 557 # 558 # Format is: 559 # `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`. 560 # 561 # This field is ignored when creating a ProductSet. 562 "indexTime": "A String", # Output only. The time at which this ProductSet was last indexed. Query 563 # results will reflect all updates before this time. If this ProductSet has 564 # never been indexed, this timestamp is the default value 565 # "1970-01-01T00:00:00Z". 566 # 567 # This field is ignored when creating a ProductSet. 568 }, 569 ], 570 }</pre> 571</div> 572 573<div class="method"> 574 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 575 <pre>Retrieves the next page of results. 576 577Args: 578 previous_request: The request for the previous page. (required) 579 previous_response: The response from the request for the previous page. (required) 580 581Returns: 582 A request object that you can call 'execute()' on to request the next 583 page. Returns None if there are no more items in the collection. 584 </pre> 585</div> 586 587<div class="method"> 588 <code class="details" id="patch">patch(name, body, updateMask=None, x__xgafv=None)</code> 589 <pre>Makes changes to a ProductSet resource. 590Only display_name can be updated currently. 591 592Possible errors: 593 594* Returns NOT_FOUND if the ProductSet does not exist. 595* Returns INVALID_ARGUMENT if display_name is present in update_mask but 596 missing from the request or longer than 4096 characters. 597 598Args: 599 name: string, The resource name of the ProductSet. 600 601Format is: 602`projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`. 603 604This field is ignored when creating a ProductSet. (required) 605 body: object, The request body. (required) 606 The object takes the form of: 607 608{ # A ProductSet contains Products. A ProductSet can contain a maximum of 1 609 # million reference images. If the limit is exceeded, periodic indexing will 610 # fail. 611 "indexError": { # The `Status` type defines a logical error model that is suitable for # Output only. If there was an error with indexing the product set, the field 612 # is populated. 613 # 614 # This field is ignored when creating a ProductSet. 615 # different programming environments, including REST APIs and RPC APIs. It is 616 # used by [gRPC](https://github.com/grpc). Each `Status` message contains 617 # three pieces of data: error code, error message, and error details. 618 # 619 # You can find out more about this error model and how to work with it in the 620 # [API Design Guide](https://cloud.google.com/apis/design/errors). 621 "message": "A String", # A developer-facing error message, which should be in English. Any 622 # user-facing error message should be localized and sent in the 623 # google.rpc.Status.details field, or localized by the client. 624 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 625 "details": [ # A list of messages that carry the error details. There is a common set of 626 # message types for APIs to use. 627 { 628 "a_key": "", # Properties of the object. Contains field @type with type URL. 629 }, 630 ], 631 }, 632 "displayName": "A String", # The user-provided name for this ProductSet. Must not be empty. Must be at 633 # most 4096 characters long. 634 "name": "A String", # The resource name of the ProductSet. 635 # 636 # Format is: 637 # `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`. 638 # 639 # This field is ignored when creating a ProductSet. 640 "indexTime": "A String", # Output only. The time at which this ProductSet was last indexed. Query 641 # results will reflect all updates before this time. If this ProductSet has 642 # never been indexed, this timestamp is the default value 643 # "1970-01-01T00:00:00Z". 644 # 645 # This field is ignored when creating a ProductSet. 646} 647 648 updateMask: string, The FieldMask that specifies which fields to 649update. 650If update_mask isn't specified, all mutable fields are to be updated. 651Valid mask path is `display_name`. 652 x__xgafv: string, V1 error format. 653 Allowed values 654 1 - v1 error format 655 2 - v2 error format 656 657Returns: 658 An object of the form: 659 660 { # A ProductSet contains Products. A ProductSet can contain a maximum of 1 661 # million reference images. If the limit is exceeded, periodic indexing will 662 # fail. 663 "indexError": { # The `Status` type defines a logical error model that is suitable for # Output only. If there was an error with indexing the product set, the field 664 # is populated. 665 # 666 # This field is ignored when creating a ProductSet. 667 # different programming environments, including REST APIs and RPC APIs. It is 668 # used by [gRPC](https://github.com/grpc). Each `Status` message contains 669 # three pieces of data: error code, error message, and error details. 670 # 671 # You can find out more about this error model and how to work with it in the 672 # [API Design Guide](https://cloud.google.com/apis/design/errors). 673 "message": "A String", # A developer-facing error message, which should be in English. Any 674 # user-facing error message should be localized and sent in the 675 # google.rpc.Status.details field, or localized by the client. 676 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 677 "details": [ # A list of messages that carry the error details. There is a common set of 678 # message types for APIs to use. 679 { 680 "a_key": "", # Properties of the object. Contains field @type with type URL. 681 }, 682 ], 683 }, 684 "displayName": "A String", # The user-provided name for this ProductSet. Must not be empty. Must be at 685 # most 4096 characters long. 686 "name": "A String", # The resource name of the ProductSet. 687 # 688 # Format is: 689 # `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`. 690 # 691 # This field is ignored when creating a ProductSet. 692 "indexTime": "A String", # Output only. The time at which this ProductSet was last indexed. Query 693 # results will reflect all updates before this time. If this ProductSet has 694 # never been indexed, this timestamp is the default value 695 # "1970-01-01T00:00:00Z". 696 # 697 # This field is ignored when creating a ProductSet. 698 }</pre> 699</div> 700 701<div class="method"> 702 <code class="details" id="removeProduct">removeProduct(name, body, x__xgafv=None)</code> 703 <pre>Removes a Product from the specified ProductSet. 704 705Args: 706 name: string, The resource name for the ProductSet to modify. 707 708Format is: 709`projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID` (required) 710 body: object, The request body. (required) 711 The object takes the form of: 712 713{ # Request message for the `RemoveProductFromProductSet` method. 714 "product": "A String", # The resource name for the Product to be removed from this ProductSet. 715 # 716 # Format is: 717 # `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID` 718 } 719 720 x__xgafv: string, V1 error format. 721 Allowed values 722 1 - v1 error format 723 2 - v2 error format 724 725Returns: 726 An object of the form: 727 728 { # A generic empty message that you can re-use to avoid defining duplicated 729 # empty messages in your APIs. A typical example is to use it as the request 730 # or the response type of an API method. For instance: 731 # 732 # service Foo { 733 # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); 734 # } 735 # 736 # The JSON representation for `Empty` is empty JSON object `{}`. 737 }</pre> 738</div> 739 740</body></html>