• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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=None, x__xgafv=None)</a></code></p>
84<p class="firstline">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.</p>
85<p class="toc_element">
86  <code><a href="#close">close()</a></code></p>
87<p class="firstline">Close httplib2 connections.</p>
88<p class="toc_element">
89  <code><a href="#create">create(parent, body=None, productSetId=None, x__xgafv=None)</a></code></p>
90<p class="firstline">Creates and returns a new ProductSet resource. Possible errors: * Returns INVALID_ARGUMENT if display_name is missing, or is longer than 4096 characters.</p>
91<p class="toc_element">
92  <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
93<p class="firstline">Permanently deletes a ProductSet. Products and ReferenceImages in the ProductSet are not deleted. The actual image files are not deleted from Google Cloud Storage.</p>
94<p class="toc_element">
95  <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
96<p class="firstline">Gets information associated with a ProductSet. Possible errors: * Returns NOT_FOUND if the ProductSet does not exist.</p>
97<p class="toc_element">
98  <code><a href="#import_">import_(parent, body=None, x__xgafv=None)</a></code></p>
99<p class="firstline">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.</p>
100<p class="toc_element">
101  <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
102<p class="firstline">Lists ProductSets in an unspecified order. Possible errors: * Returns INVALID_ARGUMENT if page_size is greater than 100, or less than 1.</p>
103<p class="toc_element">
104  <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
105<p class="firstline">Retrieves the next page of results.</p>
106<p class="toc_element">
107  <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
108<p class="firstline">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.</p>
109<p class="toc_element">
110  <code><a href="#removeProduct">removeProduct(name, body=None, x__xgafv=None)</a></code></p>
111<p class="firstline">Removes a Product from the specified ProductSet.</p>
112<h3>Method Details</h3>
113<div class="method">
114    <code class="details" id="addProduct">addProduct(name, body=None, x__xgafv=None)</code>
115  <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&#x27;t exist.
116
117Args:
118  name: string, Required. The resource name for the ProductSet to modify. Format is: `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID` (required)
119  body: object, The request body.
120    The object takes the form of:
121
122{ # Request message for the `AddProductToProductSet` method.
123  &quot;product&quot;: &quot;A String&quot;, # Required. The resource name for the Product to be added to this ProductSet. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`
124}
125
126  x__xgafv: string, V1 error format.
127    Allowed values
128      1 - v1 error format
129      2 - v2 error format
130
131Returns:
132  An object of the form:
133
134    { # 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 `{}`.
135}</pre>
136</div>
137
138<div class="method">
139    <code class="details" id="close">close()</code>
140  <pre>Close httplib2 connections.</pre>
141</div>
142
143<div class="method">
144    <code class="details" id="create">create(parent, body=None, productSetId=None, x__xgafv=None)</code>
145  <pre>Creates and returns a new ProductSet resource. Possible errors: * Returns INVALID_ARGUMENT if display_name is missing, or is longer than 4096 characters.
146
147Args:
148  parent: string, Required. The project in which the ProductSet should be created. Format is `projects/PROJECT_ID/locations/LOC_ID`. (required)
149  body: object, The request body.
150    The object takes the form of:
151
152{ # A ProductSet contains Products. A ProductSet can contain a maximum of 1 million reference images. If the limit is exceeded, periodic indexing will fail.
153  &quot;displayName&quot;: &quot;A String&quot;, # The user-provided name for this ProductSet. Must not be empty. Must be at most 4096 characters long.
154  &quot;indexError&quot;: { # The `Status` type defines a logical error model that is suitable for 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). # Output only. If there was an error with indexing the product set, the field is populated. This field is ignored when creating a ProductSet.
155    &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
156    &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
157      {
158        &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
159      },
160    ],
161    &quot;message&quot;: &quot;A String&quot;, # 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.
162  },
163  &quot;indexTime&quot;: &quot;A String&quot;, # 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 &quot;1970-01-01T00:00:00Z&quot;. This field is ignored when creating a ProductSet.
164  &quot;name&quot;: &quot;A String&quot;, # 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.
165}
166
167  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 `/`.
168  x__xgafv: string, V1 error format.
169    Allowed values
170      1 - v1 error format
171      2 - v2 error format
172
173Returns:
174  An object of the form:
175
176    { # A ProductSet contains Products. A ProductSet can contain a maximum of 1 million reference images. If the limit is exceeded, periodic indexing will fail.
177  &quot;displayName&quot;: &quot;A String&quot;, # The user-provided name for this ProductSet. Must not be empty. Must be at most 4096 characters long.
178  &quot;indexError&quot;: { # The `Status` type defines a logical error model that is suitable for 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). # Output only. If there was an error with indexing the product set, the field is populated. This field is ignored when creating a ProductSet.
179    &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
180    &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
181      {
182        &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
183      },
184    ],
185    &quot;message&quot;: &quot;A String&quot;, # 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.
186  },
187  &quot;indexTime&quot;: &quot;A String&quot;, # 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 &quot;1970-01-01T00:00:00Z&quot;. This field is ignored when creating a ProductSet.
188  &quot;name&quot;: &quot;A String&quot;, # 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.
189}</pre>
190</div>
191
192<div class="method">
193    <code class="details" id="delete">delete(name, x__xgafv=None)</code>
194  <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.
195
196Args:
197  name: string, Required. Resource name of the ProductSet to delete. Format is: `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID` (required)
198  x__xgafv: string, V1 error format.
199    Allowed values
200      1 - v1 error format
201      2 - v2 error format
202
203Returns:
204  An object of the form:
205
206    { # 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 `{}`.
207}</pre>
208</div>
209
210<div class="method">
211    <code class="details" id="get">get(name, x__xgafv=None)</code>
212  <pre>Gets information associated with a ProductSet. Possible errors: * Returns NOT_FOUND if the ProductSet does not exist.
213
214Args:
215  name: string, Required. Resource name of the ProductSet to get. Format is: `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID` (required)
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 million reference images. If the limit is exceeded, periodic indexing will fail.
225  &quot;displayName&quot;: &quot;A String&quot;, # The user-provided name for this ProductSet. Must not be empty. Must be at most 4096 characters long.
226  &quot;indexError&quot;: { # The `Status` type defines a logical error model that is suitable for 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). # Output only. If there was an error with indexing the product set, the field is populated. This field is ignored when creating a ProductSet.
227    &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
228    &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
229      {
230        &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
231      },
232    ],
233    &quot;message&quot;: &quot;A String&quot;, # 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.
234  },
235  &quot;indexTime&quot;: &quot;A String&quot;, # 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 &quot;1970-01-01T00:00:00Z&quot;. This field is ignored when creating a ProductSet.
236  &quot;name&quot;: &quot;A String&quot;, # 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.
237}</pre>
238</div>
239
240<div class="method">
241    <code class="details" id="import_">import_(parent, body=None, x__xgafv=None)</code>
242  <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.
243
244Args:
245  parent: string, Required. The project in which the ProductSets should be imported. Format is `projects/PROJECT_ID/locations/LOC_ID`. (required)
246  body: object, The request body.
247    The object takes the form of:
248
249{ # Request message for the `ImportProductSets` method.
250  &quot;inputConfig&quot;: { # The input content for the `ImportProductSets` method. # Required. The input content for the list of requests.
251    &quot;gcsSource&quot;: { # The Google Cloud Storage location for a csv file which preserves a list of ImportProductSetRequests in each line. # The Google Cloud Storage location for a csv file which preserves a list of ImportProductSetRequests in each line.
252      &quot;csvFileUri&quot;: &quot;A String&quot;, # 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 (&quot; &quot;). 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: &quot;key_1=value_1,key_2=value_2,...,key_n=value_n&quot; 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 &quot;p1_x,p1_y,p2_x,p2_y,...,pn_x,pn_y&quot;. 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).
253    },
254  },
255}
256
257  x__xgafv: string, V1 error format.
258    Allowed values
259      1 - v1 error format
260      2 - v2 error format
261
262Returns:
263  An object of the form:
264
265    { # This resource represents a long-running operation that is the result of a network API call.
266  &quot;done&quot;: 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.
267  &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for 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). # The error result of the operation in case of failure or cancellation.
268    &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
269    &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
270      {
271        &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
272      },
273    ],
274    &quot;message&quot;: &quot;A String&quot;, # 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.
275  },
276  &quot;metadata&quot;: { # 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.
277    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
278  },
279  &quot;name&quot;: &quot;A String&quot;, # 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}`.
280  &quot;response&quot;: { # 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`.
281    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
282  },
283}</pre>
284</div>
285
286<div class="method">
287    <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
288  <pre>Lists ProductSets in an unspecified order. Possible errors: * Returns INVALID_ARGUMENT if page_size is greater than 100, or less than 1.
289
290Args:
291  parent: string, Required. The project from which ProductSets should be listed. Format is `projects/PROJECT_ID/locations/LOC_ID`. (required)
292  pageSize: integer, The maximum number of items to return. Default 10, maximum 100.
293  pageToken: string, The next_page_token returned from a previous List request, if any.
294  x__xgafv: string, V1 error format.
295    Allowed values
296      1 - v1 error format
297      2 - v2 error format
298
299Returns:
300  An object of the form:
301
302    { # Response message for the `ListProductSets` method.
303  &quot;nextPageToken&quot;: &quot;A String&quot;, # Token to retrieve the next page of results, or empty if there are no more results in the list.
304  &quot;productSets&quot;: [ # List of ProductSets.
305    { # A ProductSet contains Products. A ProductSet can contain a maximum of 1 million reference images. If the limit is exceeded, periodic indexing will fail.
306      &quot;displayName&quot;: &quot;A String&quot;, # The user-provided name for this ProductSet. Must not be empty. Must be at most 4096 characters long.
307      &quot;indexError&quot;: { # The `Status` type defines a logical error model that is suitable for 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). # Output only. If there was an error with indexing the product set, the field is populated. This field is ignored when creating a ProductSet.
308        &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
309        &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
310          {
311            &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
312          },
313        ],
314        &quot;message&quot;: &quot;A String&quot;, # 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.
315      },
316      &quot;indexTime&quot;: &quot;A String&quot;, # 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 &quot;1970-01-01T00:00:00Z&quot;. This field is ignored when creating a ProductSet.
317      &quot;name&quot;: &quot;A String&quot;, # 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.
318    },
319  ],
320}</pre>
321</div>
322
323<div class="method">
324    <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
325  <pre>Retrieves the next page of results.
326
327Args:
328  previous_request: The request for the previous page. (required)
329  previous_response: The response from the request for the previous page. (required)
330
331Returns:
332  A request object that you can call &#x27;execute()&#x27; on to request the next
333  page. Returns None if there are no more items in the collection.
334    </pre>
335</div>
336
337<div class="method">
338    <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
339  <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.
340
341Args:
342  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)
343  body: object, The request body.
344    The object takes the form of:
345
346{ # A ProductSet contains Products. A ProductSet can contain a maximum of 1 million reference images. If the limit is exceeded, periodic indexing will fail.
347  &quot;displayName&quot;: &quot;A String&quot;, # The user-provided name for this ProductSet. Must not be empty. Must be at most 4096 characters long.
348  &quot;indexError&quot;: { # The `Status` type defines a logical error model that is suitable for 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). # Output only. If there was an error with indexing the product set, the field is populated. This field is ignored when creating a ProductSet.
349    &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
350    &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
351      {
352        &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
353      },
354    ],
355    &quot;message&quot;: &quot;A String&quot;, # 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.
356  },
357  &quot;indexTime&quot;: &quot;A String&quot;, # 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 &quot;1970-01-01T00:00:00Z&quot;. This field is ignored when creating a ProductSet.
358  &quot;name&quot;: &quot;A String&quot;, # 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.
359}
360
361  updateMask: string, The FieldMask that specifies which fields to update. If update_mask isn&#x27;t specified, all mutable fields are to be updated. Valid mask path is `display_name`.
362  x__xgafv: string, V1 error format.
363    Allowed values
364      1 - v1 error format
365      2 - v2 error format
366
367Returns:
368  An object of the form:
369
370    { # A ProductSet contains Products. A ProductSet can contain a maximum of 1 million reference images. If the limit is exceeded, periodic indexing will fail.
371  &quot;displayName&quot;: &quot;A String&quot;, # The user-provided name for this ProductSet. Must not be empty. Must be at most 4096 characters long.
372  &quot;indexError&quot;: { # The `Status` type defines a logical error model that is suitable for 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). # Output only. If there was an error with indexing the product set, the field is populated. This field is ignored when creating a ProductSet.
373    &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
374    &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
375      {
376        &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
377      },
378    ],
379    &quot;message&quot;: &quot;A String&quot;, # 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.
380  },
381  &quot;indexTime&quot;: &quot;A String&quot;, # 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 &quot;1970-01-01T00:00:00Z&quot;. This field is ignored when creating a ProductSet.
382  &quot;name&quot;: &quot;A String&quot;, # 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.
383}</pre>
384</div>
385
386<div class="method">
387    <code class="details" id="removeProduct">removeProduct(name, body=None, x__xgafv=None)</code>
388  <pre>Removes a Product from the specified ProductSet.
389
390Args:
391  name: string, Required. The resource name for the ProductSet to modify. Format is: `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID` (required)
392  body: object, The request body.
393    The object takes the form of:
394
395{ # Request message for the `RemoveProductFromProductSet` method.
396  &quot;product&quot;: &quot;A String&quot;, # Required. The resource name for the Product to be removed from this ProductSet. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`
397}
398
399  x__xgafv: string, V1 error format.
400    Allowed values
401      1 - v1 error format
402      2 - v2 error format
403
404Returns:
405  An object of the form:
406
407    { # 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 `{}`.
408}</pre>
409</div>
410
411</body></html>