File: vision_v1.projects.locations.productSets.html

package info (click to toggle)
python-googleapi 1.7.11-4
  • links: PTS
  • area: main
  • in suites: bullseye
  • size: 110,952 kB
  • sloc: python: 7,784; javascript: 249; makefile: 59; sh: 53; xml: 5
file content (740 lines) | stat: -rw-r--r-- 31,522 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
<html><body>
<style>

body, h1, h2, h3, div, span, p, pre, a {
  margin: 0;
  padding: 0;
  border: 0;
  font-weight: inherit;
  font-style: inherit;
  font-size: 100%;
  font-family: inherit;
  vertical-align: baseline;
}

body {
  font-size: 13px;
  padding: 1em;
}

h1 {
  font-size: 26px;
  margin-bottom: 1em;
}

h2 {
  font-size: 24px;
  margin-bottom: 1em;
}

h3 {
  font-size: 20px;
  margin-bottom: 1em;
  margin-top: 1em;
}

pre, code {
  line-height: 1.5;
  font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}

pre {
  margin-top: 0.5em;
}

h1, h2, h3, p {
  font-family: Arial, sans serif;
}

h1, h2, h3 {
  border-bottom: solid #CCC 1px;
}

.toc_element {
  margin-top: 0.5em;
}

.firstline {
  margin-left: 2 em;
}

.method  {
  margin-top: 1em;
  border: solid 1px #CCC;
  padding: 1em;
  background: #EEE;
}

.details {
  font-weight: bold;
  font-size: 14px;
}

</style>

<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>
<h2>Instance Methods</h2>
<p class="toc_element">
  <code><a href="vision_v1.projects.locations.productSets.products.html">products()</a></code>
</p>
<p class="firstline">Returns the products Resource.</p>

<p class="toc_element">
  <code><a href="#addProduct">addProduct(name, body, x__xgafv=None)</a></code></p>
<p class="firstline">Adds a Product to the specified ProductSet. If the Product is already</p>
<p class="toc_element">
  <code><a href="#create">create(parent, body, productSetId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates and returns a new ProductSet resource.</p>
<p class="toc_element">
  <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
<p class="firstline">Permanently deletes a ProductSet. Products and ReferenceImages in the</p>
<p class="toc_element">
  <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets information associated with a ProductSet.</p>
<p class="toc_element">
  <code><a href="#import_">import_(parent, body, x__xgafv=None)</a></code></p>
<p class="firstline">Asynchronous API that imports a list of reference images to specified</p>
<p class="toc_element">
  <code><a href="#list">list(parent, pageToken=None, x__xgafv=None, pageSize=None)</a></code></p>
<p class="firstline">Lists ProductSets in an unspecified order.</p>
<p class="toc_element">
  <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
  <code><a href="#patch">patch(name, body, updateMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Makes changes to a ProductSet resource.</p>
<p class="toc_element">
  <code><a href="#removeProduct">removeProduct(name, body, x__xgafv=None)</a></code></p>
<p class="firstline">Removes a Product from the specified ProductSet.</p>
<h3>Method Details</h3>
<div class="method">
    <code class="details" id="addProduct">addProduct(name, body, x__xgafv=None)</code>
  <pre>Adds a Product to the specified ProductSet. If the Product is already
present, no change is made.

One Product can be added to at most 100 ProductSets.

Possible errors:

* Returns NOT_FOUND if the Product or the ProductSet doesn't exist.

Args:
  name: string, The resource name for the ProductSet to modify.

Format is:
`projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID` (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Request message for the `AddProductToProductSet` method.
    "product": "A String", # The resource name for the Product to be added to this ProductSet.
        # 
        # Format is:
        # `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`
  }

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated
      # empty messages in your APIs. A typical example is to use it as the request
      # or the response type of an API method. For instance:
      #
      #     service Foo {
      #       rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
      #     }
      #
      # The JSON representation for `Empty` is empty JSON object `{}`.
  }</pre>
</div>

<div class="method">
    <code class="details" id="create">create(parent, body, productSetId=None, x__xgafv=None)</code>
  <pre>Creates and returns a new ProductSet resource.

Possible errors:

* Returns INVALID_ARGUMENT if display_name is missing, or is longer than
  4096 characters.

Args:
  parent: string, The project in which the ProductSet should be created.

Format is `projects/PROJECT_ID/locations/LOC_ID`. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # A ProductSet contains Products. A ProductSet can contain a maximum of 1
    # million reference images. If the limit is exceeded, periodic indexing will
    # fail.
  "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
      # is populated.
      # 
      # This field is ignored when creating a ProductSet.
      # different programming environments, including REST APIs and RPC APIs. It is
      # used by [gRPC](https://github.com/grpc). Each `Status` message contains
      # three pieces of data: error code, error message, and error details.
      #
      # You can find out more about this error model and how to work with it in the
      # [API Design Guide](https://cloud.google.com/apis/design/errors).
    "message": "A String", # A developer-facing error message, which should be in English. Any
        # user-facing error message should be localized and sent in the
        # google.rpc.Status.details field, or localized by the client.
    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
    "details": [ # A list of messages that carry the error details.  There is a common set of
        # message types for APIs to use.
      {
        "a_key": "", # Properties of the object. Contains field @type with type URL.
      },
    ],
  },
  "displayName": "A String", # The user-provided name for this ProductSet. Must not be empty. Must be at
      # most 4096 characters long.
  "name": "A String", # The resource name of the ProductSet.
      # 
      # Format is:
      # `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`.
      # 
      # This field is ignored when creating a ProductSet.
  "indexTime": "A String", # Output only. The time at which this ProductSet was last indexed. Query
      # results will reflect all updates before this time. If this ProductSet has
      # never been indexed, this timestamp is the default value
      # "1970-01-01T00:00:00Z".
      # 
      # This field is ignored when creating a ProductSet.
}

  productSetId: string, A user-supplied resource id for this ProductSet. If set, the server will
