types
BatchSettings
maxCount : int64
Maximum batch size: trigger will send a batch if number of events exceeds this value.
maxBytes : int64
Maximum batch size: trigger will send a batch if total size of events exceeds this value.
cutoff : google.protobuf.Duration
Maximum batch size: trigger will send a batch if its lifetime exceeds this value.
Bus
Status
STATUS_UNSPECIFIEDCREATINGACTIVEDELETING
id : string
ID of the bus.
folderId : string
ID of the folder that the bus belongs to.
cloudId : string
ID of the cloud that the bus resides in.
createdAt : google.protobuf.Timestamp
Creation timestamp.
name : string
Name of the bus.
description : string
Description of the bus.
labels : string
Resource labels as key:value pairs.
deletionProtection : bool
Deletion protection.
status : Status
Status of the bus.
Connector
Status
Status of the connector.
STATUS_UNSPECIFIEDStatus of the connector.
RUNNINGStatus of the connector.
STOPPEDdisabled by user
RESOURCE_NOT_FOUNDsource does not exist
PERMISSION_DENIEDservice account does not have read permission on source
SUBJECT_NOT_FOUNDservice account not found
id : string
ID of the connector.
busId : string
ID of the bus that the connector belongs to.
folderId : string
ID of the folder that the connector resides in.
cloudId : string
ID of the cloud that the connector resides in.
createdAt : google.protobuf.Timestamp
Creation timestamp.
name : string
Name of the connector.
description : string
Description of the connector.
labels : string
Resource labels as key:value pairs.
source : Source
Source of the connector.
deletionProtection : bool
Deletion protection.
status : Status
Status of the connector.
ContainerTarget
containerId : string
Container ID.
containerRevisionId : string
Container revision ID.
path : string
Endpoint HTTP path to invoke.
serviceAccountId : string
Service account which should be used to call a container, optional.
batchSettings : BatchSettings
Batch settings.
DataStream
database : string
Stream database. example: /ru-central1/aoegtvhtp8ob****/cc8004q4lbo6****
streamName : string
Stream name, absolute or relative.
consumer : string
Consumer name.
serviceAccountId : string
Service account which has read permission on the stream.
Filter
One of condition
jqFilter: stringJQ filter for matching events.
FunctionTarget
functionId : string
Function ID.
functionTag : string
Function tag, optional.
serviceAccountId : string
Service account which has call permission on the function, optional.
batchSettings : BatchSettings
Batch settings.
GatewayWebsocketBroadcastTarget
gatewayId : string
Gateway ID.
path : string
Path.
serviceAccountId : string
Service account which has permission for writing to websockets.
batchSettings : BatchSettings
Batch settings.
LoggingTarget
One of destination
Log group ID or folder ID.
logGroupId: string
folderId: string
serviceAccountId : string
Service account which has permission for writing logs.
MessageQueue
queueArn : string
Queue ARN. Example: yrn:yc:ymq:ru-central1:aoe***:test
serviceAccountId : string
Service account which has read access to the queue.
visibilityTimeout : google.protobuf.Duration
Queue visibility timeout override.
batchSize : int64
Batch size for polling.
pollingTimeout : google.protobuf.Duration
Queue polling timeout.
PutQueueMessage
queueArn : string
ID of the queue.
serviceAccountId : string
Service account which has write permission on the queue.
RetrySettings
retryAttempts : int64
Maximum number of retries (extra calls) before an action fails.
maximumAge : google.protobuf.Duration
Event goes to dlq when its age exceeds this value. Default is 24h.
Rule
Status
STATUS_UNSPECIFIEDCREATINGRule creation in progress, rule is not enabled yet
ENABLEDRule is operating
UPDATINGRule update in progress, rule is disabled during update
DISABLEDRule is explicitly disabled by the user
id : string
ID of the rule.
busId : string
ID of the bus that the rule belongs to.
folderId : string
ID of the folder that the rule resides in.
cloudId : string
ID of the cloud that the rule resides in.
createdAt : google.protobuf.Timestamp
Creation timestamp.
name : string
Name of the rule.
description : string
Description of the rule.
labels : string
Resource labels as key:value pairs.
filter : Filter
Filter for the rule.
targets : Target
Targets of the rule.
deletionProtection : bool
Flag that disallow deletion of the rule.
status : Status
Rule status
Source
One of source
dataStream: DataStream
messageQueue: MessageQueue
Target
Status
Status of the target.
STATUS_UNSPECIFIEDStatus of the target.
ENABLEDTarget is enabled.
DISABLEDTarget is disabled.
RESOURCE_NOT_FOUNDTarget does not exist.
PERMISSION_DENIEDService account does not have read permission on source.
SUBJECT_NOT_FOUNDService account not found.
One of target
yds: YdsTarget
ymq: YmqTarget
function: FunctionTarget
container: ContainerTarget
gatewayWsBroadcast: GatewayWebsocketBroadcastTarget
logging: LoggingTarget
workflow: WorkflowTarget
transformer : Transformer
Transformer of the target.
retrySettings : RetrySettings
Retry settings of the target.
One of deadLetter
Dead letter settings of the target.
deadLetterQueue: PutQueueMessageDead letter queue.
status : Status
Status of the target.
Transformer
One of transformer
jqTransformer: stringJQ string inrerpolation expression for changing event format.
WorkflowTarget
workflowId : string
Workflow ID.
serviceAccountId : string
SA which should be used to start workflow.
batchSettings : BatchSettings
Batch settings.
YdsTarget
database : string
Stream database.
streamName : string
Full stream name, like /ru-central1/aoegtvhtp8ob****/cc8004q4lbo6****/test.
serviceAccountId : string
Service account, which has write permission on the stream.
YmqTarget
queueArn : string
Queue ARN. Example: yrn:yc:ymq:ru-central1:aoe***:test
serviceAccountId : string
Service account which has write access to the queue.