REST Resource: projects.locations.productSets

Resource: ProductSet

A ProductSet contains Products. A ProductSet can contain a maximum of 1 million reference images. If the limit is exceeded, periodic indexing will fail.

JSON representation
{
  "name": string,
  "displayName": string,
  "indexTime": string,
  "indexError": {
    object (Status)
  }
}
Fields
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.

displayName

string

The user-provided name for this ProductSet. Must not be empty. Must be at most 4096 characters long.

indexTime

string (Timestamp format)

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.

A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".

indexError

object (Status)

Output only. If there was an error with indexing the product set, the field is populated.

This field is ignored when creating a ProductSet.

Status

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. 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.

JSON representation
{
  "code": number,
  "message": string,
  "details": [
    {
      "@type": string,
      field1: ...,
      ...
    }
  ]
}
Fields
code

number

The status code, which should be an enum value of google.rpc.Code.

message

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.

details[]

object

A list of messages that carry the error details. There is a common set of message types for APIs to use.

An object containing fields of an arbitrary type. An additional field "@type" contains a URI identifying the type. Example: { "id": 1234, "@type": "types.example.com/standard/id" }.

Methods

addProduct

Adds a Product to the specified ProductSet.

create

Creates and returns a new ProductSet resource.

delete

Permanently deletes a ProductSet.

get

Gets information associated with a ProductSet.

import

Asynchronous API that imports a list of reference images to specified product sets based on a list of image information.

list

Lists ProductSets in an unspecified order.

patch

Makes changes to a ProductSet resource.

removeProduct

Removes a Product from the specified ProductSet.