attempt to use this value as the resource id. If it is already in use, an
error is returned with code ALREADY_EXISTS. Must be at most 128 characters
long. It cannot contain the character `/`.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A ProductSet contains Products. A ProductSet can contain a maximum of 1
      # million reference images. If the limit is exceeded, periodic indexing will
      # fail.
    "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
        # is populated.
        #
        # This field is ignored when creating a ProductSet.
        # different programming environments, including REST APIs and RPC APIs. It is
        # used by [gRPC](https://github.com/grpc). Each `Status` message contains
        # three pieces of data: error code, error message, and error details.
        #
        # You can find out more about this error model and how to work with it in the
        # [API Design Guide](https://cloud.google.com/apis/design/errors).
      "message": "A String", # A developer-facing error message, which should be in English. Any
          # user-facing error message should be localized and sent in the
          # google.rpc.Status.details field, or localized by the client.
      "code": 42, # The status code, which should be an enum value of google.rpc.Code.
      "details": [ # A list of messages that carry the error details.  There is a common set of
          # message types for APIs to use.
        {
          "a_key": "", # Properties of the object. Contains field @type with type URL.
        },
      ],
    },
    "displayName": "A String", # The user-provided name for this ProductSet. Must not be empty. Must be at
        # most 4096 characters long.
    "name": "A String", # The resource name of the ProductSet.
        #
        # Format is:
        # `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`.
        #
        # This field is ignored when creating a ProductSet.
    "indexTime": "A String", # Output only. The time at which this ProductSet was last indexed. Query
        # results will reflect all updates before this time. If this ProductSet has
        # never been indexed, this timestamp is the default value
        # "1970-01-01T00:00:00Z".
        #
        # This field is ignored when creating a ProductSet.
  }</pre>
</div>

<div class="method">
    <code class="details" id="delete">delete(name, x__xgafv=None)</code>
  <pre>Permanently deletes a ProductSet. Products and ReferenceImages in the
ProductSet are not deleted.

The actual image files are not deleted from Google Cloud Storage.

Args:
  name: string, Resource name of the ProductSet to delete.

Format is:
`projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID` (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated
      # empty messages in your APIs. A typical example is to use it as the request
      # or the response type of an API method. For instance:
      #
      #     service Foo {
      #       rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
      #     }
      #
      # The JSON representation for `Empty` is empty JSON object `{}`.
  }</pre>
</div>

<div class="method">
    <code class="details" id="get">get(name, x__xgafv=None)</code>
  <pre>Gets information associated with a ProductSet.

Possible errors:

* Returns NOT_FOUND if the ProductSet does not exist.

Args:
  name: string, Resource name of the ProductSet to get.

