REST Resource: projects.locations.brands.ingestionLogs

Resource: IngestionLog

A record of a menu ingestion run.

JSON representation
{
  "name": string,
  "store": string,
  "state": enum (State),
  "startTime": string,
  "endTime": string,
  "phases": [
    {
      object (IngestionPhase)
    }
  ]
}
Fields
name

string

Identifier. The resource name of the ingestion log. Format: projects/{project}/locations/{location}/brands/{brand}/ingestionLogs/{ingestionLog}

store

string

Optional. The resource name of the store for the ingestion. Format: projects/{project}/locations/{location}/brands/{brand}/stores/{store}

state

enum (State)

Output only. Data about the current state of the ingestion.

startTime

string (Timestamp format)

Output only. The time when ingestion job started.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".

endTime

string (Timestamp format)

Output only. The time when ingestion job finished.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".

phases[]

object (IngestionPhase)

Output only. List of phase runtimes.

State

The status of the ingestion run.

Enums
STATE_UNSPECIFIED The status is unspecified.
SUCCEEDED The ingestion was successful.
FAILED The ingestion failed.
PROCESSING The ingestion is being processed.

IngestionPhase

A phase of the ingestion run.

JSON representation
{
  "phase": enum (Phase),
  "startTime": string,
  "endTime": string,
  "state": enum (State),
  "details": string
}
Fields
phase

enum (Phase)

Required. Name of the phase.

startTime

string (Timestamp format)

Optional. Start time of the phase.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".

endTime

string (Timestamp format)

Optional. End time of the phase.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".

state

enum (State)

Optional. State of the phase. Set by the caller on append, so it's an input, not a resource state.

details

string

Optional. Details about the phase.

Phase

Enum for the name of the phase.

Enums
PHASE_UNSPECIFIED The phase is unspecified.
READ_SOURCE_MENU Reading the source menu.
PARSE_SOURCE_MENU Parsing the source menu.
BRAND_SPECIFIC_VALIDATION Validating the brand specific configuration.
BRAND_AGNOSTIC_VALIDATION Validating the brand agnostic configuration.
CREATE_MENU Creating the menu.

State

The execution state of the phase.

Enums
STATE_UNSPECIFIED The state is unspecified.
SUCCEEDED The phase completed successfully.
FAILED The phase failed.

Methods

appendIngestionPhase

Appends an ingestion phase to an ingestion log.

create

Creates an ingestion log.

delete

Deletes the specified ingestion log.

get

Gets an ingestion log.

list

Lists ingestion logs.