REST Resource: projects.locations.instances.integrations.logicalOperators

Resource: IntegrationLogicalOperator

This resource describes the logical operator's definition.

JSON representation
{
  "name": string,
  "displayName": string,
  "script": string,
  "author": string,
  "description": string,
  "version": number,
  "type": enum (LogicalOperatorType),
  "scriptTimeout": string,
  "parameters": [
    {
      object (IntegrationLogicalOperatorParameter)
    }
  ],
  "integration": string,
  "enabled": boolean,
  "custom": boolean
}
Fields
name

string

Identifier. The unique name(ID) of the logical operator. Format: projects/{project}/locations/{location}/instances/{instance}/integrations/{integration}/logicalOperators/{logicalOperator}

displayName

string

Required. Logical operator's display name, limited to a maximum of 150 characters

script

string

Required. Logical operator's script.

author

string

Output only. User that created the logical operator in the system.

description

string

Optional. Logical operator's description, limited to a maximum of 2050 characters.

version

number

Output only. The version of the logical operator

type

enum (LogicalOperatorType)

Output only. The type of the logical operator.

scriptTimeout

string (int64 format)

Required. Set the timeout in seconds of a single Python script run (default 60).

parameters[]

object (IntegrationLogicalOperatorParameter)

Optional. The logical operator's parameters definition.

integration

string

Output only. Parent integration identifier.

enabled

boolean

Required. Determines whether the logical operator is disabled or enabled.

custom

boolean

Output only. Determines if the logical operator is a custom logical operator.

LogicalOperatorType

Logical operator type

Enums
LOGICAL_OPERATOR_TYPE_UNSPECIFIED Unspecified type.
BUILT_IN Built-in logical operator.
CUSTOM Custom logical operator.

IntegrationLogicalOperatorParameter

Represents a parameter for a Logical Operator Definition.

JSON representation
{
  "id": string,
  "logicalOperatorDefinitionId": string,
  "mandatory": boolean,
  "defaultValue": string,
  "displayName": string,
  "order": integer,
  "description": string
}
Fields
id

string (int64 format)

Optional. The parameter's id. This is server-generated upon parameter creation. It must be provided when updating an existing parameter.

logicalOperatorDefinitionId

string (int64 format)

Output only. Logical operator's definition id.

mandatory

boolean

Required. Indicates whether this parameter is mandatory for configuring a logical operator instance.

defaultValue

string

Optional. The default value of the parameter. The defaultValue is required for booleans / mandatory parameters.

displayName

string

Required. The parameter's display name. Item name may contain letters (a-z), numbers (0-9), underscores (_). Max length of 150 characters.

order

integer

Optional. The parameter's order in the parameters list.

description

string

Optional. The parameter's description (max length of 2050 characters).

Methods

create

Creates a new custom IntegrationLogicalOperator.

delete

Deletes a specific custom IntegrationLogicalOperator.

executeTest

Executes a test run of a logical operator's evaluation script.

fetchTemplate

Returns a default Python script template for a logical operator.

get

Gets a single IntegrationLogicalOperator by its resource name.

list

Lists all IntegrationLogicalOperators defined for a specific integration.

patch

Updates an existing custom IntegrationLogicalOperator.