Format is:
`projects/PROJECT_ID/locations/LOG_ID/productSets/PRODUCT_SET_ID` (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A ProductSet contains Products. A ProductSet can contain a maximum of 1
      # million reference images. If the limit is exceeded, periodic indexing will
      # fail.
    "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
        # is populated.
        #
        # This field is ignored when creating a ProductSet.
        # different programming environments, including REST APIs and RPC APIs. It is
        # used by [gRPC](https://github.com/grpc). Each `Status` message contains
        # three pieces of data: error code, error message, and error details.
        #
        # You can find out more about this error model and how to work with it in the
        # [API Design Guide](https://cloud.google.com/apis/design/errors).
      "message": "A String", # A developer-facing error message, which should be in English. Any
          # user-facing error message should be localized and sent in the
          # google.rpc.Status.details field, or localized by the client.
      "code": 42, # The status code, which should be an enum value of google.rpc.Code.
      "details": [ # A list of messages that carry the error details.  There is a common set of
          # message types for APIs to use.
        {
          "a_key": "", # Properties of the object. Contains field @type with type URL.
        },
      ],
    },
    "displayName": "A String", # The user-provided name for this ProductSet. Must not be empty. Must be at
        # most 4096 characters long.
    "name": "A String", # The resource name of the ProductSet.
        #
        # Format is:
        # `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`.
        #
        # This field is ignored when creating a ProductSet.
    "indexTime": "A String", # Output only. The time at which this ProductSet was last indexed. Query
        # results will reflect all updates before this time. If this ProductSet has
        # never been indexed, this timestamp is the default value
        # "1970-01-01T00:00:00Z".
        #
        # This field is ignored when creating a ProductSet.
  }</pre>
</div>

<div class="method">
    <code class="details" id="import_">import_(parent, body, x__xgafv=None)</code>
  <pre>Asynchronous API that imports a list of reference images to specified
product sets based on a list of image information.

The google.longrunning.Operation API can be used to keep track of the
progress and results of the request.
`Operation.metadata` contains `BatchOperationMetadata`. (progress)
`Operation.response` contains `ImportProductSetsResponse`. (results)

The input source of this method is a csv file on Google Cloud Storage.
For the format of the csv file please see
ImportProductSetsGcsSource.csv_file_uri.

Args:
  parent: string, The project in which the ProductSets should be imported.

Format is `projects/PROJECT_ID/locations/LOC_ID`. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Request message for the `ImportProductSets` method.
    "inputConfig": { # The input content for the `ImportProductSets` method. # The input content for the list of requests.
      "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
          # of ImportProductSetRequests in each line.
          # ImportProductSetRequests in each line.
        "csvFileUri": "A String", # The Google Cloud Storage URI of the input csv file.
            #
            # The URI must start with `gs://`.
            #
            # The format of the input csv file should be one image per line.
            # In each line, there are 8 columns.
            #
            # 1.  image-uri
            # 2.  image-id
            # 3.  product-set-id
            # 4.  product-id
            # 5.  product-category
            # 6.  product-display-name
            # 7.  labels
            # 8.  bounding-poly
            #
            # The `image-uri`, `product-set-id`, `product-id`, and `product-category`
            # columns are required. All other columns are optional.
            #
            # If the `ProductSet` or `Product` specified by the `product-set-id` and
            # `product-id` values does not exist, then the system will create a new
            # `ProductSet` or `Product` for the image. In this case, the
            # `product-display-name` column refers to
            # display_name, the
            # `product-category` column refers to
            # product_category, and the
            # `labels` column refers to product_labels.
            #
            # The `image-id` column is optional but must be unique if provided. If it is
            # empty, the system will automatically assign a unique id to the image.
            #
            # The `product-display-name` column is optional. If it is empty, the system
            # sets the display_name field for the product to a
            # space (" "). You can update the `display_name` later by using the API.
            #
            # If a `Product` with the specified `product-id` already exists, then the
            # system ignores the `product-display-name`, `product-category`, and `labels`
            # columns.
            #
            # The `labels` column (optional) is a line containing a list of
            # comma-separated key-value pairs, in the following format:
            #
            #     "key_1=value_1,key_2=value_2,...,key_n=value_n"
            #
            # The `bounding-poly` column (optional) identifies one region of
            # interest from the image in the same manner as `CreateReferenceImage`. If
            # you do not specify the `bounding-poly` column, then the system will try to
            # detect regions of interest automatically.
            #
            # At most one `bounding-poly` column is allowed per line. If the image
            # contains multiple regions of interest, add a line to the CSV file that
            # includes the same product information, and the `bounding-poly` values for
            # each region of interest.
            #
            # The `bounding-poly` column must contain an even number of comma-separated
            # numbers, in the format "p1_x,p1_y,p2_x,p2_y,...,pn_x,pn_y". Use
            # non-negative integers for absolute bounding polygons, and float values
            # in [0, 1] for normalized bounding polygons.
            #
            # The system will resize the image if the image resolution is too
            # large to process (larger than 20MP).
      },
    },
  }

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a
      # network API call.
    "response": { # The normal response of the operation in case of success.  If the original
        # method returns no data on success, such as `Delete`, the response is
        # `google.protobuf.Empty`.  If the original method is standard
        # `Get`/`Create`/`Update`, the response should be the resource.  For other
        # methods, the response should have the type `XxxResponse`, where `Xxx`
        # is the original method name.  For example, if the original method name
        # is `TakeSnapshot()`, the inferred response type is
        # `TakeSnapshotResponse`.
      "a_key": "", # Properties of the object. Contains field @type with type URL.
    },
    "metadata": { # Service-specific metadata associated with the operation.  It typically
        # contains progress information and common metadata such as create time.
        # Some services might not provide such metadata.  Any method that returns a
        # long-running operation should document the metadata type, if any.
      "a_key": "", # Properties of the object. Contains field @type with type URL.
    },
    "done": True or False, # If the value is `false`, it means the operation is still in progress.
        # If `true`, the operation is completed, and either `error` or `response` is
        # available.
    "name": "A String", # The server-assigned name, which is only unique within the same service that
        # originally returns it. If you use the default HTTP mapping, the
        # `name` should be a resource name ending with `operations/{unique_id}`.
    "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.
        # different programming environments, including REST APIs and RPC APIs. It is
        # used by [gRPC](https://github.com/grpc). Each `Status` message contains
        # three pieces of data: error code, error message, and error details.
        #
        # You can find out more about this error model and how to work with it in the
        # [API Design Guide](https://cloud.google.com/apis/design/errors).
      "message": "A String", # A developer-facing error message, which should be in English. Any
          # user-facing error message should be localized and sent in the
          # google.rpc.Status.details field, or localized by the client.
      "code": 42, # The status code, which should be an enum value of google.rpc.Code.
      "details": [ # A list of messages that carry the error details.  There is a common set of
          # message types for APIs to use.
        {
          "a_key": "", # Properties of the object. Contains field @type with type URL.
        },
      ],
    },
  }</pre>
