REST Resource: projects.locations.brands.evaluationContexts

Resource: EvaluationContext

An evaluation context for an evaluation suite or case.

JSON representation 
{
  "name": string,
  "displayName": string,
  "description": string,
  "store": string,
  "menu": string,
  "testSessionStartTime": string,
  "mockClientExecutions": [
    {
      object (MockClientExecution)
    }
  ],
  "daypartId": string
}
Fields
name

string

Identifier. The full resource name of the evaluation context. Format: projects/{project}/locations/{location}/brands/{brand}/evaluationContexts/{evaluationContext}
displayName

string

Required. The human-readable name of the evaluation context.
description

string

Optional. The description of the evaluation context.
store

string

Required. The full resource name of the store to use for the evaluation case. Format: projects/{projectId}/locations/{location}/brands/{brandId}/stores/{storeId}
menu

string

Optional. Optional menu to use for the evaluation context. If not provided, it will use the default menu for the store. Format: projects/{projectId}/locations/{location}/brands/{brandId}/menus/{menuId}
testSessionStartTime

string (Timestamp format)

Optional. Optional injected start time of the Food Ordering session. If set, the evaluation session will assume the test session started at this time. This is for simulating ordering behavior at a specific time of day. If not set, the evaluation session will use the current time as the start time.

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".
mockClientExecutions[]

object (MockClientExecution)

Optional. Optional mocked client execution responses for client execution requests sent by the food ordering service during the evaluation session.
daypartId

string

Optional. Optional daypart ID to use for the evaluation context. If provided, the agent will use this daypart ID when establishing the process order configuration.

MockClientExecution

Represents a mocked client execution request and response pair. If the requests sent by the food ordering service in an eval run matches the mock request, the mock response will be returned to the service. Note the request.execution_id will be ignored during matching since it's session specific.

JSON representation 
{
  "rawJsonRequest": {
    object
  },
  "rawJsonResponse": {
    object
  }
}
Fields
rawJsonRequest

object (Struct format)

Optional. The request for the mock client execution.
rawJsonResponse

object (Struct format)

Optional. The response for the mock client execution.

Methods

create

 Creates an EvaluationContext.

delete

 Deletes the specified EvaluationContext.

get

 Gets an EvaluationContext.

list

 Lists EvaluationContexts.

patch

 Updates the specified EvaluationContext.