REST Resource: projects.datasets

Resource: DataSet

A collection of data sources sent for processing.

JSON representation 
{
  "name": string,
  "dataNames": [
    string
  ],
  "dataSources": [
    {
      object (DataSource)
    }
  ],
  "state": enum (State),
  "status": {
    object (Status)
  },
  "ttl": string
}
Fields
name

string

The dataset name, which will be used for querying, status and unload requests. This must be unique within a project.
dataNames[]

string

Optional. Data dimension names allowed for this DataSet.

If left empty, all dimension names are included. This field works as a filter to avoid regenerating the data.
dataSources[]

object (DataSource)

Input data.
state

enum (State)

Dataset state in the system.
status

object (Status)

Dataset processing status.
ttl

string (Duration format)

Optional. Periodically we discard dataset Event that have timestamps older than 'ttl'. Omitting this field or a zero value means no events are discarded.

A duration in seconds with up to nine fractional digits, terminated by 's'. Example: "3.5s".

DataSource

A data source consists of multiple Event stored on Cloud Storage. Each Event should be in JSON format, with one Event per line, also known as JSON Lines format.

JSON representation 
{
  "uri": string
}
Fields
uri

string

Data source URI.

Currently only support Cloud Storage URI in the following form: gs://bucket_name/object_name. For more information on Cloud Storage URIs, please see https://cloud.google.com/storage/docs/reference-uris.

State

DataSet state.

Enums
STATE_UNSPECIFIED Unspecified / undefined state.
UNKNOWN Dataset is unknown to the system; we have never seen this dataset before or we have seen this dataset but have fully GC-ed it.
PENDING Dataset processing is pending.
LOADING Dataset is loading.
LOADED Dataset is loaded and can be queried.
UNLOADING Dataset is unloading.
UNLOADED Dataset is unloaded and is removed from the system.
FAILED Dataset processing failed.

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": integer,
  "message": string,
  "details": [
    {
      "@type": string,
      field1: ...,
      ...
    }
  ]
}
Fields
code

integer

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

appendEvents

 Append events to a LOADED DataSet.

create

 Create a DataSet from data stored on Cloud Storage.

delete

 Delete a DataSet from the system.

list

 Lists datasets.

query

 Execute an Inference query over a LOADED dataset.