REST Resource: projects.locations.brands.remediations

Resource: Remediation

Represents a persistent remediation applied to a brand.

JSON representation
{
  "name": string,
  "targetEntityId": string,
  "targetEntityType": enum (EntityType),
  "remediationAction": {
    object (RemediationAction)
  },
  "state": enum (State),
  "targetStores": [
    string
  ],
  "createTime": string,
  "updateTime": string
}
Fields
name

string

Identifier. The resource name. Format: projects/{project}/locations/{location}/brands/{brand}/remediations/{remediation}

targetEntityId

string

Required. The ID of the menu entity this remediation targets.

targetEntityType

enum (EntityType)

Required. The type of the menu entity this remediation targets.

remediationAction

object (RemediationAction)

Required. The underlying remediation action to be executed during ingestion.

state

enum (State)

Output only. The current state of this remediation.

targetStores[]

string

Optional. If empty, this remediation applies to all stores within the brand. If populated, it only applies to the specific stores listed here.

createTime

string (Timestamp format)

Output only. The time this remediation was created.

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

updateTime

string (Timestamp format)

Output only. The time this remediation was last updated.

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

The lifecycle state of the remediation.

Enums
STATE_UNSPECIFIED Unspecified state.
ACTIVE The remediation is actively being applied during ingestion.
SUSPENDED The remediation is temporarily suspended.

Methods

create

Creates a remediation.

delete

Deletes a remediation.

get

Gets a remediation.

list

Lists remediations.

resume

Resumes a suspended remediation.

suspend

Suspends a remediation.