</div>

<div class="method">
    <code class="details" id="list">list(parent, pageToken=None, x__xgafv=None, pageSize=None)</code>
  <pre>Lists ProductSets in an unspecified order.

Possible errors:

* Returns INVALID_ARGUMENT if page_size is greater than 100, or less
  than 1.

Args:
  parent: string, The project from which ProductSets should be listed.

Format is `projects/PROJECT_ID/locations/LOC_ID`. (required)
  pageToken: string, The next_page_token returned from a previous List request, if any.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format
  pageSize: integer, The maximum number of items to return. Default 10, maximum 100.

Returns:
  An object of the form:

    { # Response message for the `ListProductSets` method.
    "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more
        # results in the list.
    "productSets": [ # List of ProductSets.
      { # A ProductSet contains Products. A ProductSet can contain a maximum of 1
          # million reference images. If the limit is exceeded, periodic indexing will
          # fail.
        "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
            # is populated.
            #
            # This field is ignored when creating a ProductSet.
            # different programming environments, including REST APIs and RPC APIs. It is
            # used by [gRPC](https://github.com/grpc). Each `Status` message contains
            # three pieces of data: error code, error message, and error details.
            #
            # You can find out more about this error model and how to work with it in the
            # [API Design Guide](https://cloud.google.com/apis/design/errors).
          "message": "A String", # A developer-facing error message, which should be in English. Any
              # user-facing error message should be localized and sent in the
              # google.rpc.Status.details field, or localized by the client.
          "code": 42, # The status code, which should be an enum value of google.rpc.Code.
          "details": [ # A list of messages that carry the error details.  There is a common set of
              # message types for APIs to use.
            {
              "a_key": "", # Properties of the object. Contains field @type with type URL.
            },
          ],
        },
        "displayName": "A String", # The user-provided name for this ProductSet. Must not be empty. Must be at
            # most 4096 characters long.
        "name": "A String", # The resource name of the ProductSet.
            #
            # Format is:
            # `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`.
            #
            # This field is ignored when creating a ProductSet.
        "indexTime": "A String", # Output only. The time at which this ProductSet was last indexed. Query
            # results will reflect all updates before this time. If this ProductSet has
            # never been indexed, this timestamp is the default value
            # "1970-01-01T00:00:00Z".
            #
            # This field is ignored when creating a ProductSet.
      },
    ],
  }</pre>
</div>

<div class="method">
    <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
  <pre>Retrieves the next page of results.

Args:
  previous_request: The request for the previous page. (required)
  previous_response: The response from the request for the previous page. (required)

Returns:
  A request object that you can call 'execute()' on to request the next
  page. Returns None if there are no more items in the collection.
    </pre>
