RuntimeActionSchema

Schema of a runtime action.

JSON representation
{
  "action": string,
  "inputParameters": [
    {
      object (InputParameter)
    }
  ],
  "resultMetadata": [
    {
      object (ResultMetadata)
    }
  ],
  "inputJsonSchema": {
    object (JsonSchema)
  },
  "resultJsonSchema": {
    object (JsonSchema)
  },
  "displayName": string,
  "description": string
}
Fields
action

string

Output only. Name of the action.

inputParameters[]

object (InputParameter)

Output only. List of input parameter metadata for the action.

resultMetadata[]

object (ResultMetadata)

Output only. List of result field metadata.

inputJsonSchema

object (JsonSchema)

Output only. JsonSchema representation of this action's input metadata

resultJsonSchema

object (JsonSchema)

Output only. JsonSchema representation of this action's result metadata

displayName

string

Output only. Display Name of action to be shown on client side

description

string

Output only. Brief Description of action

InputParameter

Metadata of an input parameter.

JSON representation
{
  "parameter": string,
  "description": string,
  "dataType": enum (DataType),
  "nullable": boolean,
  "defaultValue": value,
  "jsonSchema": {
    object (JsonSchema)
  }
}
Fields
parameter

string

Name of the Parameter.

description

string

A brief description of the Parameter.

dataType

enum (DataType)

The data type of the Parameter.

nullable

boolean

Specifies whether a null value is allowed.

defaultValue

value (Value format)

The following field specifies the default value of the Parameter provided by the external system if a value is not provided.

jsonSchema

object (JsonSchema)

JsonSchema representation of this action's parameter

ResultMetadata

Metadata of result field.

JSON representation
{
  "field": string,
  "description": string,
  "dataType": enum (DataType),
  "jsonSchema": {
    object (JsonSchema)
  }
}
Fields
field

string

Name of the result field.

description

string

A brief description of the field.

dataType

enum (DataType)

The data type of the field.

jsonSchema

object (JsonSchema)

JsonSchema representation of this action's result