Type Alias ExecutionResponse

type ExecutionResponse = {
    blocked?: boolean;
    blockedEventTime?: string;
    capacityLimit?: number;
    closeToOverage?: boolean;
    consumptionReportId?: string;
    customerFacing?: boolean;
    enforcement?: Enforcement[];
    globalUsage?: number;
    guardrailLimit?: number;
    localUsage?: number;
    overage?: boolean;
    overageEventTime?: string;
    periodEnd?: string;
    periodStart?: string;
    periodType?: "day" | "month" | "year" | "" | "fixed" | "minute";
    resourceAction?:
        | "report.generated"
        | "reload"
        | "scheduledReload"
        | "executed"
        | "aggregation"
        | "import"
        | "updated"
        | "deployed"
        | "3rd_party_executed"
        | "standard_executed";
    resourceId?: string;
    resourceType?: "app"
    | "automations"
    | "space"
    | "data.volume.consumption";
    scope?: (
        "user"
        | "tenant"
        | "resourceId"
        | "resourceType"
        | "resourceAction"
    )[];
    scopeMapping?: string;
    segments?: Record<string, unknown>[];
    taskDescription?: string;
    taskName?: string;
    tenantId?: string;
    unit?: string;
    updateTime?: string;
    userId?: string;
}
Index

Properties

blocked? blockedEventTime? capacityLimit? closeToOverage? consumptionReportId? customerFacing? enforcement? globalUsage? guardrailLimit? localUsage? overage? overageEventTime? periodEnd? periodStart? periodType? resourceAction? resourceId? resourceType? scope? scopeMapping? segments? taskDescription? taskName? tenantId? unit? updateTime? userId?

Properties

blocked?: boolean
blockedEventTime?: string

RFC3339 timestamp when a block event was last emitted for this execution.

capacityLimit?: number

The capacity limit.

closeToOverage?: boolean
consumptionReportId?: string

The id of the consumption report

customerFacing?: boolean

The field to determine if a resource should be visible on the client.

enforcement?: Enforcement[]

Contains a list of resources that are blocked when quota for this is reached.

globalUsage?: number

The global usage.

guardrailLimit?: number

The guardrail limit.

localUsage?: number

The local usage.

overage?: boolean
overageEventTime?: string

RFC3339 timestamp when a overage event was last emitted for this execution.

periodEnd?: string

The end of the associated period.

periodStart?: string

The start of the associated period.

periodType?: "day" | "month" | "year" | "" | "fixed" | "minute"
resourceAction?:
    | "report.generated"
    | "reload"
    | "scheduledReload"
    | "executed"
    | "aggregation"
    | "import"
    | "updated"
    | "deployed"
    | "3rd_party_executed"
    | "standard_executed"

The resource action.

resourceId?: string

The resource id.

resourceType?: "app" | "automations" | "space" | "data.volume.consumption"

The resource type.

scope?: ("user" | "tenant" | "resourceId" | "resourceType" | "resourceAction")[]
scopeMapping?: string

The map to the resource scope.

segments?: Record<string, unknown>[]
taskDescription?: string

The resource task description.

taskName?: string

The resource task name.

tenantId?: string

The tenant id.

unit?: string

Unit of measurement for the resource consumption

updateTime?: string

The RFC3339 timestamp when the resource was updated.

userId?: string

The user id.

Settings

Member Visibility

On This Page

Properties