</div>

<div class="method">
    <code class="details" id="patch">patch(name, body, updateMask=None, x__xgafv=None)</code>
  <pre>Makes changes to a ProductSet resource.
Only display_name can be updated currently.

Possible errors:

* Returns NOT_FOUND if the ProductSet does not exist.
* Returns INVALID_ARGUMENT if display_name is present in update_mask but
  missing from the request or longer than 4096 characters.

Args:
  name: string, The resource name of the ProductSet.

Format is:
`projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`.

This field is ignored when creating a ProductSet. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # A ProductSet contains Products. A ProductSet can contain a maximum of 1
    # million reference images. If the limit is exceeded, periodic indexing will
    # fail.
  "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
      # is populated.
      # 
      # This field is ignored when creating a ProductSet.
      # different programming environments, including REST APIs and RPC APIs. It is
      # used by [gRPC](https://github.com/grpc). Each `Status` message contains
      # three pieces of data: error code, error message, and error details.
      #
      # You can find out more about this error model and how to work with it in the
      # [API Design Guide](https://cloud.google.com/apis/design/errors).
    "message": "A String", # A developer-facing error message, which should be in English. Any
        # user-facing error message should be localized and sent in the
        # google.rpc.Status.details field, or localized by the client.
    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
    "details": [ # A list of messages that carry the error details.  There is a common set of
        # message types for APIs to use.
      {
        "a_key": "", # Properties of the object. Contains field @type with type URL.
      },
    ],
  },
  "displayName": "A String", # The user-provided name for this ProductSet. Must not be empty. Must be at
      # most 4096 characters long.
  "name": "A String", # The resource name of the ProductSet.
      # 
      # Format is:
      # `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`.
      # 
      # This field is ignored when creating a ProductSet.
  "indexTime": "A String", # Output only. The time at which this ProductSet was last indexed. Query
      # results will reflect all updates before this time. If this ProductSet has
      # never been indexed, this timestamp is the default value
      # "1970-01-01T00:00:00Z".
      # 
      # This field is ignored when creating a ProductSet.
}

  updateMask: string, The FieldMask that specifies which fields to
update.
If update_mask isn't specified, all mutable fields are to be updated.
Valid mask path is `display_name`.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A ProductSet contains Products. A ProductSet can contain a maximum of 1
      # million reference images. If the limit is exceeded, periodic indexing will
      # fail.
    "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
        # is populated.
        #
        # This field is ignored when creating a ProductSet.
        # different programming environments, including REST APIs and RPC APIs. It is
        # used by [gRPC](https://github.com/grpc). Each `Status` message contains
        # three pieces of data: error code, error message, and error details.
        #
        # You can find out more about this error model and how to work with it in the
        # [API Design Guide](https://cloud.google.com/apis/design/errors).
      "message": "A String", # A developer-facing error message, which should be in English. Any
          # user-facing error message should be localized and sent in the
          # google.rpc.Status.details field, or localized by the client.
      "code": 42, # The status code, which should be an enum value of google.rpc.Code.
      "details": [ # A list of messages that carry the error details.  There is a common set of
          # message types for APIs to use.
        {
          "a_key": "", # Properties of the object. Contains field @type with type URL.
        },
      ],
    },
    "displayName": "A String", # The user-provided name for this ProductSet. Must not be empty. Must be at
        # most 4096 characters long.
    "name": "A String", # The resource name of the ProductSet.
        #
        # Format is:
        # `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`.
        #
        # This field is ignored when creating a ProductSet.
    "indexTime": "A String", # Output only. The time at which this ProductSet was last indexed. Query
        # results will reflect all updates before this time. If this ProductSet has
        # never been indexed, this timestamp is the default value
        # "1970-01-01T00:00:00Z".
        #
        # This field is ignored when creating a ProductSet.
  }</pre>
</div>

<div class="method">
    <code class="details" id="removeProduct">removeProduct(name, body, x__xgafv=None)</code>
  <pre>Removes a Product from the specified ProductSet.

Args:
  name: string, The resource name for the ProductSet to modify.

Format is:
`projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID` (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Request message for the `RemoveProductFromProductSet` method.
    "product": "A String", # The resource name for the Product to be removed from this ProductSet.
        # 
        # Format is:
        # `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`
  }

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated
      # empty messages in your APIs. A typical example is to use it as the request
      # or the response type of an API method. For instance:
      #
      #     service Foo {
      #       rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
      #     }
      #
      # The JSON representation for `Empty` is empty JSON object `{}`.
  }</pre>
</div>

</body></html>