LegacyPlaybookTemplateWidgetDefinition

LegacyPlaybookTemplateWidgetDefinition represents a widget definition in a template.

JSON representation
{
  "metadata": {
    object (LegacyPlaybookTemplateWidgetMetadata)
  },
  "config": {
    object
  }
}
Fields
metadata

object (LegacyPlaybookTemplateWidgetMetadata)

Required. Metadata is the metadata of the widget.

config

object (Struct format)

Optional. Config is the configuration of the widget as a JSON string.

LegacyPlaybookTemplateWidgetMetadata

LegacyPlaybookTemplateWidgetMetadata represents metadata for a widget in a template.

JSON representation
{
  "id": string,
  "identifier": string,
  "title": string,
  "width": enum (WidgetTemplateGridColumnsEnum),
  "order": integer,
  "description": string,
  "type": enum (WidgetTemplateTypeEnum),
  "templateIdentifier": string,
  "predefinedWidgetTemplateIdentifier": string,
  "actionIdentifier": string,
  "stepIdentifier": string,
  "stepIntegration": string,
  "blockStepIdentifier": string,
  "blockStepInstanceName": string,
  "conditionsGroup": {
    object (LegacyPlaybookConditionsGroup)
  },
  "integrationName": string,
  "presentIfEmpty": boolean,
  "isSupported": boolean
}
Fields
id

string (int64 format)

Required. Id is the unique identifier of the widget.

identifier

string

Required. Identifier is the unique identifier of the widget.

title

string

Required. Title is the title of the widget.

width

enum (WidgetTemplateGridColumnsEnum)

Required. Width is the width of the widget.

order

integer

Required. Order is the order of the widget.

description

string

Optional. Description is the description of the widget.

type

enum (WidgetTemplateTypeEnum)

Required. Type is the type of the widget.

templateIdentifier

string

Optional. TemplateIdentifier is the identifier of the template.

predefinedWidgetTemplateIdentifier

string

Optional. PredefinedWidgetTemplateIdentifier is the identifier of the predefined widget template.

actionIdentifier

string

Optional. ActionIdentifier is the identifier of the action.

stepIdentifier

string

Optional. StepIdentifier is the identifier of the step.

stepIntegration

string

Optional. StepIntegration is the integration of the step.

blockStepIdentifier

string

Optional. BlockStepIdentifier is the identifier of the block step.

blockStepInstanceName

string

Optional. BlockStepInstanceName is the name of the block step instance.

conditionsGroup

object (LegacyPlaybookConditionsGroup)

Optional. ConditionsGroup is the conditions group for the widget.

integrationName

string

Optional. IntegrationName is the name of the integration.

presentIfEmpty

boolean

Optional. PresentIfEmpty indicates if the widget should be present if empty.

isSupported

boolean

Optional. IsSupported indicates if the widget is supported.

WidgetTemplateGridColumnsEnum

WidgetTemplateGridColumnsEnum represents the grid columns of a widget template.

Enums
TEMPLATE_WIDGET_WIDTH_UNSPECIFIED The widget template grid columns are unspecified.
HALF_WIDTH The widget template grid columns are half width.
FULL_WIDTH The widget template grid columns are full width.
ONE_THIRD_WIDTH The widget template grid columns are one third width.
TWO_THIRD_WIDTH The widget template grid columns are two third width.

WidgetTemplateTypeEnum

WidgetTemplateTypeEnum represents the type of a widget template.

Enums
WIDGET_TEMPLATE_TYPE_UNSPECIFIED The widget template type is unspecified.
KEY_VALUE The widget template type is key value.
EVENTS The widget template type is events.
JSON_RESULTS The widget template type is json results.
HTML The widget template type is html.
WALL_ACTIVITIES The widget template type is wall activities.
ALERTS The widget template type is alerts.
TIMELINE The widget template type is timeline.
GRAPH The widget template type is graph.
TEXT The widget template type is text.
POTENTIALLY_GROUPED_ALERTS The widget template type is potentially grouped alerts.
ENTITIES_HIGHLIGHT The widget template type is entities highlight.
PENDING_STEPS The widget template type is pending steps.
CASE_RECOMMENDATIONS The widget template type is case recommendations.
STATISTICS The widget template type is statistics.
CASE_DESCRIPTION The widget template type is case description.
INSIGHT The widget template type is insight.
CASE_ASSISTANT The widget template type is case assistant.
CASE_APS_GRAPH The widget template type is case aps graph.
CASE_IMPACTED_RESOURCES The widget template type is case impacted resources.
FORM The widget template type is form.
QUICK_ACTIONS The widget template type is quick actions.
SIEM_ALERTS The widget template type is siem alerts.

LegacyPlaybookConditionsGroup

LegacyPlaybookConditionsGroup represents a group of conditions.

JSON representation
{
  "conditions": [
    {
      object (LegacyPlaybookCondition)
    }
  ],
  "logicalOperator": enum (ConditionLogicalOperator)
}
Fields
conditions[]

object (LegacyPlaybookCondition)

Optional. Conditions is a list of conditions.

logicalOperator

enum (ConditionLogicalOperator)

Required. LogicalOperator is the logical operator for the conditions.

LegacyPlaybookCondition

LegacyPlaybookCondition represents a single condition.

JSON representation
{
  "fieldName": string,
  "matchType": enum (ConditionMatchType),
  "value": string
}
Fields
fieldName

string

Required. FieldName is the name of the field to check.

matchType

enum (ConditionMatchType)

Required. MatchType is the operator to use for comparison.

value

string

Required. Value is the value to compare against.

ConditionMatchType

ConditionMatchType is the operator to use for comparison.

Enums
CONDITION_MATCH_TYPE_UNSPECIFIED The condition match type is unspecified.
EQUAL The condition match type is equal.
CONTAINS The condition match type is contains.
STARTS_WITH The condition match type is starts with.
GREATER_THAN The condition match type is greater than.
LESSER_THAN The condition match type is less than.
NOT_EQUAL The condition match type is not equal.
NOT_CONTAINS The condition match type is not contains.
IS_EMPTY The condition match type is is empty.
IS_NOT_EMPTY The condition match type is is not empty.

ConditionLogicalOperator

ConditionLogicalOperator represents the logical operator of a condition.

Enums
CONDITION_LOGICAL_OPERATOR_UNSPECIFIED The logical operator is unspecified.
AND The logical operator is and.
OR The logical operator is or.